## GeditPanel

GeditPanel

## Synopsis

                        GeditPanelPrivate;
    struct              GeditPanel;
    GtkWidget *         gedit_panel_new                     (GtkOrientation orientation);
    gboolean            gedit_panel_add_item                (GeditPanel *panel,
                                                             GtkWidget *item,
                                                             const gchar *id,
                                                             const gchar *display_name,
                                                             GtkWidget *image);
    gboolean            gedit_panel_add_item_with_stock_icon
                                                            (GeditPanel *panel,
                                                             GtkWidget *item,
                                                             const gchar *id,
                                                             const gchar *display_name,
                                                             const gchar *stock_id);
    gboolean            gedit_panel_remove_item             (GeditPanel *panel,
                                                             GtkWidget *item);
    gboolean            gedit_panel_activate_item           (GeditPanel *panel,
                                                             GtkWidget *item);
    gboolean            gedit_panel_item_is_active          (GeditPanel *panel,
                                                             GtkWidget *item);
    GtkOrientation      gedit_panel_get_orientation         (GeditPanel *panel);
    gint                gedit_panel_get_n_items             (GeditPanel *panel);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBin
                               +----GeditPanel

## Implemented Interfaces

GeditPanel implements AtkImplementorIface and GtkBuildable.

## Properties

      "orientation"              GtkOrientation        : Read / Write / Construct Only

## Signals

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

## Description

## Details

### GeditPanelPrivate

    typedef struct _GeditPanelPrivate GeditPanelPrivate;

### struct GeditPanel

    struct GeditPanel;

### gedit_panel_new ()

    GtkWidget *         gedit_panel_new                     (GtkOrientation orientation);

Creates a new GeditPanel with the given `orientation`. You shouldn't create a new panel use `gedit_window_get_side_panel()` or `gedit_window_get_bottom_panel()` instead.

`orientation` : | a GtkOrientation
Returns : | a new GeditPanel object.

### gedit_panel_add_item ()

    gboolean            gedit_panel_add_item                (GeditPanel *panel,
                                                             GtkWidget *item,
                                                             const gchar *id,
                                                             const gchar *display_name,
                                                             GtkWidget *image);

Adds a new item to the `panel`.

`panel` : | a GeditPanel
`item` : | the GtkWidget to add to the `panel`
`id` : | unique name for the new item
`display_name` : | the name to be shown in the `panel`
`image` : | the image to be shown in the `panel`, or `NULL`. [allow-none]
Returns : | `TRUE` is the item was successfully added.

### gedit_panel_add_item_with_stock_icon ()

    gboolean            gedit_panel_add_item_with_stock_icon
                                                            (GeditPanel *panel,
                                                             GtkWidget *item,
                                                             const gchar *id,
                                                             const gchar *display_name,
                                                             const gchar *stock_id);

Same as `gedit_panel_add_item()` but using an image from stock.

`panel` : | a GeditPanel
`item` : | the GtkWidget to add to the `panel`
`id` : | unique name for the new item
`display_name` : | the name to be shown in the `panel`
`stock_id` : | a stock id, or `NULL`. [allow-none]
Returns : | `TRUE` is the item was successfully added.

### gedit_panel_remove_item ()

    gboolean            gedit_panel_remove_item             (GeditPanel *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 GeditPanel
`item` : | the item to be removed from the panel
Returns : | `TRUE` if it was well removed.

### gedit_panel_activate_item ()

    gboolean            gedit_panel_activate_item           (GeditPanel *panel,
                                                             GtkWidget *item);

Switches to the page that contains `item`.

`panel` : | a GeditPanel
`item` : | the item to be activated
Returns : | `TRUE` if it was activated

### gedit_panel_item_is_active ()

    gboolean            gedit_panel_item_is_active          (GeditPanel *panel,
                                                             GtkWidget *item);

Returns whether `item` is the active widget in `panel`

`panel` : | a GeditPanel
`item` : | a GtkWidget
Returns : | `TRUE` if `item` is the active widget

### gedit_panel_get_orientation ()

    GtkOrientation      gedit_panel_get_orientation         (GeditPanel *panel);

Gets the orientation of the `panel`.

`panel` : | a GeditPanel
Returns : | the GtkOrientation of GeditPanel

### gedit_panel_get_n_items ()

    gint                gedit_panel_get_n_items             (GeditPanel *panel);

Gets the number of items in a `panel`.

`panel` : | a GeditPanel
Returns : | the number of items contained in GeditPanel

## 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                      (GeditPanel *geditpanel,
                                                            gpointer    user_data)       : Action

### The `"focus-document"` signal

    void                user_function                      (GeditPanel *geditpanel,
                                                            gpointer    user_data)       : Action

### The `"item-added"` signal

    void                user_function                      (GeditPanel *geditpanel,
                                                            GtkWidget  *widget,
                                                            gpointer    user_data)       : Run First

### The `"item-removed"` signal

    void                user_function                      (GeditPanel *geditpanel,
                                                            GtkWidget  *widget,
                                                            gpointer    user_data)       : Run First