enum HildonCaptionStatus

typedef enum
{
    HILDON_CAPTION_OPTIONAL = 0,
    HILDON_CAPTION_MANDATORY
}                                               HildonCaptionStatus;

Keys to set the HildonCaption to be optional or mandatory.

enum HildonCaptionIconPosition

typedef enum
{
    HILDON_CAPTION_POSITION_LEFT = 0,
    HILDON_CAPTION_POSITION_RIGHT
}                                               HildonCaptionIconPosition;

Keys to set the icon placement in HildonCaption.

HildonCaption

typedef struct _HildonCaption HildonCaption;

hildon_caption_new ()

GtkWidget*          hildon_caption_new                  (GtkSizeGroup *group,
                                                         const gchar *value,
                                                         GtkWidget *control,
                                                         GtkWidget *icon,
                                                         HildonCaptionStatus flag);

Creates a new instance of hildon_caption widget, with a specific control and image. Note: Clicking on a focused caption will trigger the activate signal. The default behaviour for the caption's activate signal is to call gtk_widget_activate on it's control.

Returns : a GtkWidget pointer of Caption

hildon_caption_get_size_group ()

GtkSizeGroup*       hildon_caption_get_size_group       (const HildonCaption *caption);

Query given captioned control for the GtkSizeGroup assigned to it.

Returns : a GtkSizeGroup

hildon_caption_set_size_group ()

void                hildon_caption_set_size_group       (const HildonCaption *caption,
                                                         GtkSizeGroup *new_group);

Sets a GtkSizeGroup of a given captioned control.

hildon_caption_is_mandatory ()

gboolean            hildon_caption_is_mandatory         (const HildonCaption *caption);

Query HildonCaption whether this captioned control is a mandatory one.

Returns : is this captioned control a mandatory one?

hildon_caption_set_status ()

void                hildon_caption_set_status           (HildonCaption *caption,
                                                         HildonCaptionStatus flag);

Sets HildonCaption status.

hildon_caption_get_status ()

HildonCaptionStatus hildon_caption_get_status           (const HildonCaption *caption);

Gets HildonCaption status.

Returns : one of the values from HildonCaptionStatus

hildon_caption_set_icon_position ()

void                hildon_caption_set_icon_position    (HildonCaption *caption,
                                                         HildonCaptionIconPosition pos);

Sets HildonCaption icon position.

hildon_caption_get_icon_position ()

HildonCaptionIconPosition hildon_caption_get_icon_position
                                                        (const HildonCaption *caption);

Gets HildonCaption icon position.

Returns : one of the values from HildonCaptionIconPosition.

hildon_caption_set_icon_image ()

void                hildon_caption_set_icon_image       (HildonCaption *caption,
                                                         GtkWidget *icon);

Sets the icon image widget to be used by this hildon_caption widget.

hildon_caption_get_icon_image ()

GtkWidget*          hildon_caption_get_icon_image       (const HildonCaption *caption);

Gets icon of HildonCaption

Returns : the GtkImage widget that is being used as the icon by the hildon_caption, or NULL if no icon image is in use.

hildon_caption_set_label ()

void                hildon_caption_set_label            (HildonCaption *caption,
                                                         const gchar *label);

Sets the label text that appears before the control. Separator character is added to the end of the label string. By default the separator is ":".

hildon_caption_get_label ()

gchar*              hildon_caption_get_label            (const HildonCaption *caption);

Gets label of HildonCaption

Returns : the text currently being used as the label of the caption control. The string is owned by the label and the caller should never free or modify this value.

hildon_caption_set_separator ()

void                hildon_caption_set_separator        (HildonCaption *caption,
                                                         const gchar *separator);

Sets the separator character that appears after the label. The default seaparator character is ":" separately.

hildon_caption_get_separator ()

gchar*              hildon_caption_get_separator        (const HildonCaption *caption);

Gets separator string of HildonCaption

Returns : the text currently being used as the separator of the caption control. The string is owned by the caption control and the caller should never free or modify this value.

hildon_caption_set_label_alignment ()

void                hildon_caption_set_label_alignment  (HildonCaption *caption,
                                                         gfloat alignment);

Sets the vertical alignment to be used for the text part of the caption. Applications need to align the child control themselves.

hildon_caption_get_label_alignment ()

gfloat              hildon_caption_get_label_alignment  (HildonCaption *caption);

Gets current vertical alignment for the text part.

hildon_caption_set_child_expand ()

void                hildon_caption_set_child_expand     (HildonCaption *caption,
                                                         gboolean expand);

Sets child expandability.

hildon_caption_get_child_expand ()

gboolean            hildon_caption_get_child_expand     (const HildonCaption *caption);

Gets childs expandability.

Returns : wheter the child is expandable or not.

hildon_caption_set_label_markup ()

void                hildon_caption_set_label_markup     (HildonCaption *caption,
                                                         const gchar *markup);

Sets the label markup text that appears before the control. It acts like hildon_caption_set_label but is using the markup text that allows to specify text properties such as bold or italic.

The "icon" property

  "icon"                     GtkWidget*            : Read / Write

The icon shown on the caption area.

The "icon-position" property

  "icon-position"            HildonCaptionIconPosition  : Read / Write

If the icon is positioned on the left or right side.

Default value: HILDON_CAPTION_POSITION_RIGHT

The "label" property

  "label"                    gchar*                : Read / Write

Caption label.

Default value: NULL

The "markup" property

  "markup"                   gchar*                : Write

Caption markup. Mutually exclusive with label.

Default value: NULL

The "separator" property

  "separator"                gchar*                : Read / Write

The current separator.

Default value: "ecdg_ti_caption_separator"

The "size-group" property

  "size-group"               GtkSizeGroup*         : Read / Write

Current size group the caption is in.

The "status" property

  "status"                   HildonCaptionStatus   : Read / Write

Mandatory or optional status.

Default value: HILDON_CAPTION_OPTIONAL

The "expand" child property

  "expand"                   gboolean              : Read / Write

Same as GtkBox expand. Wheter the child should be expanded or not.

Default value: FALSE

The "activate" signal

void                user_function                      (HildonCaption *hildoncaption,
                                                        gpointer       user_data)          : Run First / Action