OssoABookContactField

OssoABookContactField — Rich representation of supported contact fields.

Synopsis

#define             OSSO_ABOOK_CONTACT_FIELD_GROUP_STEP
gboolean            (*OssoABookContactFieldPredicate)   (OssoABookContactField *field,
                                                         gpointer user_data);
enum                OssoABookContactFieldFlags;
                    OssoABookContactField;
OssoABookContactField* osso_abook_contact_field_new_full
                                                        (GHashTable *message_map,
                                                         OssoABookContact *master_contact,
                                                         OssoABookContact *roster_contact,
                                                         EVCardAttribute *attribute);
OssoABookContactField* osso_abook_contact_field_new     (GHashTable *message_map,
                                                         OssoABookContact *master_contact,
                                                         EVCardAttribute *attribute);
GHashTable*         osso_abook_contact_field_get_message_map
                                                        (OssoABookContactField *field);
void                osso_abook_contact_field_set_message_map
                                                        (OssoABookContactField *field,
                                                         GHashTable *mapping);
const char*         osso_abook_contact_field_get_name   (OssoABookContactField *field);
const char*         osso_abook_contact_field_get_path   (OssoABookContactField *field);
OssoABookContactFieldFlags osso_abook_contact_field_get_flags
                                                        (OssoABookContactField *field);
OssoABookContactField* osso_abook_contact_field_get_parent
                                                        (OssoABookContactField *field);
GList*              osso_abook_contact_field_get_children
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_has_children
                                                        (OssoABookContactField *field);
EVCardAttribute*    osso_abook_contact_field_get_attribute
                                                        (OssoABookContactField *field);
EVCardAttribute*    osso_abook_contact_field_get_borrowed_attribute
                                                        (OssoABookContactField *field);
GList*              osso_abook_contact_field_get_secondary_attributes
                                                        (OssoABookContactField *field);
const char*         osso_abook_contact_field_get_display_title
                                                        (OssoABookContactField *field);
const char*         osso_abook_contact_field_get_secondary_title
                                                        (OssoABookContactField *field);
const char*         osso_abook_contact_field_get_display_value
                                                        (OssoABookContactField *field);
const char*         osso_abook_contact_field_get_icon_name
                                                        (OssoABookContactField *field);
int                 osso_abook_contact_field_get_sort_weight
                                                        (OssoABookContactField *field);
OssoABookContact*   osso_abook_contact_field_get_master_contact
                                                        (OssoABookContactField *field);
OssoABookContact*   osso_abook_contact_field_get_roster_contact
                                                        (OssoABookContactField *field);
McAccount*          osso_abook_contact_field_get_account
                                                        (OssoABookContactField *field);
GList*              osso_abook_contact_field_get_actions_full
                                                        (OssoABookContactField *field,
                                                         gboolean button);
GList*              osso_abook_contact_field_get_actions
                                                        (OssoABookContactField *field);
McAccount*          osso_abook_contact_field_action_request_account
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent,
                                                         gboolean *aborted);
gboolean            osso_abook_contact_field_action_start
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent);
gboolean            osso_abook_contact_field_action_start_with_callback
                                                        (OssoABookContactFieldAction *action,
                                                         GtkWindow *parent,
                                                         OssoABookContactActionStartCb callback,
                                                         gpointer callback_data);
OssoABookContactFieldAction* osso_abook_contact_field_action_ref
                                                        (OssoABookContactFieldAction *action);
void                osso_abook_contact_field_action_unref
                                                        (OssoABookContactFieldAction *action);
OssoABookContactAction osso_abook_contact_field_action_get_action
                                                        (OssoABookContactFieldAction *action);
OssoABookContactField* osso_abook_contact_field_action_get_field
                                                        (OssoABookContactFieldAction *action);
GtkWidget*          osso_abook_contact_field_action_get_widget
                                                        (OssoABookContactFieldAction *action);
McProfile*          osso_abook_contact_field_action_get_profile
                                                        (OssoABookContactFieldAction *action);
GtkWidget*          osso_abook_contact_field_create_button
                                                        (OssoABookContactField *field,
                                                         const char *title,
                                                         const char *icon_name);
GtkWidget*          osso_abook_contact_field_get_label_widget
                                                        (OssoABookContactField *field);
GtkWidget*          osso_abook_contact_field_get_editor_widget
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_has_editor_widget
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_is_readonly
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_is_bound_im
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_is_modified
                                                        (OssoABookContactField *field);
gboolean            osso_abook_contact_field_is_empty   (OssoABookContactField *field);
gboolean            osso_abook_contact_field_is_mandatory
                                                        (OssoABookContactField *field);
void                osso_abook_contact_field_set_mandatory
                                                        (OssoABookContactField *field,
                                                         gboolean mandatory);
