GimpDockWindow

GimpDockWindow

Synopsis

                    GimpDockWindow;
                    GimpDockWindowPrivate;
GtkWidget *         gimp_dock_window_new                (const gchar *role,
                                                         const gchar *ui_manager_name,
                                                         gboolean allow_dockbook_absence,
                                                         GimpDialogFactory *factory,
                                                         GimpContext *context);
gint                gimp_dock_window_get_id             (GimpDockWindow *dock_window);
void                gimp_dock_window_add_dock           (GimpDockWindow *dock_window,
                                                         GimpDock *dock,
                                                         gint index);
void                gimp_dock_window_remove_dock        (GimpDockWindow *dock_window,
                                                         GimpDock *dock);
GimpContext *       gimp_dock_window_get_context        (GimpDockWindow *dock);
GimpDialogFactory * gimp_dock_window_get_dialog_factory (GimpDockWindow *dock);
gboolean            gimp_dock_window_get_auto_follow_active
                                                        (GimpDockWindow *menu_dock);
void                gimp_dock_window_set_auto_follow_active
                                                        (GimpDockWindow *menu_dock,
                                                         gboolean show);
gboolean            gimp_dock_window_get_show_image_menu
                                                        (GimpDockWindow *menu_dock);
void                gimp_dock_window_set_show_image_menu
                                                        (GimpDockWindow *menu_dock,
                                                         gboolean show);
void                gimp_dock_window_setup              (GimpDockWindow *dock_window,
                                                         GimpDockWindow *template);
gboolean            gimp_dock_window_has_toolbox        (GimpDockWindow *dock_window);
GimpDockWindow *    gimp_dock_window_from_dock          (GimpDock *dock);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GimpWindow
                                             +----GimpDockWindow

Implemented Interfaces

GimpDockWindow implements AtkImplementorIface, GtkBuildable, GimpDockContainerInterface and GimpSessionManagedInterface.

Properties

  "allow-dockbook-absence"   gboolean              : Read / Write / Construct Only
  "context"                  GimpContext*          : Read / Write / Construct Only
  "dialog-factory"           GimpDialogFactory*    : Read / Write / Construct Only
  "display-container"        GimpContainer*        : Read / Write / Construct Only
  "image-container"          GimpContainer*        : Read / Write / Construct Only
  "ui-manager-name"          gchar*                : Read / Write / Construct Only

Style Properties

  "default-height"           gint                  : Read
  "menu-preview-size"        GtkIconSize           : Read

Description

Details

GimpDockWindow

typedef struct _GimpDockWindow GimpDockWindow;

A top-level window containing GimpDocks.


GimpDockWindowPrivate

typedef struct _GimpDockWindowPrivate GimpDockWindowPrivate;


gimp_dock_window_new ()

GtkWidget *         gimp_dock_window_new                (const gchar *role,
                                                         const gchar *ui_manager_name,
                                                         gboolean allow_dockbook_absence,
                                                         GimpDialogFactory *factory,
                                                         GimpContext *context);


gimp_dock_window_get_id ()

gint                gimp_dock_window_get_id             (GimpDockWindow *dock_window);


gimp_dock_window_add_dock ()

void                gimp_dock_window_add_dock           (GimpDockWindow *dock_window,
                                                         GimpDock *dock,
                                                         gint index);


gimp_dock_window_remove_dock ()

void                gimp_dock_window_remove_dock        (GimpDockWindow *dock_window,
                                                         GimpDock *dock);


gimp_dock_window_get_context ()

GimpContext *       gimp_dock_window_get_context        (GimpDockWindow *dock);


gimp_dock_window_get_dialog_factory ()

GimpDialogFactory * gimp_dock_window_get_dialog_factory (GimpDockWindow *dock);


gimp_dock_window_get_auto_follow_active ()

gboolean            gimp_dock_window_get_auto_follow_active
                                                        (GimpDockWindow *menu_dock);


gimp_dock_window_set_auto_follow_active ()

void                gimp_dock_window_set_auto_follow_active
                                                        (GimpDockWindow *menu_dock,
                                                         gboolean show);


gimp_dock_window_get_show_image_menu ()

gboolean            gimp_dock_window_get_show_image_menu
                                                        (GimpDockWindow *menu_dock);


gimp_dock_window_set_show_image_menu ()

void                gimp_dock_window_set_show_image_menu
                                                        (GimpDockWindow *menu_dock,
                                                         gboolean show);


gimp_dock_window_setup ()

void                gimp_dock_window_setup              (GimpDockWindow *dock_window,
                                                         GimpDockWindow *template);


gimp_dock_window_has_toolbox ()

gboolean            gimp_dock_window_has_toolbox        (GimpDockWindow *dock_window);

Returns :

TRUE if the dock window has a GimpToolbox dock, FALSE otherwise.

gimp_dock_window_from_dock ()

GimpDockWindow *    gimp_dock_window_from_dock          (GimpDock *dock);

For convenience.

Returns :

If the toplevel widget for the dock is a GimpDockWindow, return that. Otherwise return NULL.

Property Details

The "allow-dockbook-absence" property

  "allow-dockbook-absence"   gboolean              : Read / Write / Construct Only

Default value: FALSE


The "context" property

  "context"                  GimpContext*          : Read / Write / Construct Only


The "dialog-factory" property

  "dialog-factory"           GimpDialogFactory*    : Read / Write / Construct Only


The "display-container" property

  "display-container"        GimpContainer*        : Read / Write / Construct Only


The "image-container" property

  "image-container"          GimpContainer*        : Read / Write / Construct Only


The "ui-manager-name" property

  "ui-manager-name"          gchar*                : Read / Write / Construct Only

Default value: NULL

Style Property Details

The "default-height" style property

  "default-height"           gint                  : Read

Allowed values: >= -1

Default value: 300


The "menu-preview-size" style property

  "menu-preview-size"        GtkIconSize           : Read

Default value: GTK_ICON_SIZE_SMALL_TOOLBAR