MxAction

MxAction — Represents a user action

Synopsis

                    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);
gboolean            mx_action_get_active                (MxAction *action);
void                mx_action_set_active                (MxAction *action,
                                                         gboolean active);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----MxAction

Description

Actions represent operations that the user can perform, such as items in a menu or toolbar.

Details

MxAction

typedef struct _MxAction MxAction;

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


mx_action_new ()

MxAction *          mx_action_new                       (void);

Create a new, blank, MxAction

Returns :

a newly allocated MxAction

mx_action_new_full ()

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

mx_action_get_name ()

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

mx_action_set_name ()

void                mx_action_set_name                  (MxAction *action,
                                                         const gchar *name);

Set the name of the action

action :

A MxAction

name :

new name to set

mx_action_get_active ()

gboolean            mx_action_get_active                (MxAction *action);

Get the value of the active property

action :

A MxAction

Returns :

TRUE if the action is active

mx_action_set_active ()

void                mx_action_set_active                (MxAction *action,
                                                         gboolean active);

Set the value of the active property

action :

A MxAction

active :

the value to set