GDL_DOCK_OBJECT_ATTACHED()

#define GDL_DOCK_OBJECT_ATTACHED(obj) (!gdl_dock_object_is_closed(GDL_DOCK_OBJECT (obj)))

Evaluates to TRUE if the object has a parent.

GDL_DOCK_OBJECT_AUTOMATIC()

#define GDL_DOCK_OBJECT_AUTOMATIC(obj) gdl_dock_object_is_automatic (GDL_DOCK_OBJECT (obj))

Evaluates to TRUE if the object's lifecycle is entirely managed by the dock master.

GDL_DOCK_OBJECT_FLAGS()

#define GDL_DOCK_OBJECT_FLAGS(obj)  (GDL_DOCK_OBJECT (obj)->deprecated_flags)

Get all flags of GdlDockObject.

GDL_DOCK_OBJECT_FROZEN()

#define GDL_DOCK_OBJECT_FROZEN(obj) gdl_dock_object_is_frozen(GDL_DOCK_OBJECT (obj))

Evaluates to TRUE if the object is frozen.

GDL_DOCK_OBJECT_IN_DETACH()

#define             GDL_DOCK_OBJECT_IN_DETACH(obj)

Evaluates to TRUE if the object will be detached.

GDL_DOCK_OBJECT_IN_REFLOW()

#define             GDL_DOCK_OBJECT_IN_REFLOW(obj)

Evaluates to TRUE if the object is currently rearranged.

GDL_DOCK_OBJECT_SET_FLAGS()

#define             GDL_DOCK_OBJECT_SET_FLAGS(obj,flag)

Set one or more flags of a dock object.

GDL_DOCK_OBJECT_UNSET_FLAGS()

#define             GDL_DOCK_OBJECT_UNSET_FLAGS(obj,flag)

Clear one or more flags of a dock object.

GDL_TRACE_OBJECT()

#define             GDL_TRACE_OBJECT(object, format, args...)

Output a debugging message for the corresponding dock object.

gdl_dock_object_bind ()

void
gdl_dock_object_bind (GdlDockObject *object,
                      GObject *master);

Add a link between a GdlDockObject and a master. It is normally not used directly because it is automatically called when a new object is docked.

gdl_dock_object_child_placement ()

gboolean
gdl_dock_object_child_placement (GdlDockObject *object,
                                 GdlDockObject *child,
                                 GdlDockPlacement *placement);

This function returns information about placement of a child dock object inside another dock object. The function returns TRUE if child is effectively a child of object . placement should normally be initially setup to GDL_DOCK_NONE. If it's set to some other value, this function will not touch the stored value if the specified placement is "compatible" with the actual placement of the child.

placement can be NULL, in which case the function simply tells if child is attached to object .

gdl_dock_object_detach ()

void
gdl_dock_object_detach (GdlDockObject *object,
                        gboolean recursive);

Dissociate a dock object from its parent, including or not its children.

gdl_dock_object_dock ()

void
gdl_dock_object_dock (GdlDockObject *object,
                      GdlDockObject *requestor,
                      GdlDockPlacement position,
                      GValue *other_data);

Dock a dock widget in object at the defined position.

gdl_dock_object_dock_request ()

gboolean
gdl_dock_object_dock_request (GdlDockObject *object,
                              gint x,
                              gint y,
                              GdlDockRequest *request);

Dock a dock widget in object at the defined position.

gdl_dock_object_freeze ()

void
gdl_dock_object_freeze (GdlDockObject *object);

Temporarily freezes a dock object, any call to reduce on the object has no immediate effect. If gdl_dock_object_freeze() has been called more than once, gdl_dock_object_thaw() must be called an equal number of times.

gdl_dock_object_get_parent_object ()

GdlDockObject *
gdl_dock_object_get_parent_object (GdlDockObject *object);

Returns a parent GdlDockObject if it exists.

gdl_dock_object_is_bound ()

gboolean
gdl_dock_object_is_bound (GdlDockObject *object);

Check if the object is bound to a master.

gdl_dock_object_is_compound ()

gboolean
gdl_dock_object_is_compound (GdlDockObject *object);

Check if an object is a compound object, accepting children widget or not.

gdl_dock_object_nick_from_type ()

const gchar *
gdl_dock_object_nick_from_type (GType type);

Finds the nickname for a given type

gdl_dock_object_present ()

void
gdl_dock_object_present (GdlDockObject *object,
                         GdlDockObject *child);

Presents the GDL object to the user. By example, this will select the corresponding page if the object is in a notebook. If child is missing, only the object will be show.

