Osso Addressbook Reference Manual | ||||
---|---|---|---|---|
OssoABookContactViewOssoABookContactView — Widget exposing the contents of an OssoABookContactModel in a list. |
OssoABookContactView; GtkWidget* osso_abook_contact_view_new (HildonUIMode mode, OssoABookContactModel *model, OssoABookFilterModel *filter_model); GtkWidget* osso_abook_contact_view_new_basic (HildonUIMode mode, OssoABookContactModel *model); GList* osso_abook_contact_view_get_selection (OssoABookContactView *view); OssoABookContact* osso_abook_contact_view_get_focus (OssoABookContactView *view); OssoABookAvatar* osso_abook_contact_view_get_focus_avatar (OssoABookContactView *view); OssoABookPresence* osso_abook_contact_view_get_focus_presence (OssoABookContactView *view); OssoABookCaps* osso_abook_contact_view_get_focus_caps (OssoABookContactView *view); unsigned int osso_abook_contact_view_get_minimum_selection (OssoABookContactView *view); unsigned int osso_abook_contact_view_get_maximum_selection (OssoABookContactView *view); void osso_abook_contact_view_set_minimum_selection (OssoABookContactView *view, unsigned int limit); void osso_abook_contact_view_set_maximum_selection (OssoABookContactView *view, unsigned int limit);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBox +----GtkVBox +----OssoABookTreeView +----OssoABookContactView
OssoABookContactView is a widget that displays the contents of an OssoABookContactModel as a list.
typedef struct _OssoABookContactView OssoABookContactView;
All the fields of this structure are private to the object's implementation and should never be accessed directly.
GtkWidget* osso_abook_contact_view_new (HildonUIMode mode, OssoABookContactModel *model, OssoABookFilterModel *filter_model);
Creates a new OssoABookContactView object exposing the contents of model
,
as filtered by filter_model
(if non-NULL).
mode : |
The Hildon UI mode according to which to behave |
base_model : |
An OssoABookContactModel whose contents are to be exposed |
filter_model : |
An OssoABookFilterModel filtering model , or NULL
|
Returns : | A new OssoABookContactView object. |
GtkWidget* osso_abook_contact_view_new_basic (HildonUIMode mode, OssoABookContactModel *model);
Creates a new OssoABookContactView object exposing the contents of model
,
as filtered through "" all non-blocked contacts.
mode : |
The Hildon UI mode according to which to behave |
model : |
An OssoABookContactModel whose contents are to be exposed |
Returns : | A new OssoABookContactView object. |
GList* osso_abook_contact_view_get_selection (OssoABookContactView *view);
Retrieves the set of selected rows as a GList of EContact objects.
The returned GList should be freed manually, but don't g_object_unref()
the elements.
view : |
An OssoABookContactView |
Returns : | A newly allocated GList of EContact objects. |
OssoABookContact* osso_abook_contact_view_get_focus (OssoABookContactView *view);
osso_abook_contact_view_get_focus
is deprecated and should not be used in newly-written code. There is no keyboard focus in Maemo 5.
Retrieves the EContact whose row is focused, if any.
view : |
An OssoABookContactView |
Returns : | The EContact whose row is focused, or NULL. The contact is
owned by libosso-abook and should not be g_object_unref() 'ed.
|
OssoABookAvatar* osso_abook_contact_view_get_focus_avatar (OssoABookContactView *view);
osso_abook_contact_view_get_focus_avatar
is deprecated and should not be used in newly-written code. There is no keyboard focus in Maemo 5.
Retrieves the OssoABookAvatar whose row is focused, if any.
view : |
An OssoABookContactView |
Returns : | The OssoABookAvatar whose row is focused, or NULL. The
avatar is owned by libosso-abook and should not be g_object_unref() 'ed.
|
OssoABookPresence* osso_abook_contact_view_get_focus_presence (OssoABookContactView *view);
osso_abook_contact_view_get_focus_presence
is deprecated and should not be used in newly-written code. There is no keyboard focus in Maemo 5.
Retrieves the OssoABookPresence whose row is focused, if any.
view : |
An OssoABookContactView |
Returns : | The OssoABookPresence whose row is focused, or NULL. The
presence is owned by libosso-abook and should not be g_object_unref() 'ed.
|
OssoABookCaps* osso_abook_contact_view_get_focus_caps (OssoABookContactView *view);
osso_abook_contact_view_get_focus_caps
is deprecated and should not be used in newly-written code. There is no keyboard focus in Maemo 5.
Retrieves the OssoABookCaps whose row is focused, if any.
view : |
An OssoABookContactView |
Returns : | The OssoABookCaps whose row is focused, or NULL. The
caps are owned by libosso-abook and should not be g_object_unref() 'ed.
|
unsigned int osso_abook_contact_view_get_minimum_selection (OssoABookContactView *view);
Returns the minimum number of contacts which must be selected by the user. This can be used by dervied widgets to drive actions.
view : |
An OssoABookContactView widget |
Returns : | The minimum number of contacts which must be selected |
unsigned int osso_abook_contact_view_get_maximum_selection (OssoABookContactView *view);
Returns the maximum number of contacts which must be selected by the user. This can be used by dervied widgets to drive actions.
view : |
An OssoABookContactView widget |
Returns : | The maximum number of contacts which must be selected |
void osso_abook_contact_view_set_minimum_selection (OssoABookContactView *view, unsigned int limit);
This function sets the minimum number of contacts which must be selected by the user. This can be used by dervied widgets to drive actions.
view : |
An OssoABookContactView widget |
limit : |
The minimum number of contacts which must be selected |
void osso_abook_contact_view_set_maximum_selection (OssoABookContactView *view, unsigned int limit);
This function sets the maximum number of contacts which must be selected by the user. This can be used by dervied widgets to drive actions.
view : |
An OssoABookContactView widget |
limit : |
The maximum number of contacts which must be selected |
"maximum-selection"
property"maximum-selection" guint : Read / Write
The maximum number of rows to be selected.
Allowed values: >= 1
Default value: 1
"contact-activated"
signalvoid user_function (OssoABookContactView *view, OssoABookContact *master_contact, gpointer user_data) : Run Last
This signal is emitted when a contact in the view is activated. Note that this will always be a master contact.
view : |
an OssoABookContactView |
master_contact : |
the OssoABookContact activated |
user_data : |
user data set when the signal handler was connected. |
"selection-changed"
signalvoid user_function (OssoABookContactView *view, guint count_selected, gpointer user_data) : Run Last
This signal is emitted when the row selection changes.
view : |
an OssoABookContactView |
count_selected : |
the number of rows now selected |
user_data : |
user data set when the signal handler was connected. |