mx_button_new ()

ClutterActor *
mx_button_new (void);

Create a new button

mx_button_new_with_label ()

ClutterActor *
mx_button_new_with_label (const gchar *text);

Create a new MxButton with the specified label

mx_button_get_label ()

const gchar *
mx_button_get_label (MxButton *button);

Get the text displayed on the button

mx_button_set_label ()

void
mx_button_set_label (MxButton *button,
                     const gchar *text);

Sets the text displayed on the button

mx_button_get_icon_name ()

const gchar *
mx_button_get_icon_name (MxButton *button);

Get the icon-name being used on the button.

Since 1.2

mx_button_set_icon_name ()

void
mx_button_set_icon_name (MxButton *button,
                         const gchar *icon_name);

Sets the icon-name used to display an icon on the button. Setting NULL will remove the icon name, or resort to the icon-name set in the current style. Setting an icon name overrides any icon set in the style.

Since 1.2

mx_button_get_icon_size ()

guint
mx_button_get_icon_size (MxButton *button);

Retrieves the icon-size being used for the displayed icon inside the button.

Since 1.2

mx_button_set_icon_size ()

void
mx_button_set_icon_size (MxButton *button,
                         guint icon_size);

Sets the icon-size to use for the icon displayed inside the button. This will override the icon-size set in the style. Setting a value of 0 resets to the size from the style.

Since 1.2

mx_button_set_is_toggle ()

void
mx_button_set_is_toggle (MxButton *button,
                         gboolean toggle);

Enables or disables toggle mode for the button. In toggle mode, the active state will be "toggled" when the user clicks the button.

mx_button_get_is_toggle ()

gboolean
mx_button_get_is_toggle (MxButton *button);

Get the toggle mode status of the button.

mx_button_set_toggled ()

void
mx_button_set_toggled (MxButton *button,
                       gboolean toggled);

Sets the toggled state of the button. This is only really useful if the button has toggle-mode mode set to TRUE.

mx_button_get_toggled ()

gboolean
mx_button_get_toggled (MxButton *button);

Get the state of the button that is in toggle mode.

mx_button_set_action ()

void
mx_button_set_action (MxButton *button,
                      MxAction *action);

Sets action as the action for button . Button will take its label and icon from action .

Since 1.2

mx_button_get_action ()

MxAction *
mx_button_get_action (MxButton *button);

Retrieves the MxAction associated with button .

Since 1.2

mx_button_set_icon_position ()

void
mx_button_set_icon_position (MxButton *button,
                             MxPosition position);

Sets the icon position, relative to the text on the button.

Since 1.2

mx_button_get_icon_position ()

MxPosition
mx_button_get_icon_position (MxButton *button);

Retrieves the icon's relative position to the text.

Since 1.2

mx_button_set_icon_visible ()

void
mx_button_set_icon_visible (MxButton *button,
                            gboolean visible);

Sets the visibility of the icon associated with the button's action.

Since 1.2

mx_button_get_icon_visible ()

gboolean
mx_button_get_icon_visible (MxButton *button);

Retrieves the visibility of the icon associated with the button's action.

Since 1.2

mx_button_set_label_visible ()

void
mx_button_set_label_visible (MxButton *button,
                             gboolean visible);

Sets the visibility of the text associated with the button's action.

Since 1.2

mx_button_get_label_visible ()

gboolean
mx_button_get_label_visible (MxButton *button);

Retrieves the visibility of the text associated with the button's action.

Since 1.2

struct MxButton

struct MxButton;

The contents of this structure is private and should only be accessed using the provided API.

struct MxButtonClass

struct MxButtonClass {
  MxBinClass parent_class;

  /* signals */
  void     (* clicked)    (MxButton          *button);

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

The “action” property

  “action”                   MxAction *

Associated action.

Flags: Read / Write

The “icon-name” property

  “icon-name”                gchar *

Icon name of the button.

Flags: Read / Write

Default value: NULL

The “icon-position” property

  “icon-position”            MxPosition

The position of the icon, relative to the text.

Flags: Read / Write

Default value: MX_POSITION_LEFT

The “icon-size” property

  “icon-size”                guint

The size to use for the button icon (in pixels).

Flags: Read / Write

Default value: 0

The “icon-visible” property

  “icon-visible”             gboolean

Whether to show the icon.

Flags: Read / Write

Default value: TRUE

The “is-toggle” property

  “is-toggle”                gboolean

Enable or disable toggling.

Flags: Read / Write

Default value: FALSE

The “label” property

  “label”                    gchar *

Label of the button.

Flags: Read / Write

Default value: NULL

The “label-visible” property

  “label-visible”            gboolean

Whether to show the label.

Flags: Read / Write

Default value: TRUE

The “toggled” property

  “toggled”                  gboolean

Indicates if a toggle button is "on" or "off".

Flags: Read / Write

Default value: FALSE

The “clicked” signal

void
user_function (MxButton *button,
               gpointer  user_data)

Emitted when the user activates the button, either with a mouse press and release or with the keyboard.

Flags: Run Last