AnjutaCommandBar

AnjutaCommandBar — Widget that lays out commands in a vertical row of buttons and frames.

Synopsis

#include <libanjuta/anjuta-command-bar.h>

enum                AnjutaCommandBarEntryType;
struct              AnjutaCommandBarClass;
GtkWidget *         anjuta_command_bar_new              (void);
void                anjuta_command_bar_add_action_group (AnjutaCommandBar *self,
                                                         const gchar *group_name,
                                                         const AnjutaCommandBarEntry *entries,
                                                         int num_entries,
                                                         gpointer user_data);
void                anjuta_command_bar_remove_action_group
                                                        (AnjutaCommandBar *self,
                                                         const gchar *group_name);
void                anjuta_command_bar_show_action_group
                                                        (AnjutaCommandBar *self,
                                                         const gchar *group_name);
GtkActionGroup *    anjuta_command_bar_get_action_group (AnjutaCommandBar *self,
                                                         const gchar *group_name);
GtkAction *         anjuta_command_bar_get_action       (AnjutaCommandBar *self,
                                                         const gchar *group_name,
                                                         const gchar *action_name);
                    AnjutaCommandBarPriv;

Description

AnjutaCommandBar provides a convenient way to arrange several sets of commands into one widget. It separates commands into different groups of actions, with only one group visible at a time.

Details

enum AnjutaCommandBarEntryType

typedef enum {
	ANJUTA_COMMAND_BAR_ENTRY_FRAME,
	ANJUTA_COMMAND_BAR_ENTRY_BUTTON
} AnjutaCommandBarEntryType;

Specifies if the entry corresponds to a frame or a button. Buttons are added to the last frame that appears before the button entry

ANJUTA_COMMAND_BAR_ENTRY_FRAME

This entry should create a frame in the action bar. The entry's action name and callback are ignored.

ANJUTA_COMMAND_BAR_ENTRY_BUTTON

This entry adds a button to the action bar, either to the last frame to appear in the entry list before this entry, or to the top of the bar if no frames were previously added.

struct AnjutaCommandBarClass

struct AnjutaCommandBarClass {
	GtkNotebookClass parent_class;
};


anjuta_command_bar_new ()

GtkWidget *         anjuta_command_bar_new              (void);

Creates a new AnjutaCommandBar.

Returns :

A new AnjutaCommandBar

anjuta_command_bar_add_action_group ()

void                anjuta_command_bar_add_action_group (AnjutaCommandBar *self,
                                                         const gchar *group_name,
                                                         const AnjutaCommandBarEntry *entries,
                                                         int num_entries,
                                                         gpointer user_data);

Adds a group of entries to an AnjutaCommandBar.

self :

An AnjutaCommandBar

group_name :

A unique name for this group of entries

entries :

A list of entries to add. [array length=num_entries]

num_entries :

The number of items pointed to by entries

user_data :

User data to pass to the entry callback

anjuta_command_bar_remove_action_group ()

void                anjuta_command_bar_remove_action_group
                                                        (AnjutaCommandBar *self,
                                                         const gchar *group_name);

Removes an action group from an AnjutaCommandBar.

self :

An AnjutaCommandBar

group_name :

Name of the action group to remove

anjuta_command_bar_show_action_group ()

void                anjuta_command_bar_show_action_group
                                                        (AnjutaCommandBar *self,
                                                         const gchar *group_name);

Causes the actions in the given group to become visible, replacing the previously visible group.

self :

An AnjutaCommandBar

group_name :

The name of the action group to show

anjuta_command_bar_get_action_group ()

GtkActionGroup *    anjuta_command_bar_get_action_group (AnjutaCommandBar *self,
                                                         const gchar *group_name);

group_name :

The name of the action group

Returns :

The GtkActionGroup with the given group_name

anjuta_command_bar_get_action ()

GtkAction *         anjuta_command_bar_get_action       (AnjutaCommandBar *self,
                                                         const gchar *group_name,
                                                         const gchar *action_name);

Retrieves a GtkAction object in the given group with the given name

self :

An AnjutaCommandBar

group_name :

The name of the GtkActionGroup to look for the action in

action_name :

The name of the action

AnjutaCommandBarPriv

typedef struct _AnjutaCommandBarPriv AnjutaCommandBarPriv;

See Also

AnjutaDock, GtkAction