app: Add some comments on classes used for the dock system

This commit is contained in:
Martin Nordholts 2009-09-05 23:50:01 +02:00
parent af3e894844
commit 04ef83c795
6 changed files with 22 additions and 0 deletions

View File

@ -36,6 +36,9 @@
typedef struct _GimpDockClass GimpDockClass; typedef struct _GimpDockClass GimpDockClass;
typedef struct _GimpDockPriv GimpDockPriv; typedef struct _GimpDockPriv GimpDockPriv;
/**
* A top-level window containing GimpDockbooks.
*/
struct _GimpDock struct _GimpDock
{ {
GimpWindow parent_instance; GimpWindow parent_instance;

View File

@ -35,6 +35,11 @@
typedef struct _GimpDockableClass GimpDockableClass; typedef struct _GimpDockableClass GimpDockableClass;
/**
* A kind of adpater to make other widgets dockable. The widget to
* dock is put inside the GimpDockable, which is put in a
* GimpDockbook.
*/
struct _GimpDockable struct _GimpDockable
{ {
GtkBin parent_instance; GtkBin parent_instance;

View File

@ -32,6 +32,10 @@
typedef struct _GimpDockbookClass GimpDockbookClass; typedef struct _GimpDockbookClass GimpDockbookClass;
/**
* Holds GimpDockables which are presented on different tabs using
* GtkNotebook.
*/
struct _GimpDockbook struct _GimpDockbook
{ {
GtkNotebook parent_instance; GtkNotebook parent_instance;

View File

@ -30,6 +30,9 @@
typedef struct _GimpDockedInterface GimpDockedInterface; typedef struct _GimpDockedInterface GimpDockedInterface;
/**
* Interface with common methods for stuff that is docked.
*/
struct _GimpDockedInterface struct _GimpDockedInterface
{ {
GTypeInterface base_iface; GTypeInterface base_iface;

View File

@ -32,6 +32,10 @@
typedef struct _GimpDockSeparatorClass GimpDockSeparatorClass; typedef struct _GimpDockSeparatorClass GimpDockSeparatorClass;
/**
* Separates dockable and acts as drop-targets to allow rearrangements
* of them.
*/
struct _GimpDockSeparator struct _GimpDockSeparator
{ {
GtkEventBox parent_instance; GtkEventBox parent_instance;

View File

@ -35,6 +35,9 @@
typedef struct _GimpImageDockClass GimpImageDockClass; typedef struct _GimpImageDockClass GimpImageDockClass;
/**
* Adds some GimpImage specific hooks and logic to GimpDock.
*/
struct _GimpImageDock struct _GimpImageDock
{ {
GimpDock parent_instance; GimpDock parent_instance;