gdl_dock_object_reduce ()

void
gdl_dock_object_reduce (GdlDockObject *object);

Remove a compound object if it is not longer useful to hold the child. The object has to be removed and the child reattached to the parent.

gdl_dock_object_reorder ()

gboolean
gdl_dock_object_reorder (GdlDockObject *object,
                         GdlDockObject *child,
                         GdlDockPlacement new_position,
                         GValue *other_data);

Move the child widget at another place.

gdl_dock_object_set_type_for_nick ()

GType
gdl_dock_object_set_type_for_nick (const gchar *nick,
                                   GType type);

Assigns an object type to a given nickname. If the nickname already exists, then it reassigns it to a new object type.

gdl_dock_object_thaw ()

void
gdl_dock_object_thaw (GdlDockObject *object);

Thaws a dock object frozen with gdl_dock_object_freeze(). Any pending reduce calls are made, maybe leading to the destruction of the object.

gdl_dock_object_type_from_nick ()

GType
gdl_dock_object_type_from_nick (const gchar *nick);

Finds the object type assigned to a given nickname.

gdl_dock_object_unbind ()

void
gdl_dock_object_unbind (GdlDockObject *object);

This removes the link between an dock object and its master.

GDL_DOCK_OBJECT_FLAGS_SHIFT

#define GDL_DOCK_OBJECT_FLAGS_SHIFT 8

Minimum shift count to be used for user defined flags, to be stored in GdlDockObject.flags.

struct GdlDockObject

struct GdlDockObject;

struct GdlDockObjectClass

struct GdlDockObjectClass {
    GtkContainerClass parent_class;

    GdlDockObjectClassPrivate *priv;

    void     (* detach)          (GdlDockObject    *object,
                                  gboolean          recursive);
    void     (* reduce)          (GdlDockObject    *object);

    gboolean (* dock_request)    (GdlDockObject    *object,
                                  gint              x,
                                  gint              y,
                                  GdlDockRequest   *request);

    void     (* dock)            (GdlDockObject    *object,
                                  GdlDockObject    *requestor,
                                  GdlDockPlacement  position,
                                  GValue           *other_data);

    gboolean (* reorder)         (GdlDockObject    *object,
                                  GdlDockObject    *child,
                                  GdlDockPlacement  new_position,
                                  GValue           *other_data);

    void     (* present)         (GdlDockObject    *object,
                                  GdlDockObject    *child);

    gboolean (* child_placement) (GdlDockObject    *object,
                                  GdlDockObject    *child,
                                  GdlDockPlacement *placement);
};

enum GdlDockObjectFlags

Described the state of a GdlDockObject.

Since 3.6: These flags are available using access function, like gdl_dock_object_is_automatic() or gdl_dock_object_is_closed().

enum GdlDockParamFlags

Used to flag additional characteristics to GObject properties used in dock object.

enum GdlDockPlacement

Described the docking position.

struct GdlDockRequest

struct GdlDockRequest {
    GdlDockObject               *applicant;
    GdlDockObject               *target;
    GdlDockPlacement            position;
    cairo_rectangle_int_t       rect;
    GValue                      extra;
};

Full docking information.

The “long-name” property

  “long-name”                char *

A long descriptive name.

Owner: GdlDockObject

Flags: Read / Write / Construct

Default value: NULL

The “master” property

  “master”                   GdlDockMaster *

The master which manages all the objects in a dock ring

Owner: GdlDockObject

Flags: Read / Write / Construct

The “name” property

  “name”                     char *

The object name. If the object is manual the name can be used to recall the object from any other object in the ring

Owner: GdlDockObject

Flags: Read / Write / Construct Only

Default value: NULL

The “pixbuf-icon” property

  “pixbuf-icon”              gpointer

A GdkPixbuf to use for the icon of the dock object.

Owner: GdlDockObject

Flags: Read / Write

Since: 3.3.2

The “stock-id” property

  “stock-id”                 char *

A stock id to use for the icon of the dock object.

Owner: GdlDockObject

Flags: Read / Write / Construct

Default value: NULL

The “detach” signal

void
user_function (GdlDockObject *item,
               gboolean       recursive,
               gpointer       user_data)

Signals that the GdlDockObject is detached.

Flags: Run Last

The “dock” signal

void
user_function (GdlDockObject   *item,
               GdlDockObject   *requestor,
               GdlDockPlacement position,
               GValue          *other_data,
               gpointer         user_data)

Signals that the GdlDockObject has been docked.

Flags: Run First