MxComboBox

MxComboBox — combo box actor

Synopsis

struct              MxComboBox;
ClutterActor *      mx_combo_box_new                    (void);
void                mx_combo_box_insert_text            (MxComboBox *box,
                                                         gint position,
                                                         const gchar *text);
void                mx_combo_box_insert_text_with_icon  (MxComboBox *box,
                                                         gint position,
                                                         const gchar *text,
                                                         const gchar *icon);
void                mx_combo_box_append_text            (MxComboBox *box,
                                                         const gchar *text);
void                mx_combo_box_prepend_text           (MxComboBox *box,
                                                         const gchar *text);
void                mx_combo_box_remove_text            (MxComboBox *box,
                                                         gint position);
void                mx_combo_box_set_active_text        (MxComboBox *box,
                                                         const gchar *text);
const gchar *       mx_combo_box_get_active_text        (MxComboBox *box);
void                mx_combo_box_set_active_icon_name   (MxComboBox *box,
                                                         const gchar *icon_name);
const gchar *       mx_combo_box_get_active_icon_name   (MxComboBox *box);
void                mx_combo_box_set_index              (MxComboBox *box,
                                                         gint index);
const gint          mx_combo_box_get_index              (MxComboBox *box);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxComboBox

Implemented Interfaces

MxComboBox implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface, MxStylable and MxFocusable.

Properties

  "active-icon-name"         gchar*                : Read / Write
  "active-text"              gchar*                : Read / Write
  "index"                    gint                  : Read / Write

Description

MxComboBox combines a button with a popup menu to allow the user to select an option from a list.

Details

struct MxComboBox

struct MxComboBox;

The contents of this structure are private and should only be accessed through the public API.


mx_combo_box_new ()

ClutterActor *      mx_combo_box_new                    (void);

Create a new MxComboBox

Returns :

a newly allocated MxComboBox

mx_combo_box_insert_text ()

void                mx_combo_box_insert_text            (MxComboBox *box,
                                                         gint position,
                                                         const gchar *text);

Insert an item into the combo box list.

box :

A MxComboBox

position :

zero indexed position to insert the item at

text :

name of the item

mx_combo_box_insert_text_with_icon ()

void                mx_combo_box_insert_text_with_icon  (MxComboBox *box,
                                                         gint position,
                                                         const gchar *text,
                                                         const gchar *icon);

Insert an item with text and an icon into the combo box list.

box :

A MxComboBox

position :

zero indexed position to insert the item at

text :

name of the item

icon :

name of an icon from the icon theme

mx_combo_box_append_text ()

void                mx_combo_box_append_text            (MxComboBox *box,
                                                         const gchar *text);

Append an item to the combo box list

box :

A MxComboBox

text :

name of the item

mx_combo_box_prepend_text ()

void                mx_combo_box_prepend_text           (MxComboBox *box,
                                                         const gchar *text);

Prepend an item to the combo box list

box :

A MxComboBox

text :

name of the item

mx_combo_box_remove_text ()

void                mx_combo_box_remove_text            (MxComboBox *box,
                                                         gint position);

Remove the item at position

box :

A MxComboBox

position :

position of the item to remove

mx_combo_box_set_active_text ()

void                mx_combo_box_set_active_text        (MxComboBox *box,
                                                         const gchar *text);

Set the text displayed in the combo box

box :

A MxComboBox

text :

text to display

mx_combo_box_get_active_text ()

const gchar *       mx_combo_box_get_active_text        (MxComboBox *box);

Get the text displayed in the combo box

box :

A MxComboBox

Returns :

the text string, owned by the combo box

mx_combo_box_set_active_icon_name ()

void                mx_combo_box_set_active_icon_name   (MxComboBox *box,
                                                         const gchar *icon_name);

Set the icon displayed in the combo box.

box :

A MxComboBox

icon_name :

Icon name to use for displayed icon. [allow-none]

mx_combo_box_get_active_icon_name ()

const gchar *       mx_combo_box_get_active_icon_name   (MxComboBox *box);

Get the name of the icon displayed in the combo box

box :

A MxComboBox

Returns :

the text string of the name of the displayed icon, owned by the combo box, or NULL if there is no active icon.

mx_combo_box_set_index ()

void                mx_combo_box_set_index              (MxComboBox *box,
                                                         gint index);

Set the current combo box text from the item at index in the list.

box :

A MxComboBox

index :

the index of the list item to set

mx_combo_box_get_index ()

const gint          mx_combo_box_get_index              (MxComboBox *box);

Get the index of the last item selected

box :

A MxComboBox

Returns :

const gint

Property Details

The "active-icon-name" property

  "active-icon-name"         gchar*                : Read / Write

Name of the icon currently displayed in the combo-box.

Default value: NULL


The "active-text" property

  "active-text"              gchar*                : Read / Write

Text currently displayed in the combo box button.

Default value: ""


The "index" property

  "index"                    gint                  : Read / Write

Index of the selected item, or -1 if no item is selected.

Allowed values: >= -1

Default value: -1