GimpDock

GimpDock

Synopsis

#define             GIMP_DOCK_BOOK_SEPARATOR
#define             GIMP_DOCK_COLUMN_SEPARATOR
#define             GIMP_DOCK_DOCKABLE_SEPARATOR
                    GimpDock;
                    GimpDockPrivate;
gchar *             gimp_dock_get_description           (GimpDock *dock,
                                                         gboolean complete);
void                gimp_dock_set_host_geometry_hints   (GimpDock *dock,
                                                         GtkWindow *window);
void                gimp_dock_invalidate_geometry       (GimpDock *dock);
void                gimp_dock_update_with_context       (GimpDock *dock,
                                                         GimpContext *context);
GimpContext *       gimp_dock_get_context               (GimpDock *dock);
GimpDialogFactory * gimp_dock_get_dialog_factory        (GimpDock *dock);
GimpUIManager *     gimp_dock_get_ui_manager            (GimpDock *dock);
GList *             gimp_dock_get_dockbooks             (GimpDock *dock);
gint                gimp_dock_get_n_dockables           (GimpDock *dock);
GtkWidget *         gimp_dock_get_main_vbox             (GimpDock *dock);
GtkWidget *         gimp_dock_get_vbox                  (GimpDock *dock);
gint                gimp_dock_get_id                    (GimpDock *dock);
void                gimp_dock_set_id                    (GimpDock *dock,
                                                         gint ID);
void                gimp_dock_add                       (GimpDock *dock,
                                                         GimpDockable *dockable,
                                                         gint book,
                                                         gint index);
void                gimp_dock_remove                    (GimpDock *dock,
                                                         GimpDockable *dockable);
void                gimp_dock_add_book                  (GimpDock *dock,
                                                         GimpDockbook *dockbook,
                                                         gint index);
void                gimp_dock_remove_book               (GimpDock *dock,
                                                         GimpDockbook *dockbook);
void                gimp_dock_temp_add                  (GimpDock *dock,
                                                         GtkWidget *widget);
void                gimp_dock_temp_remove               (GimpDock *dock,
                                                         GtkWidget *widget);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GimpDock
                                       +----GimpMenuDock
                                       +----GimpToolbox

Implemented Interfaces

GimpDock implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Style Properties

  "font-scale"               gdouble               : Read

Signals

  "book-added"                                     : Run First
  "book-removed"                                   : Run First
  "description-invalidated"                        : Run First
  "geometry-invalidated"                           : Run First

Description

Details

GIMP_DOCK_BOOK_SEPARATOR

#define GIMP_DOCK_BOOK_SEPARATOR C_("dock", " - ")


GIMP_DOCK_COLUMN_SEPARATOR

#define GIMP_DOCK_COLUMN_SEPARATOR C_("dock", " | ")


GIMP_DOCK_DOCKABLE_SEPARATOR

#define GIMP_DOCK_DOCKABLE_SEPARATOR C_("dock", ", ")


GimpDock

typedef struct _GimpDock GimpDock;

Contains a column of GimpDockbooks.


GimpDockPrivate

typedef struct _GimpDockPrivate GimpDockPrivate;


gimp_dock_get_description ()

gchar *             gimp_dock_get_description           (GimpDock *dock,
                                                         gboolean complete);

complete :

If TRUE, only includes the active dockables, i.e. not the dockables in a non-active GtkNotebook tab

Returns :

A string describing the contents of the dock.

gimp_dock_set_host_geometry_hints ()

void                gimp_dock_set_host_geometry_hints   (GimpDock *dock,
                                                         GtkWindow *window);

Some docks have some specific needs on the GtkWindow they are in. This function allows such docks to perform any such setup on the GtkWindow they are in/will be put in.

dock :

The dock

window :

The GtkWindow to adapt to hosting the dock

gimp_dock_invalidate_geometry ()

void                gimp_dock_invalidate_geometry       (GimpDock *dock);

Call when the dock needs to setup its host GtkWindow with GtkDock::set_host_geometry_hints().


gimp_dock_update_with_context ()

void                gimp_dock_update_with_context       (GimpDock *dock,
                                                         GimpContext *context);

Set the context on all dockables in the dock.


gimp_dock_get_context ()

GimpContext *       gimp_dock_get_context               (GimpDock *dock);

Returns :

The GimpContext for the GimpDockWindow the dock is in.

gimp_dock_get_dialog_factory ()

GimpDialogFactory * gimp_dock_get_dialog_factory        (GimpDock *dock);

Returns :

The GimpDialogFactory for the GimpDockWindow the dock is in.

gimp_dock_get_ui_manager ()

GimpUIManager *     gimp_dock_get_ui_manager            (GimpDock *dock);

Returns :

The GimpUIManager for the GimpDockWindow the dock is in.

gimp_dock_get_dockbooks ()

GList *             gimp_dock_get_dockbooks             (GimpDock *dock);


gimp_dock_get_n_dockables ()

gint                gimp_dock_get_n_dockables           (GimpDock *dock);


gimp_dock_get_main_vbox ()

GtkWidget *         gimp_dock_get_main_vbox             (GimpDock *dock);


gimp_dock_get_vbox ()

GtkWidget *         gimp_dock_get_vbox                  (GimpDock *dock);


gimp_dock_get_id ()

gint                gimp_dock_get_id                    (GimpDock *dock);


gimp_dock_set_id ()

void                gimp_dock_set_id                    (GimpDock *dock,
                                                         gint ID);


gimp_dock_add ()

void                gimp_dock_add                       (GimpDock *dock,
                                                         GimpDockable *dockable,
                                                         gint book,
                                                         gint index);


gimp_dock_remove ()

void                gimp_dock_remove                    (GimpDock *dock,
                                                         GimpDockable *dockable);


gimp_dock_add_book ()

void                gimp_dock_add_book                  (GimpDock *dock,
                                                         GimpDockbook *dockbook,
                                                         gint index);


gimp_dock_remove_book ()

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


gimp_dock_temp_add ()

void                gimp_dock_temp_add                  (GimpDock *dock,
                                                         GtkWidget *widget);

Method to temporarily add a widget to the dock, for example to make font-scale style property to be applied temporarily to the child.


gimp_dock_temp_remove ()

void                gimp_dock_temp_remove               (GimpDock *dock,
                                                         GtkWidget *widget);

Removes a temporarly child added with gimp_dock_temp_add().

Style Property Details

The "font-scale" style property

  "font-scale"               gdouble               : Read

Allowed values: >= 0

Default value: 0.833333

Signal Details

The "book-added" signal

void                user_function                      (GimpDock     *gimpdock,
                                                        GimpDockbook *arg1,
                                                        gpointer      user_data)      : Run First

gimpdock :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "book-removed" signal

void                user_function                      (GimpDock     *gimpdock,
                                                        GimpDockbook *arg1,
                                                        gpointer      user_data)      : Run First

gimpdock :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "description-invalidated" signal

void                user_function                      (GimpDock *gimpdock,
                                                        gpointer  user_data)      : Run First

gimpdock :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "geometry-invalidated" signal

void                user_function                      (GimpDock *gimpdock,
                                                        gpointer  user_data)      : Run First

gimpdock :

the object which received the signal.

user_data :

user data set when the signal handler was connected.