2009-10-25 19:12:43 +08:00
|
|
|
GIMP UI Framework
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
This document describes how the GIMP UI framework functions and is
|
|
|
|
|
implemented. Here, "UI framework" refers to the system that saves the
|
|
|
|
|
UI layout between GIMP sessions, i.e. how docks, dockable dialogs etc
|
|
|
|
|
are setup.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Key Classes
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
GimpDockable - Represents a dockable dialog.
|
|
|
|
|
GimpDockbook - A GtkNotebook of GimpDockables
|
|
|
|
|
GimpDock - A columns of GimpDockbooks
|
2009-12-21 03:43:57 +08:00
|
|
|
GimpToolbox - Subclasses GimpDock, contains the toolbox.
|
|
|
|
|
Dockables are added at the bottom
|
|
|
|
|
GimpMenuDock - Subclasses GimpDock, contains dockables, should
|
|
|
|
|
probably be merged with GimpDock. The name
|
|
|
|
|
contains "menu" from the time when it hosted the
|
|
|
|
|
Image Selection Menu that is now in the
|
|
|
|
|
GimpDockWindow
|
2009-10-25 19:12:43 +08:00
|
|
|
GimpDockColumns - A set of GimpDocks arranged side by side.
|
|
|
|
|
GimpDockWindow - A toplevel window containing a GimpDockColumns.
|
|
|
|
|
GimpImageWindow - A toplevel window containing images and one
|
|
|
|
|
GimpDockColumns to the left and to the right.
|
|
|
|
|
GimpDialogFactory - A factory to create and position toplevel windows
|
|
|
|
|
GimpSessionInfo - Contains session info for one toplevel
|
|
|
|
|
GimpUIConfigurer - Configures the UI when switching between
|
|
|
|
|
single-window and multi-window mode
|
|
|
|
|
|
2010-01-17 07:01:35 +08:00
|
|
|
|
|
|
|
|
GimpDialogFactory
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
The GimpDialogFactory can be considered to solve two distinct
|
|
|
|
|
problems:
|
|
|
|
|
|
|
|
|
|
1. Create widgets from text, in particular from text in sessionrc
|
2018-04-19 02:57:03 +08:00
|
|
|
2. Session manage toplevel windows so their position is remembered
|
2010-01-17 07:01:35 +08:00
|
|
|
across GIMP sessions
|
|
|
|
|
|
|
|
|
|
One possible design adjustment would be to have GimpWidgetFactory that
|
|
|
|
|
takes care of 1), and then have GimpDialogFactory inherit from
|
|
|
|
|
GtkWidgetFactory and implementing 2). GimpWidgetFactory could possibly
|
|
|
|
|
use GtkBuilder.
|
2010-01-18 03:08:32 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
sessionrc
|
|
|
|
|
---------
|
|
|
|
|
When GIMP starts, the sessionrc file is parsed. This step puts
|
|
|
|
|
GimpSessionInfo:s into GimpDialogFactories. Later when dialogs are
|
|
|
|
|
created, the dialog factory looks up existing session info entries. If
|
|
|
|
|
one exists, it uses the session info to set e.g. the position of the
|
|
|
|
|
created dialog. If it doesn't exist, it creates a new session info
|
|
|
|
|
object for the dialog. When GIMP exists, the current session infos are
|
|
|
|
|
then written back to sessionrc.
|
