GdlDockPlaceHolder

GdlDockPlaceHolder — A widget marking a docking place.

Stability Level

Unstable, unless otherwise indicated

Synopsis

struct              GdlDockPlaceholder;
GtkWidget *         gdl_dock_placeholder_new            (const gchar *name,
                                                         GdlDockObject *object,
                                                         GdlDockPlacement position,
                                                         gboolean sticky);
void                gdl_dock_placeholder_attach         (GdlDockPlaceholder *ph,
                                                         GdlDockObject *object);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GdlDockObject
                           +----GdlDockPlaceholder

Implemented Interfaces

GdlDockPlaceholder implements AtkImplementorIface and GtkBuildable.

Properties

  "floating"                 gboolean              : Read / Write / Construct Only
  "floatx"                   gint                  : Read / Write / Construct Only
  "floaty"                   gint                  : Read / Write / Construct Only
  "height"                   gint                  : Read / Write / Construct
  "host"                     GdlDockObject*        : Read / Write
  "next-placement"           GdlDockPlacement      : Read / Write
  "sticky"                   gboolean              : Read / Write / Construct Only
  "width"                    gint                  : Read / Write / Construct

Description

A dock placeholder is a widget allowing to keep track of a docking place. Unfortunately, all the details of the initial goal have been forgotten and the code has still some issues.

In GDL 3.6, this part has been deprecated. Placeholder widgets are not used anymore. Instead, closed widgets are hidden but kept in the widget hierarchy.

Details

struct GdlDockPlaceholder

struct GdlDockPlaceholder;

Warning

GdlDockPlaceholder is deprecated and should not be used in newly-written code.

gdl_dock_placeholder_new ()

GtkWidget *         gdl_dock_placeholder_new            (const gchar *name,
                                                         GdlDockObject *object,
                                                         GdlDockPlacement position,
                                                         gboolean sticky);

Warning

gdl_dock_placeholder_new has been deprecated since version 3.6 and should not be used in newly-written code.

Creates a new dock placeholder at object place. This is a kind of marker allowing you to dock new items later at this place. It is not completely working though.

name :

 Unique name for identifying the dock object.

object :

 Corresponding GdlDockObject

position :

 The position to dock a new item in object

sticky :

 TRUE if the placeholder move with the object

Returns :

 The newly created placeholder.

gdl_dock_placeholder_attach ()

void                gdl_dock_placeholder_attach         (GdlDockPlaceholder *ph,
                                                         GdlDockObject *object);

Warning

gdl_dock_placeholder_attach has been deprecated since version 3.6 and should not be used in newly-written code.

Move the placeholder to the position of object.

ph :

 The GdlDockPlaceholder object

object :

 A new GdlDockObject

Property Details

The "floating" property

  "floating"                 gboolean              : Read / Write / Construct Only

Whether the placeholder is standing in for a floating toplevel dock.

Default value: FALSE

The "floatx" property

  "floatx"                   gint                  : Read / Write / Construct Only

X coordinate for dock when floating.

Allowed values: >= G_MAXULONG

Default value: -1

The "floaty" property

  "floaty"                   gint                  : Read / Write / Construct Only

Y coordinate for dock when floating.

Allowed values: >= G_MAXULONG

Default value: -1

The "height" property

  "height"                   gint                  : Read / Write / Construct

Height for the widget when it's attached to the placeholder.

Allowed values: >= G_MAXULONG

Default value: -1

The "host" property

  "host"                     GdlDockObject*        : Read / Write

The dock object this placeholder is attached to.

The "next-placement" property

  "next-placement"           GdlDockPlacement      : Read / Write

The position an item will be docked to our host if a request is made to dock to us.

Default value: GDL_DOCK_CENTER

The "sticky" property

  "sticky"                   gboolean              : Read / Write / Construct Only

Whether the placeholder will stick to its host or move up the hierarchy when the host is redocked.

Default value: FALSE

The "width" property

  "width"                    gint                  : Read / Write / Construct

Width for the widget when it's attached to the placeholder.

Allowed values: >= G_MAXULONG

Default value: -1

Generated by GTK-Doc V1.18