GimpImageWindow

GimpImageWindow

Synopsis

                    GimpImageWindow;
struct              GimpImageWindowClass;
void                gimp_image_window_add_shell         (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);
void                gimp_image_window_destroy           (GimpImageWindow *window);
GimpDisplayShell *  gimp_image_window_get_active_shell  (GimpImageWindow *window);
GtkWidget *         gimp_image_window_get_default_dockbook
                                                        (GimpImageWindow *window);
gboolean            gimp_image_window_get_fullscreen    (GimpImageWindow *window);
GimpDockColumns *   gimp_image_window_get_left_docks    (GimpImageWindow *window);
gint                gimp_image_window_get_n_shells      (GimpImageWindow *window);
GimpDockColumns *   gimp_image_window_get_right_docks   (GimpImageWindow *window);
GimpDisplayShell *  gimp_image_window_get_shell         (GimpImageWindow *window,
                                                         gint index);
gboolean            gimp_image_window_get_show_menubar  (GimpImageWindow *window);
gboolean            gimp_image_window_get_show_statusbar
                                                        (GimpImageWindow *window);
GimpUIManager *     gimp_image_window_get_ui_manager    (GimpImageWindow *window);
gboolean            gimp_image_window_has_toolbox       (GimpImageWindow *window);
gboolean            gimp_image_window_is_iconified      (GimpImageWindow *window);
void                gimp_image_window_keep_canvas_pos   (GimpImageWindow *window);
GimpImageWindow *   gimp_image_window_new               (Gimp *gimp,
                                                         GimpImage *image,
                                                         GimpMenuFactory *menu_factory,
                                                         GimpDialogFactory *dialog_factory);
void                gimp_image_window_remove_shell      (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);
void                gimp_image_window_set_active_shell  (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);
void                gimp_image_window_set_fullscreen    (GimpImageWindow *window,
                                                         gboolean fullscreen);
void                gimp_image_window_set_show_menubar  (GimpImageWindow *window,
                                                         gboolean show);
void                gimp_image_window_set_show_statusbar
                                                        (GimpImageWindow *window,
                                                         gboolean show);
void                gimp_image_window_shrink_wrap       (GimpImageWindow *window,
                                                         gboolean grow_only);

Object Hierarchy

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

Implemented Interfaces

GimpImageWindow implements AtkImplementorIface, GtkBuildable, GimpDockContainerInterface and GimpSessionManagedInterface.

Properties

  "dialog-factory"           GimpDialogFactory*    : Read / Write / Construct Only
  "gimp"                     Gimp*                 : Write / Construct Only
  "menu-factory"             GimpMenuFactory*      : Write / Construct Only

Description

Details

GimpImageWindow

typedef struct _GimpImageWindow GimpImageWindow;


struct GimpImageWindowClass

struct GimpImageWindowClass {
  GimpWindowClass  parent_class;
};


gimp_image_window_add_shell ()

void                gimp_image_window_add_shell         (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);


gimp_image_window_destroy ()

void                gimp_image_window_destroy           (GimpImageWindow *window);


gimp_image_window_get_active_shell ()

GimpDisplayShell *  gimp_image_window_get_active_shell  (GimpImageWindow *window);


gimp_image_window_get_default_dockbook ()

GtkWidget *         gimp_image_window_get_default_dockbook
                                                        (GimpImageWindow *window);

Gets the default dockbook, which is the dockbook in which new dockables should be put in single-window mode.

Returns :

The default dockbook for new dockables, or NULL if no dockbook were avaialble.

gimp_image_window_get_fullscreen ()

gboolean            gimp_image_window_get_fullscreen    (GimpImageWindow *window);


gimp_image_window_get_left_docks ()

GimpDockColumns *   gimp_image_window_get_left_docks    (GimpImageWindow *window);


gimp_image_window_get_n_shells ()

gint                gimp_image_window_get_n_shells      (GimpImageWindow *window);


gimp_image_window_get_right_docks ()

GimpDockColumns *   gimp_image_window_get_right_docks   (GimpImageWindow *window);


gimp_image_window_get_shell ()

GimpDisplayShell *  gimp_image_window_get_shell         (GimpImageWindow *window,
                                                         gint index);


gimp_image_window_get_show_menubar ()

gboolean            gimp_image_window_get_show_menubar  (GimpImageWindow *window);


gimp_image_window_get_show_statusbar ()

gboolean            gimp_image_window_get_show_statusbar
                                                        (GimpImageWindow *window);


gimp_image_window_get_ui_manager ()

GimpUIManager *     gimp_image_window_get_ui_manager    (GimpImageWindow *window);


gimp_image_window_has_toolbox ()

gboolean            gimp_image_window_has_toolbox       (GimpImageWindow *window);

Returns :

TRUE if the image window contains a GimpToolbox.

gimp_image_window_is_iconified ()

gboolean            gimp_image_window_is_iconified      (GimpImageWindow *window);


gimp_image_window_keep_canvas_pos ()

void                gimp_image_window_keep_canvas_pos   (GimpImageWindow *window);

Stores the coordinates of the current image canvas origin relatively its GtkWindow; and on the first size-allocate sets the offsets in the shell so that the image origin remains the same (even on another GtkWindow).

Example use case: The user hides docks attached to the side of image windows. You want the image to remain fixed on the screen though, so you use this function to keep the image fixed after the docks have been hidden.


gimp_image_window_new ()

GimpImageWindow *   gimp_image_window_new               (Gimp *gimp,
                                                         GimpImage *image,
                                                         GimpMenuFactory *menu_factory,
                                                         GimpDialogFactory *dialog_factory);


gimp_image_window_remove_shell ()

void                gimp_image_window_remove_shell      (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);


gimp_image_window_set_active_shell ()

void                gimp_image_window_set_active_shell  (GimpImageWindow *window,
                                                         GimpDisplayShell *shell);


gimp_image_window_set_fullscreen ()

void                gimp_image_window_set_fullscreen    (GimpImageWindow *window,
                                                         gboolean fullscreen);


gimp_image_window_set_show_menubar ()

void                gimp_image_window_set_show_menubar  (GimpImageWindow *window,
                                                         gboolean show);


gimp_image_window_set_show_statusbar ()

void                gimp_image_window_set_show_statusbar
                                                        (GimpImageWindow *window,
                                                         gboolean show);


gimp_image_window_shrink_wrap ()

void                gimp_image_window_shrink_wrap       (GimpImageWindow *window,
                                                         gboolean grow_only);

Property Details

The "dialog-factory" property

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


The "gimp" property

  "gimp"                     Gimp*                 : Write / Construct Only


The "menu-factory" property

  "menu-factory"             GimpMenuFactory*      : Write / Construct Only