MxComboBox

MxComboBox — combo box actor

Functions

Properties

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

Types and Values

struct MxComboBox
struct MxComboBoxClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── ClutterActor
            ╰── MxWidget
                ╰── MxComboBox

Implemented Interfaces

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

Description

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

Functions

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.

Parameters

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.

Parameters

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

Parameters

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

Parameters

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

Parameters

box

A MxComboBox

 

position

position of the item to remove

 

mx_combo_box_remove_all ()

void
mx_combo_box_remove_all (MxComboBox *box);

Remove all the items of box

Parameters

box

A MxComboBox

 

Since: 1.4


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

Parameters

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

Parameters

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.

Parameters

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

Parameters

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.

Parameters

box

A MxComboBox

 

index

the index of the list item to set

 

mx_combo_box_get_index ()

gint
mx_combo_box_get_index (MxComboBox *box);

Get the index of the last item selected

Parameters

box

A MxComboBox

 

Returns

gint

Types and Values

struct MxComboBox

struct MxComboBox;

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


struct MxComboBoxClass

struct MxComboBoxClass {
  MxWidgetClass parent_class;

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
  void (*_padding_4) (void);
};

Property Details

The “active-icon-name” property

  “active-icon-name”         gchar *

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

Flags: Read / Write

Default value: NULL


The “active-text” property

  “active-text”              gchar *

Text currently displayed in the combo box button.

Flags: Read / Write

Default value: ""


The “index” property

  “index”                    gint

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

Flags: Read / Write

Allowed values: >= -1

Default value: -1