OSSO_ABOOK_CONTACT_FIELD_GROUP_STEP

#define OSSO_ABOOK_CONTACT_FIELD_GROUP_STEP 100

OssoABookContactFieldPredicate ()

gboolean            (*OssoABookContactFieldPredicate)   (OssoABookContactField *field,
                                                         gpointer user_data);

The signature of a function that can be used to select or reject fields in osso_abook_contact_field_list_supported_fields()

enum OssoABookContactFieldFlags

typedef enum {
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_NONE        = (0),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_HOME        = (1 << 0),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_WORK        = (1 << 1),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_CELL        = (1 << 2),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_VOICE       = (1 << 3),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_OTHER       = (1 << 4),

        OSSO_ABOOK_CONTACT_FIELD_FLAGS_DEVICE_MASK = (OSSO_ABOOK_CONTACT_FIELD_FLAGS_CELL | OSSO_ABOOK_CONTACT_FIELD_FLAGS_VOICE),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_USAGE_MASK  = (OSSO_ABOOK_CONTACT_FIELD_FLAGS_HOME | OSSO_ABOOK_CONTACT_FIELD_FLAGS_WORK),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_TYPE_MASK   = (OSSO_ABOOK_CONTACT_FIELD_FLAGS_DEVICE_MASK | OSSO_ABOOK_CONTACT_FIELD_FLAGS_USAGE_MASK | OSSO_ABOOK_CONTACT_FIELD_FLAGS_OTHER),

        OSSO_ABOOK_CONTACT_FIELD_FLAGS_SINGLETON   = (1 << 10),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_MANDATORY   = (1 << 11),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_DYNAMIC     = (1 << 12),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_NO_LABEL    = (1 << 13),
        OSSO_ABOOK_CONTACT_FIELD_FLAGS_DETAILED    = (1 << 14),
} OssoABookContactFieldFlags;

A set of flags that describe various properties about a OssoABookContactField

OssoABookContactField

typedef struct _OssoABookContactField OssoABookContactField;

osso_abook_contact_field_new_full ()

OssoABookContactField* osso_abook_contact_field_new_full
                                                        (GHashTable *message_map,
                                                         OssoABookContact *master_contact,
                                                         OssoABookContact *roster_contact,
                                                         EVCardAttribute *attribute);

Creates a new OssoABookContactField to represent the specified attribute

osso_abook_contact_field_new ()

OssoABookContactField* osso_abook_contact_field_new     (GHashTable *message_map,
                                                         OssoABookContact *master_contact,
                                                         EVCardAttribute *attribute);

Creates a new OssoABookContactField to represent the specified attribute. This constructor can be used if the field is not relevant to a particular roster contact.

osso_abook_contact_field_get_message_map ()

GHashTable*         osso_abook_contact_field_get_message_map
                                                        (OssoABookContactField *field);

Retrieve the message map for field

osso_abook_contact_field_set_message_map ()

void                osso_abook_contact_field_set_message_map
                                                        (OssoABookContactField *field,
                                                         GHashTable *mapping);

Set the message map for a OssoABookContactField

osso_abook_contact_field_get_name ()

const char*         osso_abook_contact_field_get_name   (OssoABookContactField *field);

Get the name of the attribute represented by field

osso_abook_contact_field_get_path ()

const char*         osso_abook_contact_field_get_path   (OssoABookContactField *field);

Gets the heirarchical path for field. The format of the path string is something like: parentfieldname.thisfieldname

osso_abook_contact_field_get_flags ()

OssoABookContactFieldFlags osso_abook_contact_field_get_flags
                                                        (OssoABookContactField *field);

Gets the flags associated with field

osso_abook_contact_field_get_parent ()

OssoABookContactField* osso_abook_contact_field_get_parent
                                                        (OssoABookContactField *field);

Gets the parent field for field

osso_abook_contact_field_get_children ()

GList*              osso_abook_contact_field_get_children
                                                        (OssoABookContactField *field);

Gets the list of children for field

osso_abook_contact_field_has_children ()

gboolean            osso_abook_contact_field_has_children
                                                        (OssoABookContactField *field);

Checks whether field has any child fields

osso_abook_contact_field_get_attribute ()

EVCardAttribute*    osso_abook_contact_field_get_attribute
                                                        (OssoABookContactField *field);

Gets the EVCardAttribute that is backing this field.

osso_abook_contact_field_get_borrowed_attribute ()

EVCardAttribute*    osso_abook_contact_field_get_borrowed_attribute
                                                        (OssoABookContactField *field);

Generally an OssoABookContactField will operate on a copy of the backing EVCardAttribute, but this function will return the real backing EVCardAttribute.

