NbtkAction

NbtkAction — Represents a user action

Synopsis

                    NbtkAction;
NbtkAction *        nbtk_action_new                     (void);
NbtkAction *        nbtk_action_new_full                (const gchar *name,
                                                         GCallback activated_cb,
                                                         gpointer user_data);
const gchar *       nbtk_action_get_name                (NbtkAction *action);
void                nbtk_action_set_name                (NbtkAction *action,
                                                         const gchar *name);
gboolean            nbtk_action_get_active              (NbtkAction *action);
void                nbtk_action_set_active              (NbtkAction *action,
                                                         gboolean active);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----NbtkAction

Description

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

Details

NbtkAction

typedef struct _NbtkAction NbtkAction;

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

nbtk_action_new ()

NbtkAction *        nbtk_action_new                     (void);

Create a new, blank, NbtkAction

Returns :

 a newly allocated NbtkAction

nbtk_action_new_full ()

NbtkAction *        nbtk_action_new_full                (const gchar *name,
                                                         GCallback activated_cb,
                                                         gpointer user_data);

Create a new NbtkAction with the name and callback set

name :

 name of the action

activated_cb :

 callback to connect to the activated signal

user_data :

 user data to be passed to the callback

Returns :

 a newly allocation NbtkAction

nbtk_action_get_name ()

const gchar *       nbtk_action_get_name                (NbtkAction *action);

Get the name of the action

action :

 A NbtkAction

Returns :

 name of the action, owned by NbtkAction

nbtk_action_set_name ()

void                nbtk_action_set_name                (NbtkAction *action,
                                                         const gchar *name);

Set the name of the action

action :

 A NbtkAction

name :

 new name to set

nbtk_action_get_active ()

gboolean            nbtk_action_get_active              (NbtkAction *action);

Get the value of the active property

action :

 A NbtkAction

Returns :

 TRUE if the action is active

nbtk_action_set_active ()

void                nbtk_action_set_active              (NbtkAction *action,
                                                         gboolean active);

Set the value of the active property

action :

 A NbtkAction

active :

 the value to set
Generated by GTK-Doc V1.15