![]() |
![]() |
![]() |
Mx Toolkit Reference Manual | ![]() |
---|---|---|---|---|
MxAction; MxAction* mx_action_new (void); MxAction* mx_action_new_full (const gchar *name, const gchar *display_name, GCallback activated_cb, gpointer user_data); const gchar* mx_action_get_name (MxAction *action); void mx_action_set_name (MxAction *action, const gchar *name); const gchar* mx_action_get_display_name (MxAction *action); void mx_action_set_display_name (MxAction *action, const gchar *name); const gchar* mx_action_get_icon (MxAction *action); void mx_action_set_icon (MxAction *action, const gchar *name); gboolean mx_action_get_active (MxAction *action); void mx_action_set_active (MxAction *action, gboolean active);
"active" gboolean : Read / Write "display-name" gchar* : Read / Write "icon" gchar* : Read / Write "name" gchar* : Read / Write
Actions represent operations that the user can perform, such as items in a menu or toolbar.
typedef struct _MxAction MxAction;
The contents of this structure are private and should only be accessed through the public API.
MxAction* mx_action_new (void);
Create a new, blank, MxAction
Returns : | a newly allocated MxAction |
MxAction* mx_action_new_full (const gchar *name, const gchar *display_name, GCallback activated_cb, gpointer user_data);
Create a new MxAction with the name and callback set
name : |
name of the action |
display_name : |
name of the action to display to the user |
activated_cb : |
callback to connect to the activated signal |
user_data : |
user data to be passed to the callback |
Returns : | a newly allocation MxAction |
const gchar* mx_action_get_name (MxAction *action);
Get the name of the action
action : |
A MxAction |
Returns : | name of the action, owned by MxAction |
void mx_action_set_name (MxAction *action, const gchar *name);
Set the name of the action
action : |
A MxAction |
name : |
new name to set |
const gchar* mx_action_get_display_name (MxAction *action);
Get the display name of the action
action : |
A MxAction |
Returns : | display-name of the action, owned by MxAction |
void mx_action_set_display_name (MxAction *action, const gchar *name);
Set the name of the action to display to the user
action : |
A MxAction |
name : |
new display name to set |
const gchar* mx_action_get_icon (MxAction *action);
Get the icon of the action
action : |
A MxAction |
Returns : | icon of the action, owned by MxAction |
void mx_action_set_icon (MxAction *action, const gchar *name);
The icon to be used in a visual representation of an action.
action : |
A MxAction |
name : |
new icon to set |
gboolean mx_action_get_active (MxAction *action);
Get the value of the active property
action : |
A MxAction |
Returns : | TRUE if the action is active |
"active"
property"active" gboolean : Read / Write
Whether the action is active.
Default value: TRUE
"display-name"
property"display-name" gchar* : Read / Write
Localised name to use for display.
Default value: NULL
"icon"
property"icon" gchar* : Read / Write
Icon name or path to to be used if this action is displayed.
Default value: NULL
"activated"
signalvoid user_function (MxAction *action, gpointer user_data) : Run Last
Emitted when the MxAction is activated.
action : |
the object that received the signal |
user_data : |
user data set when the signal handler was connected. |