osso_abook_contact_field_get_secondary_attributes ()

GList*              osso_abook_contact_field_get_secondary_attributes
                                                        (OssoABookContactField *field);

Gets a list of all secondary attributes for field. A secondary attribute is an attribute that is automatically generated from the original attribute. For instance, the vcard attribute FN is automatically generated from the vcard attribute N

osso_abook_contact_field_get_display_title ()

const char*         osso_abook_contact_field_get_display_title
                                                        (OssoABookContactField *field);

Gets a string to be used as a display title for field

osso_abook_contact_field_get_secondary_title ()

const char*         osso_abook_contact_field_get_secondary_title
                                                        (OssoABookContactField *field);

For fields with a OSSO_ABOOK_CONTACT_FIELD_FLAGS_DETAILED flag, gets the secondary title.

osso_abook_contact_field_get_display_value ()

const char*         osso_abook_contact_field_get_display_value
                                                        (OssoABookContactField *field);

Gets the value of field as a displayable string

osso_abook_contact_field_get_icon_name ()

const char*         osso_abook_contact_field_get_icon_name
                                                        (OssoABookContactField *field);

Gets the icon name for field

osso_abook_contact_field_get_sort_weight ()

int                 osso_abook_contact_field_get_sort_weight
                                                        (OssoABookContactField *field);

Gets the sort weight for field. The sort weight determines the display order of attributes in the contact starter and contact editor. Higher values are sorted first.

osso_abook_contact_field_get_master_contact ()

OssoABookContact*   osso_abook_contact_field_get_master_contact
                                                        (OssoABookContactField *field);

Gets the master contact associated with field.

osso_abook_contact_field_get_roster_contact ()

OssoABookContact*   osso_abook_contact_field_get_roster_contact
                                                        (OssoABookContactField *field);

Gets the roster contact associated with field.

osso_abook_contact_field_get_account ()

McAccount*          osso_abook_contact_field_get_account
                                                        (OssoABookContactField *field);

Gets the account associated with field, if any.

osso_abook_contact_field_get_actions_full ()

GList*              osso_abook_contact_field_get_actions_full
                                                        (OssoABookContactField *field,
                                                         gboolean button);

Gets the list of actions associated with field based on the interactivity mode of field. If button is TRUE, returns the list of actions when field is interactive. if button is FALSE, returns the list of actions when field is non-interactive

osso_abook_contact_field_get_actions ()

GList*              osso_abook_contact_field_get_actions
                                                        (OssoABookContactField *field);

Gets a list of actions that can be performed for this field. Actions can be activated with osso_abook_contact_field_action_start() or osso_abook_contact_field_action_start_with_callback().

osso_abook_contact_field_action_request_account ()

McAccount*          osso_abook_contact_field_action_request_account
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent,
                                                         gboolean *aborted);

Get an account to associate with the specified action. If more than one account matches, presents a dialog to the user prompting them to choose between the available options.

osso_abook_contact_field_action_start ()

gboolean            osso_abook_contact_field_action_start
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent);

Activates the specified action

osso_abook_contact_field_action_start_with_callback ()

gboolean            osso_abook_contact_field_action_start_with_callback
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent,
                                                         OssoABookContactActionStartCb callback,
                                                         gpointer callback_data);

Activates the specified action and calls callback when complete.

osso_abook_contact_field_action_ref ()

OssoABookContactFieldAction* osso_abook_contact_field_action_ref
                                                        (OssoABookContactFieldAction *action);

Takes a reference on action

osso_abook_contact_field_action_unref ()

void                osso_abook_contact_field_action_unref
                                                        (OssoABookContactFieldAction *action);

Releases a reference on action. if the reference count reaches 0, action will be freed

osso_abook_contact_field_action_get_action ()

OssoABookContactAction osso_abook_contact_field_action_get_action
                                                        (OssoABookContactFieldAction *action);

Gets the action type for the specified action

osso_abook_contact_field_action_get_field ()

OssoABookContactField* osso_abook_contact_field_action_get_field
                                                        (OssoABookContactFieldAction *action);

Gets the OssoABookContactField associated with action

osso_abook_contact_field_action_get_widget ()

GtkWidget*          osso_abook_contact_field_action_get_widget
                                                        (OssoABookContactFieldAction *action);

Gets the GtkWidget associated with action

osso_abook_contact_field_action_get_profile ()

McProfile*          osso_abook_contact_field_action_get_profile
                                                        (OssoABookContactFieldAction *action);

Gets the McProfile associated with action

osso_abook_contact_field_action_is_basic ()

