XedPanel

XedPanel

Functions

GtkWidget * xed_panel_new ()
void xed_panel_add_item ()
gboolean xed_panel_remove_item ()
gboolean xed_panel_activate_item ()
gboolean xed_panel_item_is_active ()
GtkOrientation xed_panel_get_orientation ()
gint xed_panel_get_n_items ()

Properties

GtkOrientation orientation Read / Write / Construct Only

Signals

void close Action
void focus-document Action
void item-added Run First
void item-removed Run First

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── XedPanel

Implemented Interfaces

XedPanel implements AtkImplementorIface and GtkBuildable.

Description

Functions

xed_panel_new ()

GtkWidget *
xed_panel_new (GtkOrientation orientation);

Creates a new XedPanel with the given orientation . You shouldn't create a new panel use xed_window_get_side_panel() or xed_window_get_bottom_panel() instead.

Parameters

orientation

a GtkOrientation

 

Returns

a new XedPanel object.


xed_panel_add_item ()

void
xed_panel_add_item (XedPanel *panel,
                    GtkWidget *item,
                    const gchar *name,
                    const gchar *icon_name);

Adds a new item to the panel .

Parameters

panel

a XedPanel

 

item

the GtkWidget to add to the panel

 

name

the name to be shown in the panel

 

icon_name

the name of the icon to be shown in the panel

 

xed_panel_remove_item ()

gboolean
xed_panel_remove_item (XedPanel *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.

Parameters

panel

a XedPanel

 

item

the item to be removed from the panel

 

Returns

TRUE if it was well removed.


xed_panel_activate_item ()

gboolean
xed_panel_activate_item (XedPanel *panel,
                         GtkWidget *item);

Switches to the page that contains item .

Parameters

panel

a XedPanel

 

item

the item to be activated

 

Returns

TRUE if it was activated


xed_panel_item_is_active ()

gboolean
xed_panel_item_is_active (XedPanel *panel,
                          GtkWidget *item);

Returns whether item is the active widget in panel

Parameters

panel

a XedPanel

 

item

a GtkWidget

 

Returns

TRUE if item is the active widget


xed_panel_get_orientation ()

GtkOrientation
xed_panel_get_orientation (XedPanel *panel);

Gets the orientation of the panel .

Parameters

panel

a XedPanel

 

Returns

the GtkOrientation of XedPanel


xed_panel_get_n_items ()

gint
xed_panel_get_n_items (XedPanel *panel);

Gets the number of items in a panel .

Parameters

panel

a XedPanel

 

Returns

the number of items contained in XedPanel

Types and Values

XedPanelPrivate

typedef struct _XedPanelPrivate XedPanelPrivate;

struct XedPanel

struct XedPanel;

Property Details

The “orientation” property

  “orientation”              GtkOrientation

The panel's orientation.

Flags: Read / Write / Construct Only

Default value: GTK_ORIENTATION_VERTICAL

Signal Details

The “close” signal

void
user_function (XedPanel *xedpanel,
               gpointer  user_data)

Flags: Action


The “focus-document” signal

void
user_function (XedPanel *xedpanel,
               gpointer  user_data)

Flags: Action


The “item-added” signal

void
user_function (XedPanel  *xedpanel,
               GtkWidget *widget,
               gpointer   user_data)

Flags: Run First


The “item-removed” signal

void
user_function (XedPanel  *xedpanel,
               GtkWidget *widget,
               gpointer   user_data)

Flags: Run First