OssoABookTouchContactStarter

OssoABookTouchContactStarter — Core widget to initiate communication with a contact or view their basic information.

Synopsis

                    OssoABookTouchContactStarter;
GtkWidget*          osso_abook_touch_contact_starter_new_with_contact
                                                        (GtkWindow *parent,
                                                         OssoABookContact *contact);
GtkWidget*          osso_abook_touch_contact_starter_new_with_editor
                                                        (GtkWindow *parent,
                                                         OssoABookContact *contact);
GtkWidget*          osso_abook_touch_contact_starter_new_with_store
                                                        (OssoABookContactDetailStore *store,
                                                         const OssoABookContactAction *allowed_actions,
                                                         guint n_actions);
OssoABookContact*   osso_abook_touch_contact_starter_get_contact
                                                        (OssoABookTouchContactStarter *starter);
gboolean            osso_abook_touch_contact_starter_get_editable
                                                        (OssoABookTouchContactStarter *starter);
GtkWidget*          osso_abook_touch_contact_starter_dialog_new
                                                        (GtkWindow *parent,
                                                         OssoABookTouchContactStarter *starter);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----OssoABookTouchContactStarter

Implemented Interfaces

OssoABookTouchContactStarter implements GtkBuildable and AtkImplementorIface.

Properties

  "allowed-actions"          guint                 : Read / Write / Construct Only
  "contact"                  OssoABookContact*     : Read / Write / Construct Only
  "editable"                 gboolean              : Read / Write / Construct Only
  "left-part"                gboolean              : Read / Write / Construct Only
  "store"                    OssoABookContactDetailStore*  : Read / Write / Construct Only

Signals

  "action-started"                                 : Run Last
  "editor-started"                                 : Run Last
  "pre-action-start"                               : Run Last

Description

The OssoABookTouchContactStarter is a widget that allows the user to start chat, VoIP sessions, phone calls, emails, or SMSes to a contact. If this widget is added directly inside a GtkWindow (eg, HildonStackableWindow), it will also set the window's title appropriately based on the current contact.

This widget is derived from GtkBin.

Details

OssoABookTouchContactStarter

typedef struct _OssoABookTouchContactStarter OssoABookTouchContactStarter;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

osso_abook_touch_contact_starter_new_with_contact ()

GtkWidget*          osso_abook_touch_contact_starter_new_with_contact
                                                        (GtkWindow *parent,
                                                         OssoABookContact *contact);

Creates a new OssoABookTouchContactStarter object and initializes some of its properties. The contact will be editable.

parent : the parent window, or NULL
contact : the contact, or NULL
Returns : A new OssoABookTouchContactStarter object.

osso_abook_touch_contact_starter_new_with_editor ()

GtkWidget*          osso_abook_touch_contact_starter_new_with_editor
                                                        (GtkWindow *parent,
                                                         OssoABookContact *contact);

osso_abook_touch_contact_starter_new_with_store ()

GtkWidget*          osso_abook_touch_contact_starter_new_with_store
                                                        (OssoABookContactDetailStore *store,
                                                         const OssoABookContactAction *allowed_actions,
                                                         guint n_actions);

Creates a new OssoABookTouchContactStarter object and initializes some of its properties.

store : the OssoABookContactDetailStore to use
actions : array of OssoABookContactAction allowed
n_actions : size of the actions array
Returns : A new OssoABookTouchContactStarter object.

osso_abook_touch_contact_starter_get_contact ()

OssoABookContact*   osso_abook_touch_contact_starter_get_contact
                                                        (OssoABookTouchContactStarter *starter);

Get the OssoABookContact this contact starter is acting on.

starter : An OssoABookTouchContactStarter
Returns : the OssoABookContact

osso_abook_touch_contact_starter_get_editable ()

gboolean            osso_abook_touch_contact_starter_get_editable
                                                        (OssoABookTouchContactStarter *starter);

osso_abook_touch_contact_starter_dialog_new ()

GtkWidget*          osso_abook_touch_contact_starter_dialog_new
                                                        (GtkWindow *parent,
                                                         OssoABookTouchContactStarter *starter);

Creates a new dialog containing the given OssoABookTouchContactStarter widget. The dialog will automatically be destroyed once the action is started successfully.

parent : the parent, or NULL
starter : the OssoABookTouchContactStarter widget
Returns : A new GtkDialog widget.

Property Details

The "allowed-actions" property

  "allowed-actions"          guint                 : Read / Write / Construct Only

The allowed actions flags.

Default value: 4294967295

The "contact" property

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

The displayed OssoABookContact.

The "editable" property

  "editable"                 gboolean              : Read / Write / Construct Only

Whether the contact is editable.

Default value: FALSE

The "left-part" property

  "left-part"                gboolean              : Read / Write / Construct Only

Whether the left part should be shown.

Default value: TRUE

The "store" property

  "store"                    OssoABookContactDetailStore*  : Read / Write / Construct Only

The OssoABookContactDetailStore to use.

Signal Details

The "action-started" signal

void                user_function                      (OssoABookTouchContactStarter *starter,
                                                        gpointer                      user_data)      : Run Last

This signal is emitted when an action on the contact starter is initiated by the user.

starter : a OssoABookTouchContactStarter
user_data : user data set when the signal handler was connected.

The "editor-started" signal

void                user_function                      (OssoABookTouchContactStarter *starter,
                                                        OssoABookContactEditor       *arg1,
                                                        gpointer                      user_data)      : Run Last

This signal is emitted when the editor is started for the contact starter.

starter : a OssoABookTouchContactStarter
user_data : user data set when the signal handler was connected.

The "pre-action-start" signal

gboolean            user_function                      (OssoABookTouchContactStarter *starter,
                                                        gpointer                      action,
                                                        gpointer                      user_data)      : Run Last

This signal is emitted before an action on the contact starter is initiated. If TRUE is returned, the signal emition is stopped and the action won't be started. The first callback to return TRUE is responsible to handle the action itself.

starter : a OssoABookTouchContactStarter
action : a OssoABookContactFieldAction
user_data : user data set when the signal handler was connected.
Generated by GTK-Doc V1.10