gboolean            osso_abook_contact_field_action_is_basic
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_create_button ()

GtkWidget*          osso_abook_contact_field_create_button
                                                        (OssoABookContactField *field,
                                                         const char *title,
                                                         const char *icon_name);

Creates an action button for field.

osso_abook_contact_field_get_label_widget ()

GtkWidget*          osso_abook_contact_field_get_label_widget
                                                        (OssoABookContactField *field);

Gets a widget to be used as a label for the specified field. This widget is not necessarily a GtkLabel. For example, the label widget for a phone number field may be a button that allows you to choose different types of phone types (e.g. home / work / mobile).

osso_abook_contact_field_get_editor_widget ()

GtkWidget*          osso_abook_contact_field_get_editor_widget
                                                        (OssoABookContactField *field);

osso_abook_contact_field_has_editor_widget ()

gboolean            osso_abook_contact_field_has_editor_widget
                                                        (OssoABookContactField *field);

osso_abook_contact_field_is_readonly ()

gboolean            osso_abook_contact_field_is_readonly
                                                        (OssoABookContactField *field);

Checks whether field is read-only or writable

osso_abook_contact_field_is_bound_im ()

gboolean            osso_abook_contact_field_is_bound_im
                                                        (OssoABookContactField *field);

This function returns whether the field refers to a bound IM username. In other words, it returns TRUE if the contact is stored on the roster on the server, FALSE if not (and thus the field is editable in the contact editor). The term 'bound username' also implies that it has been normalized by the server.

osso_abook_contact_field_is_modified ()

gboolean            osso_abook_contact_field_is_modified
                                                        (OssoABookContactField *field);

osso_abook_contact_field_is_empty ()

gboolean            osso_abook_contact_field_is_empty   (OssoABookContactField *field);

osso_abook_contact_field_is_mandatory ()

gboolean            osso_abook_contact_field_is_mandatory
                                                        (OssoABookContactField *field);

Checks whether field is required to exist for each contact. If a field is mandatory, it cannot be removed and must be present in order to save a contact.

osso_abook_contact_field_set_mandatory ()

void                osso_abook_contact_field_set_mandatory
                                                        (OssoABookContactField *field,
                                                         gboolean mandatory);

Marks field as a mandatory field. See osso_abook_contact_field_is_mandatory() for more information about what this means.

osso_abook_contact_field_activate ()

gboolean            osso_abook_contact_field_activate   (OssoABookContactField *field);

Activates the editor widget for field, if any. Generally this will display a picker dialog so that the user can choose a new value for the field.

osso_abook_contact_field_cmp ()

int                 osso_abook_contact_field_cmp        (OssoABookContactField *a,
                                                         OssoABookContactField *b);

Compares a and b according to sort order, grouping children together with their parents.

osso_abook_contact_field_list_supported_fields ()

GList*              osso_abook_contact_field_list_supported_fields
                                                        (GHashTable *message_map,
                                                         OssoABookContact *master_contact,
                                                         OssoABookContactFieldPredicateaccept_field ,
                                                         gpointer user_data);

Iterates through all possible fields and calls accept_field on them. If accept_field returns TRUE, the field will be added to the list of supported fields.

The "attribute" property

  "attribute"                gpointer              : Read / Write / Construct Only

The VCard attribute backing this field.

The "display-title" property

  "display-title"            gchar*                : Read

The message ID field labels.

Default value: NULL

The "display-value" property

  "display-value"            gchar*                : Read

A human friendly string represeting the attribute value.

Default value: NULL

The "editor-widget" property

  "editor-widget"            GtkWidget*            : Read

The widget for editing this field.

The "flags" property

  "flags"                    OssoABookContactFieldFlags  : Read / Write

Flags describing this field.

The "icon-name" property

  "icon-name"                gchar*                : Read

The name of the icon to use with this field.

Default value: NULL

The "label-widget" property

  "label-widget"             GtkWidget*            : Read

The widget describing this field.

The "master-contact" property

  "master-contact"           OssoABookContact*     : Read / Write / Construct Only

The master contact if one is associated with this field.

The "message-map" property

  "message-map"              GHashTable*           : Read / Write

Mapping for generic message ids to context ids.

The "modified" property

  "modified"                 gboolean              : Read

Check if the field has been modified.

Default value: FALSE

The "name" property

  "name"                     gchar*                : Read

The name of this field.

Default value: NULL

The "roster-contact" property

  "roster-contact"           OssoABookContact*     : Read / Write / Construct Only

The roster contact if one is associated with this field.

The "sort-weight" property

  "sort-weight"              gint                  : Read

The weight of this field when sorting them.

Default value: -2147483648