HildonPickerDialog

HildonPickerDialog — A utility widget that shows a HildonTouchSelector widget

Synopsis

#define             HILDON_DISABLE_DEPRECATED
                    HildonPickerDialog;
GtkWidget*          hildon_picker_dialog_new            (GtkWindow *parent);
gboolean            hildon_picker_dialog_set_selector   (HildonPickerDialog *dialog,
                                                         HildonTouchSelector *selector);
void                hildon_picker_dialog_set_done_label (HildonPickerDialog *dialog,
                                                         const gchar *label);
const gchar*        hildon_picker_dialog_get_done_label (HildonPickerDialog *dialog);
HildonTouchSelector* hildon_picker_dialog_get_selector  (HildonPickerDialog *dialog);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----HildonDialog
                                                   +----HildonPickerDialog

Implemented Interfaces

HildonPickerDialog implements AtkImplementorIface and GtkBuildable.

Properties

  "center-on-show"           gboolean              : Read / Write / Construct
  "done-button-text"         gchar*                : Read / Write / Construct

Description

HildonPickerDialog is a dialog that is used to show a HildonTouchSelector widget and a 'Done' button to allow users to finish their selections.

The HildonPickerDialog will show a 'Done' button in case the HildonTouchSelector allows multiple selection. The label of the button can be set using hildon_picker_dialog_set_done_label() and retrieved using hildon_picker_dialog_get_done_label()

Note that in most cases developers don't need to deal directly with this widget. HildonPickerButton is designed to pop up a HildonPickerDialog and manage the interaction with it.

Details

HILDON_DISABLE_DEPRECATED

  #define HILDON_DISABLE_DEPRECATED

HildonPickerDialog

typedef struct _HildonPickerDialog HildonPickerDialog;

Button label

Since 2.2

hildon_picker_dialog_new ()

GtkWidget*          hildon_picker_dialog_new            (GtkWindow *parent);

Creates a new HildonPickerDialog

parent : the parent window
Returns : a new HildonPickerDialog

Since 2.2

hildon_picker_dialog_set_selector ()

gboolean            hildon_picker_dialog_set_selector   (HildonPickerDialog *dialog,
                                                         HildonTouchSelector *selector);

Sets selector as the HildonTouchSelector to be shown in dialog

dialog : a HildonPickerDialog
selector : a HildonTouchSelector
Returns : TRUE if selector was set, FALSE otherwise

Since 2.2

hildon_picker_dialog_set_done_label ()

void                hildon_picker_dialog_set_done_label (HildonPickerDialog *dialog,
                                                         const gchar *label);

Sets a custom string to be used as the 'Done' button label in dialog.

dialog : a HildonPickerDialog
label : a string

Since 2.2

hildon_picker_dialog_get_done_label ()

const gchar*        hildon_picker_dialog_get_done_label (HildonPickerDialog *dialog);

Retrieves current 'Done' button label.

dialog : a HildonPickerDialog
Returns : the custom string to be used.

Since 2.2

hildon_picker_dialog_get_selector ()

HildonTouchSelector* hildon_picker_dialog_get_selector  (HildonPickerDialog *dialog);

Retrieves the HildonTouchSelector associated to dialog.

dialog : a HildonPickerDialog
Returns : a HildonTouchSelector

Since 2.2

Property Details

The "center-on-show" property

  "center-on-show"           gboolean              : Read / Write / Construct

If the dialog should center on the current selection when it is showed.

Default value: TRUE

The "done-button-text" property

  "done-button-text"         gchar*                : Read / Write / Construct

Done Button Label.

Default value: "wdgt_bd_done"

Generated by GTK-Doc V1.10