gboolean            osso_abook_contact_field_activate   (OssoABookContactField *field);
int                 osso_abook_contact_field_cmp        (OssoABookContactField *a,
                                                         OssoABookContactField *b);

Object Hierarchy

  GObject
   +----OssoABookContactField

Properties

  "attribute"                gpointer              : Read / Write / Construct Only
  "display-title"            gchar*                : Read
  "display-value"            gchar*                : Read
  "editor-widget"            GtkWidget*            : Read
  "flags"                    OssoABookContactFieldFlags  : Read / Write
  "icon-name"                gchar*                : Read
  "label-widget"             GtkWidget*            : Read
  "master-contact"           OssoABookContact*     : Read / Write / Construct Only
  "message-map"              GHashTable*           : Read / Write
  "modified"                 gboolean              : Read
  "name"                     gchar*                : Read
  "roster-contact"           OssoABookContact*     : Read / Write / Construct Only
  "sort-weight"              gint                  : Read

Description

OssoABookContactField provides information how to represent and modify contact fields.

Details

OSSO_ABOOK_CONTACT_FIELD_GROUP_STEP

#define OSSO_ABOOK_CONTACT_FIELD_GROUP_STEP 100

OssoABookContactFieldPredicate ()

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

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;

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);

osso_abook_contact_field_new ()

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

osso_abook_contact_field_get_message_map ()

GHashTable*         osso_abook_contact_field_get_message_map
                                                        (OssoABookContactField *field);

osso_abook_contact_field_set_message_map ()

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

osso_abook_contact_field_get_name ()

const char*         osso_abook_contact_field_get_name   (OssoABookContactField *field);

osso_abook_contact_field_get_path ()

const char*         osso_abook_contact_field_get_path   (OssoABookContactField *field);

osso_abook_contact_field_get_flags ()

OssoABookContactFieldFlags osso_abook_contact_field_get_flags
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_parent ()

OssoABookContactField* osso_abook_contact_field_get_parent
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_children ()

GList*              osso_abook_contact_field_get_children
                                                        (OssoABookContactField *field);

osso_abook_contact_field_has_children ()

gboolean            osso_abook_contact_field_has_children
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_attribute ()

EVCardAttribute*    osso_abook_contact_field_get_attribute
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_borrowed_attribute ()

EVCardAttribute*    osso_abook_contact_field_get_borrowed_attribute
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_secondary_attributes ()

GList*              osso_abook_contact_field_get_secondary_attributes
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_display_title ()

const char*         osso_abook_contact_field_get_display_title
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_secondary_title ()

const char*         osso_abook_contact_field_get_secondary_title
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_display_value ()

const char*         osso_abook_contact_field_get_display_value
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_icon_name ()

const char*         osso_abook_contact_field_get_icon_name
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_sort_weight ()

int                 osso_abook_contact_field_get_sort_weight
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_master_contact ()

OssoABookContact*   osso_abook_contact_field_get_master_contact
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_roster_contact ()

OssoABookContact*   osso_abook_contact_field_get_roster_contact
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_account ()

McAccount*          osso_abook_contact_field_get_account
                                                        (OssoABookContactField *field);

osso_abook_contact_field_get_actions_full ()

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

osso_abook_contact_field_get_actions ()

GList*              osso_abook_contact_field_get_actions
                                                        (OssoABookContactField *field);

osso_abook_contact_field_action_request_account ()

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

osso_abook_contact_field_action_start ()

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

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);

osso_abook_contact_field_action_ref ()

OssoABookContactFieldAction* osso_abook_contact_field_action_ref
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_action_unref ()

void                osso_abook_contact_field_action_unref
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_action_get_action ()

OssoABookContactAction osso_abook_contact_field_action_get_action
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_action_get_field ()

OssoABookContactField* osso_abook_contact_field_action_get_field
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_action_get_widget ()

GtkWidget*          osso_abook_contact_field_action_get_widget
                                                        (OssoABookContactFieldAction *action);

osso_abook_contact_field_action_get_profile ()

McProfile*          osso_abook_contact_field_action_get_profile
                                                        (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 this contact field.

field : the OssoABookContactField
title : title for this button, or NULL to use default title
icon_name : icon name for this button, or NULL to use default icon
Returns : A new action button for this contact field.

osso_abook_contact_field_get_label_widget ()

GtkWidget*          osso_abook_contact_field_get_label_widget
                                                        (OssoABookContactField *field);

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);

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, i.e. if 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).

filed : An OssoABookContactField
Returns : TRUE if the contact is bound, FALSE otherwise.

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);

osso_abook_contact_field_set_mandatory ()

void                osso_abook_contact_field_set_mandatory
                                                        (OssoABookContactField *field,
                                                         gboolean mandatory);

osso_abook_contact_field_activate ()

gboolean            osso_abook_contact_field_activate   (OssoABookContactField *field);

osso_abook_contact_field_cmp ()

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

Property Details

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