GimpDockbook

GimpDockbook

Synopsis

                    GimpDockbook;
                    GimpDockbookPrivate;
GtkWidget *         gimp_dockbook_new                   (GimpMenuFactory *menu_factory);
GimpDock *          gimp_dockbook_get_dock              (GimpDockbook *dockbook);
void                gimp_dockbook_set_dock              (GimpDockbook *dockbook,
                                                         GimpDock *dock);
GimpUIManager *     gimp_dockbook_get_ui_manager        (GimpDockbook *dockbook);
void                gimp_dockbook_add                   (GimpDockbook *dockbook,
                                                         GimpDockable *dockable,
                                                         gint position);
GtkWidget *         gimp_dockbook_add_from_dialog_factory
                                                        (GimpDockbook *dockbook,
                                                         const gchar *identifiers,
                                                         gint position);
void                gimp_dockbook_remove                (GimpDockbook *dockbook,
                                                         GimpDockable *dockable);
void                gimp_dockbook_update_with_context   (GimpDockbook *dockbook,
                                                         GimpContext *context);
GtkWidget *         gimp_dockbook_create_tab_widget     (GimpDockbook *dockbook,
                                                         GimpDockable *dockable);
void                gimp_dockbook_update_auto_tab_style (GimpDockbook *dockbook);
gboolean            gimp_dockbook_drop_dockable         (GimpDockbook *dockbook,
                                                         GtkWidget *drag_source);
void                gimp_dockbook_set_drag_handler      (GimpDockbook *dockbook,
                                                         GimpPanedBox *drag_handler);
GimpDockable *      gimp_dockbook_drag_source_to_dockable
                                                        (GtkWidget *drag_source);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkNotebook
                                 +----GimpDockbook

Implemented Interfaces

GimpDockbook implements AtkImplementorIface and GtkBuildable.

Style Properties

  "tab-border"               gint                  : Read
  "tab-icon-size"            GtkIconSize           : Read

Signals

  "dockable-added"                                 : Run First
  "dockable-removed"                               : Run First
  "dockable-reordered"                             : Run First

Description

Details

GimpDockbook

typedef struct _GimpDockbook GimpDockbook;

Holds GimpDockables which are presented on different tabs using GtkNotebook.


GimpDockbookPrivate

typedef struct _GimpDockbookPrivate GimpDockbookPrivate;


gimp_dockbook_new ()

GtkWidget *         gimp_dockbook_new                   (GimpMenuFactory *menu_factory);


gimp_dockbook_get_dock ()

GimpDock *          gimp_dockbook_get_dock              (GimpDockbook *dockbook);


gimp_dockbook_set_dock ()

void                gimp_dockbook_set_dock              (GimpDockbook *dockbook,
                                                         GimpDock *dock);


gimp_dockbook_get_ui_manager ()

GimpUIManager *     gimp_dockbook_get_ui_manager        (GimpDockbook *dockbook);


gimp_dockbook_add ()

void                gimp_dockbook_add                   (GimpDockbook *dockbook,
                                                         GimpDockable *dockable,
                                                         gint position);


gimp_dockbook_add_from_dialog_factory ()

GtkWidget *         gimp_dockbook_add_from_dialog_factory
                                                        (GimpDockbook *dockbook,
                                                         const gchar *identifiers,
                                                         gint position);

Add a dockable from the dialog factory associated wth the dockbook.

dockbook :

The DockBook

identifiers :

The dockable identifier(s)

position :

The insert position

gimp_dockbook_remove ()

void                gimp_dockbook_remove                (GimpDockbook *dockbook,
                                                         GimpDockable *dockable);


gimp_dockbook_update_with_context ()

void                gimp_dockbook_update_with_context   (GimpDockbook *dockbook,
                                                         GimpContext *context);

Set context on all dockables in dockbook.


gimp_dockbook_create_tab_widget ()

GtkWidget *         gimp_dockbook_create_tab_widget     (GimpDockbook *dockbook,
                                                         GimpDockable *dockable);


gimp_dockbook_update_auto_tab_style ()

void                gimp_dockbook_update_auto_tab_style (GimpDockbook *dockbook);

Refresh the table that we use to map dockbook width to actual auto tab style, then update auto tabs (also recreate tab widgets if necessary).


gimp_dockbook_drop_dockable ()

gboolean            gimp_dockbook_drop_dockable         (GimpDockbook *dockbook,
                                                         GtkWidget *drag_source);


gimp_dockbook_set_drag_handler ()

void                gimp_dockbook_set_drag_handler      (GimpDockbook *dockbook,
                                                         GimpPanedBox *drag_handler);


gimp_dockbook_drag_source_to_dockable ()

GimpDockable *      gimp_dockbook_drag_source_to_dockable
                                                        (GtkWidget *drag_source);

Gets the dockable associated with a drag-and-drop source. If successfull, the function will also cleanup the dockable.

drag_source :

A drag-and-drop source widget

Returns :

The dockable

Style Property Details

The "tab-border" style property

  "tab-border"               gint                  : Read

Allowed values: >= 0

Default value: 0


The "tab-icon-size" style property

  "tab-icon-size"            GtkIconSize           : Read

Default value: GTK_ICON_SIZE_BUTTON

Signal Details

The "dockable-added" signal

void                user_function                      (GimpDockbook *gimpdockbook,
                                                        GimpDockable *arg1,
                                                        gpointer      user_data)         : Run First

gimpdockbook :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "dockable-removed" signal

void                user_function                      (GimpDockbook *gimpdockbook,
                                                        GimpDockable *arg1,
                                                        gpointer      user_data)         : Run First

gimpdockbook :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "dockable-reordered" signal

void                user_function                      (GimpDockbook *gimpdockbook,
                                                        GimpDockable *arg1,
                                                        gpointer      user_data)         : Run First

gimpdockbook :

the object which received the signal.

user_data :

user data set when the signal handler was connected.