PlumaPanel

PlumaPanel

Synopsis

                    PlumaPanelPrivate;
struct              PlumaPanel;
GtkWidget *         pluma_panel_new                     (GtkOrientation orientation);
void                pluma_panel_add_item                (PlumaPanel *panel,
                                                         GtkWidget *item,
                                                         const gchar *name,
                                                         GtkWidget *image);
void                pluma_panel_add_item_with_stock_icon
                                                        (PlumaPanel *panel,
                                                         GtkWidget *item,
                                                         const gchar *name,
                                                         const gchar *stock_id);
gboolean            pluma_panel_remove_item             (PlumaPanel *panel,
                                                         GtkWidget *item);
gboolean            pluma_panel_activate_item           (PlumaPanel *panel,
                                                         GtkWidget *item);
gboolean            pluma_panel_item_is_active          (PlumaPanel *panel,
                                                         GtkWidget *item);
GtkOrientation      pluma_panel_get_orientation         (PlumaPanel *panel);
gint                pluma_panel_get_n_items             (PlumaPanel *panel);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkVBox
                                       +----PlumaPanel

Implemented Interfaces

PlumaPanel implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "orientation"              GtkOrientation        : Read / Write / Construct Only

Signals

  "close"                                          : Action
  "focus-document"                                 : Action
  "item-added"                                     : Run First
  "item-removed"                                   : Run First

Description

Details

PlumaPanelPrivate

typedef struct _PlumaPanelPrivate PlumaPanelPrivate;

struct PlumaPanel

struct PlumaPanel;

pluma_panel_new ()

GtkWidget *         pluma_panel_new                     (GtkOrientation orientation);

Creates a new PlumaPanel with the given orientation. You shouldn't create a new panel use pluma_window_get_side_panel() or pluma_window_get_bottom_panel() instead.

orientation :

a GtkOrientation

Returns :

a new PlumaPanel object.

pluma_panel_add_item ()

void                pluma_panel_add_item                (PlumaPanel *panel,
                                                         GtkWidget *item,
                                                         const gchar *name,
                                                         GtkWidget *image);

Adds a new item to the panel.

panel :

a PlumaPanel

item :

the GtkWidget to add to the panel

name :

the name to be shown in the panel

image :

the image to be shown in the panel

pluma_panel_add_item_with_stock_icon ()

void                pluma_panel_add_item_with_stock_icon
                                                        (PlumaPanel *panel,
                                                         GtkWidget *item,
                                                         const gchar *name,
                                                         const gchar *stock_id);

Same as pluma_panel_add_item() but using an image from stock.

panel :

a PlumaPanel

item :

the GtkWidget to add to the panel

name :

the name to be shown in the panel

stock_id :

a stock id

pluma_panel_remove_item ()

gboolean            pluma_panel_remove_item             (PlumaPanel *panel,
                                                         GtkWidget *item);

Removes the widget item from the panel if it is in the panel and returns TRUE if there was not any problem.

panel :

a PlumaPanel

item :

the item to be removed from the panel

Returns :

TRUE if it was well removed.

pluma_panel_activate_item ()

gboolean            pluma_panel_activate_item           (PlumaPanel *panel,
                                                         GtkWidget *item);

Switches to the page that contains item.

panel :

a PlumaPanel

item :

the item to be activated

Returns :

TRUE if it was activated

pluma_panel_item_is_active ()

gboolean            pluma_panel_item_is_active          (PlumaPanel *panel,
                                                         GtkWidget *item);

Wheter item is the one current active in panel

panel :

a PlumaPanel

item :

a widget contained in PlumaPanel

Returns :

TRUE if the widget is active

pluma_panel_get_orientation ()

GtkOrientation      pluma_panel_get_orientation         (PlumaPanel *panel);

Gets the orientation of the panel.

panel :

a PlumaPanel

Returns :

the GtkOrientation of PlumaPanel

pluma_panel_get_n_items ()

gint                pluma_panel_get_n_items             (PlumaPanel *panel);

Gets the number of items in a panel.

panel :

a PlumaPanel

Returns :

the number of items contained in PlumaPanel

Property Details

The "orientation" property

  "orientation"              GtkOrientation        : Read / Write / Construct Only

The panel's orientation.

Default value: GTK_ORIENTATION_VERTICAL

Signal Details

The "close" signal

void                user_function                      (PlumaPanel *plumapanel,
                                                        gpointer    user_data)       : Action

The "focus-document" signal

void                user_function                      (PlumaPanel *plumapanel,
                                                        gpointer    user_data)       : Action

The "item-added" signal

void                user_function                      (PlumaPanel *plumapanel,
                                                        GtkWidget  *widget,
                                                        gpointer    user_data)       : Run First

The "item-removed" signal

void                user_function                      (PlumaPanel *plumapanel,
                                                        GtkWidget  *widget,
                                                        gpointer    user_data)       : Run First