Height for width geometry management

CTK+ uses a height-for-width (and width-for-height) geometry management system. Height-for-width means that a widget can change how much vertical space it needs, depending on the amount of horizontal space that it is given (and similar for width-for-height).

There are some things to keep in mind when implementing container widgets that make use of CTK+’s height for width geometry management system. First, it’s important to note that a container must prioritize one of its dimensions, that is to say that a widget or container can only have a CtkSizeRequestMode that is CTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or CTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. However, every widget and container must be able to respond to the APIs for both dimensions, i.e. even if a widget has a request mode that is height-for-width, it is possible that its parent will request its sizes using the width-for-height APIs.

To ensure that everything works properly, here are some guidelines to follow when implementing height-for-width (or width-for-height) containers.

Each request mode involves 2 virtual methods. Height-for-width apis run through ctk_widget_get_preferred_width() and then through ctk_widget_get_preferred_height_for_width(). When handling requests in the opposite CtkSizeRequestMode it is important that every widget request at least enough space to display all of its content at all times.

When ctk_widget_get_preferred_height() is called on a container that is height-for-width, the container must return the height for its minimum width. This is easily achieved by simply calling the reverse apis implemented for itself as follows:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

static void
foo_container_get_preferred_height (CtkWidget *widget,
                                    gint *min_height,
                                    gint *nat_height)
{
   if (i_am_in_height_for_width_mode)
     {
       gint min_width;

       CTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget,
                                                           &min_width,
                                                           NULL);
       CTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width
                                                          (widget,
                                                           min_width,
                                                           min_height,
                                                           nat_height);
     }
   else
     {
       ... many containers support both request modes, execute the
       real width-for-height request here by returning the
       collective heights of all widgets that are stacked
       vertically (or whatever is appropriate for this container)
       ...
     }
}

Similarly, when ctk_widget_get_preferred_width_for_height() is called for a container or widget that is height-for-width, it then only needs to return the base minimum width like so:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

static void
foo_container_get_preferred_width_for_height (CtkWidget *widget,
                                              gint for_height,
                                              gint *min_width,
                                              gint *nat_width)
{
   if (i_am_in_height_for_width_mode)
     {
       CTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget,
                                                           min_width,
                                                           nat_width);
     }
   else
     {
       ... execute the real width-for-height request here based on
       the required width of the children collectively if the
       container were to be allocated the said height ...
     }
}

Height for width requests are generally implemented in terms of a virtual allocation of widgets in the input orientation. Assuming an height-for-width request mode, a container would implement the get_preferred_height_for_width() virtual function by first calling ctk_widget_get_preferred_width() for each of its children.

For each potential group of children that are lined up horizontally, the values returned by ctk_widget_get_preferred_width() should be collected in an array of CtkRequestedSize structures. Any child spacing should be removed from the input for_width and then the collective size should be allocated using the ctk_distribute_natural_allocation() convenience function.

The container will then move on to request the preferred height for each child by using ctk_widget_get_preferred_height_for_width() and using the sizes stored in the CtkRequestedSize array.

To allocate a height-for-width container, it’s again important to consider that a container must prioritize one dimension over the other. So if a container is a height-for-width container it must first allocate all widgets horizontally using a CtkRequestedSize array and ctk_distribute_natural_allocation() and then add any extra space (if and where appropriate) for the widget to expand.

After adding all the expand space, the container assumes it was allocated sufficient height to fit all of its content. At this time, the container must use the total horizontal sizes of each widget to request the height-for-width of each of its children and store the requests in a CtkRequestedSize array for any widgets that stack vertically (for tabular containers this can be generalized into the heights and widths of rows and columns). The vertical space must then again be distributed using ctk_distribute_natural_allocation() while this time considering the allocated height of the widget minus any vertical spacing that the container adds. Then vertical expand space should be added where appropriate and available and the container should go on to actually allocating the child widgets.

See CtkWidget’s geometry management section to learn more about implementing height-for-width geometry management for widgets.

Child properties

CtkContainer introduces child properties. These are object properties that are not specific to either the container or the contained widget, but rather to their relation. Typical examples of child properties are the position or pack-type of a widget which is contained in a CtkBox.

Use ctk_container_class_install_child_property() to install child properties for a container class and ctk_container_class_find_child_property() or ctk_container_class_list_child_properties() to get information about existing child properties.

To set the value of a child property, use ctk_container_child_set_property(), ctk_container_child_set() or ctk_container_child_set_valist(). To obtain the value of a child property, use ctk_container_child_get_property(), ctk_container_child_get() or ctk_container_child_get_valist(). To emit notification about child property changes, use ctk_widget_child_notify().

CtkContainer as CtkBuildable

The CtkContainer implementation of the CtkBuildable interface supports a <packing> element for children, which can contain multiple <property> elements that specify child properties for the child.

Since 2.16, child properties can also be marked as translatable using the same “translatable”, “comments” and “context” attributes that are used for regular properties.

Since 3.16, containers can have a <focus-chain> element containing multiple <widget> elements, one for each child that should be added to the focus chain. The ”name” attribute gives the id of the widget.

An example of these properties in UI definitions:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

<object class="CtkBox">
  <child>
    <object class="CtkEntry" id="entry1"/>
    <packing>
      <property name="pack-type">start</property>
    </packing>
  </child>
  <child>
    <object class="CtkEntry" id="entry2"/>
  </child>
  <focus-chain>
    <widget name="entry1"/>
    <widget name="entry2"/>
  </focus-chain>
</object>

CTK_IS_RESIZE_CONTAINER()

#define             CTK_IS_RESIZE_CONTAINER(widget)

CTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID()

#define             CTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec)

This macro should be used to emit a standard warning about unexpected properties in set_child_property() and get_child_property() implementations.

ctk_container_add ()

void
ctk_container_add (CtkContainer *container,
                   CtkWidget *widget);

Adds widget to container . Typically used for simple containers such as CtkWindow, CtkFrame, or CtkButton; for more complicated layout containers such as CtkBox or CtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as ctk_box_pack_start() and ctk_grid_attach() as an alternative to ctk_container_add() in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.

Note that some containers, such as CtkScrolledWindow or CtkListBox, may add intermediate children between the added widget and the container.

ctk_container_remove ()

void
ctk_container_remove (CtkContainer *container,
                      CtkWidget *widget);

Removes widget from container . widget must be inside container . Note that container will own a reference to widget , and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using ctk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

ctk_container_add_with_properties ()

void
ctk_container_add_with_properties (CtkContainer *container,
                                   CtkWidget *widget,
                                   const gchar *first_prop_name,
                                   ...);

Adds widget to container , setting child properties at the same time. See ctk_container_add() and ctk_container_child_set() for more details.

ctk_container_get_resize_mode ()

CtkResizeMode
ctk_container_get_resize_mode (CtkContainer *container);

Returns the resize mode for the container. See ctk_container_set_resize_mode().

ctk_container_set_resize_mode ()

void
ctk_container_set_resize_mode (CtkContainer *container,
                               CtkResizeMode resize_mode);

Sets the resize mode for the container.

The resize mode of a container determines whether a resize request will be passed to the container’s parent, queued for later execution or executed immediately.

ctk_container_check_resize ()

void
ctk_container_check_resize (CtkContainer *container);

ctk_container_foreach ()

void
ctk_container_foreach (CtkContainer *container,
                       CtkCallback callback,
                       gpointer callback_data);

Invokes callback on each non-internal child of container . See ctk_container_forall() for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.

It is permissible to remove the child from the callback handler.

Most applications should use ctk_container_foreach(), rather than ctk_container_forall().

ctk_container_get_children ()

GList *
ctk_container_get_children (CtkContainer *container);

Returns the container’s non-internal children. See ctk_container_forall() for details on what constitutes an "internal" child.

ctk_container_get_path_for_child ()

CtkWidgetPath *
ctk_container_get_path_for_child (CtkContainer *container,
                                  CtkWidget *child);

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child .

ctk_container_set_reallocate_redraws ()

void
ctk_container_set_reallocate_redraws (CtkContainer *container,
                                      gboolean needs_redraws);

Sets the reallocate_redraws flag of the container to the given value.

Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

ctk_container_get_focus_child ()

CtkWidget *
ctk_container_get_focus_child (CtkContainer *container);

Returns the current focus child widget inside container . This is not the currently focused widget. That can be obtained by calling ctk_window_get_focus().

Since: 2.14

ctk_container_set_focus_child ()

void
ctk_container_set_focus_child (CtkContainer *container,
                               CtkWidget *child);

Sets, or unsets if child is NULL, the focused child of container .

This function emits the CtkContainer::set_focus_child signal of container . Implementations of CtkContainer can override the default behaviour by overriding the class closure of this signal.

This is function is mostly meant to be used by widgets. Applications can use ctk_widget_grab_focus() to manually set the focus to a specific widget.

ctk_container_get_focus_vadjustment ()

CtkAdjustment *
ctk_container_get_focus_vadjustment (CtkContainer *container);

Retrieves the vertical focus adjustment for the container. See ctk_container_set_focus_vadjustment().

ctk_container_set_focus_vadjustment ()

void
ctk_container_set_focus_vadjustment (CtkContainer *container,
                                     CtkAdjustment *adjustment);

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See ctk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and ctk_container_set_focus_hadjustment() for setting the horizontal adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

ctk_container_get_focus_hadjustment ()

CtkAdjustment *
ctk_container_get_focus_hadjustment (CtkContainer *container);

Retrieves the horizontal focus adjustment for the container. See ctk_container_set_focus_hadjustment().

ctk_container_set_focus_hadjustment ()

void
ctk_container_set_focus_hadjustment (CtkContainer *container,
                                     CtkAdjustment *adjustment);

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See ctk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and ctk_container_set_focus_vadjustment() for setting the vertical adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

ctk_container_resize_children ()

void
ctk_container_resize_children (CtkContainer *container);

ctk_container_child_type ()

GType
ctk_container_child_type (CtkContainer *container);

Returns the type of the children supported by the container.

Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a CtkPaned which already has two children.

ctk_container_child_get ()

void
ctk_container_child_get (CtkContainer *container,
                         CtkWidget *child,
                         const gchar *first_prop_name,
                         ...);

Gets the values of one or more child properties for child and container .

ctk_container_child_set ()

void
ctk_container_child_set (CtkContainer *container,
                         CtkWidget *child,
                         const gchar *first_prop_name,
                         ...);

Sets one or more child properties for child and container .

ctk_container_child_get_property ()

void
ctk_container_child_get_property (CtkContainer *container,
                                  CtkWidget *child,
                                  const gchar *property_name,
                                  GValue *value);

Gets the value of a child property for child and container .

ctk_container_child_set_property ()

void
ctk_container_child_set_property (CtkContainer *container,
                                  CtkWidget *child,
                                  const gchar *property_name,
                                  const GValue *value);

Sets a child property for child and container .

ctk_container_child_get_valist ()

void
ctk_container_child_get_valist (CtkContainer *container,
                                CtkWidget *child,
                                const gchar *first_property_name,
                                va_list var_args);

Gets the values of one or more child properties for child and container .

ctk_container_child_set_valist ()

void
ctk_container_child_set_valist (CtkContainer *container,
                                CtkWidget *child,
                                const gchar *first_property_name,
                                va_list var_args);

Sets one or more child properties for child and container .

ctk_container_child_notify ()

void
ctk_container_child_notify (CtkContainer *container,
                            CtkWidget *child,
                            const gchar *child_property);

Emits a “child-notify” signal for the child property child_property on the child.

This is an analogue of g_object_notify() for child properties.

Also see ctk_widget_child_notify().

Since: 3.2

ctk_container_child_notify_by_pspec ()

void
ctk_container_child_notify_by_pspec (CtkContainer *container,
                                     CtkWidget *child,
                                     GParamSpec *pspec);

Emits a “child-notify” signal for the child property specified by pspec on the child.

This is an analogue of g_object_notify_by_pspec() for child properties.

Since: 3.18

ctk_container_forall ()

void
ctk_container_forall (CtkContainer *container,
                      CtkCallback callback,
                      gpointer callback_data);

Invokes callback on each direct child of container , including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.

Most applications should use ctk_container_foreach(), rather than ctk_container_forall().

[virtual forall]

ctk_container_get_border_width ()

guint
ctk_container_get_border_width (CtkContainer *container);

Retrieves the border width of the container. See ctk_container_set_border_width().

ctk_container_set_border_width ()

void
ctk_container_set_border_width (CtkContainer *container,
                                guint border_width);

Sets the border width of the container.

The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is CtkWindow; because toplevel windows can’t leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, use a specific “margin” property on the child widget, for example “margin-top”.

ctk_container_propagate_draw ()

void
ctk_container_propagate_draw (CtkContainer *container,
                              CtkWidget *child,
                              cairo_t *cr);

When a container receives a call to the draw function, it must send synthetic “draw” calls to all children that don’t have their own CdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its “draw” function, calls ctk_container_propagate_draw() once for each child, passing in the cr the container received.

ctk_container_propagate_draw() takes care of translating the origin of cr , and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling ctk_widget_draw() on the child directly.

In most cases, a container can simply either inherit the “draw” implementation from CtkContainer, or do some drawing and then chain to the ::draw implementation from CtkContainer.

ctk_container_get_focus_chain ()

gboolean
ctk_container_get_focus_chain (CtkContainer *container,
                               GList **focusable_widgets);

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, CTK+ computes the focus chain based on the positions of the children. In that case, CTK+ stores NULL in focusable_widgets and returns FALSE.

ctk_container_set_focus_chain ()

void
ctk_container_set_focus_chain (CtkContainer *container,
                               GList *focusable_widgets);

Sets a focus chain, overriding the one computed automatically by CTK+.

In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it’s allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn’t always packed. The necessary checks are done when the focus chain is actually traversed.

ctk_container_unset_focus_chain ()

void
ctk_container_unset_focus_chain (CtkContainer *container);

Removes a focus chain explicitly set with ctk_container_set_focus_chain().

ctk_container_class_find_child_property ()

GParamSpec *
ctk_container_class_find_child_property
                               (GObjectClass *cclass,
                                const gchar *property_name);

Finds a child property of a container class by name.

ctk_container_class_install_child_property ()

void
ctk_container_class_install_child_property
                               (CtkContainerClass *cclass,
                                guint property_id,
                                GParamSpec *pspec);

Installs a child property on a container class.

ctk_container_class_install_child_properties ()

void
ctk_container_class_install_child_properties
                               (CtkContainerClass *cclass,
                                guint n_pspecs,
                                GParamSpec **pspecs);

Installs child properties on a container class.

Since: 3.18

ctk_container_class_list_child_properties ()

GParamSpec **
ctk_container_class_list_child_properties
                               (GObjectClass *cclass,
                                guint *n_properties);

Returns all child properties of a container class.

ctk_container_class_handle_border_width ()

void
ctk_container_class_handle_border_width
                               (CtkContainerClass *klass);

Modifies a subclass of CtkContainerClass to automatically add and remove the border-width setting on CtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function.

ctk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must “opt in” to the parent class handling border_width for them.

struct CtkContainer

struct CtkContainer;

struct CtkContainerClass

struct CtkContainerClass {
  CtkWidgetClass parent_class;

  void    (*add)       		(CtkContainer	 *container,
				 CtkWidget	 *widget);
  void    (*remove)    		(CtkContainer	 *container,
				 CtkWidget	 *widget);
  void    (*check_resize) (CtkContainer	 *container);
  void    (*forall)    		(CtkContainer	 *container,
				 gboolean	  include_internals,
				 CtkCallback	  callback,
				 gpointer	  callback_data);
  void    (*set_focus_child) (CtkContainer	 *container,
				 CtkWidget	 *child);
  GType   (*child_type)		(CtkContainer	 *container);
  gchar*  (*composite_name) (CtkContainer	 *container,
				 CtkWidget	 *child);
  void    (*set_child_property) (CtkContainer    *container,
				 CtkWidget       *child,
				 guint            property_id,
				 const GValue    *value,
				 GParamSpec      *pspec);
  void    (*get_child_property) (CtkContainer    *container,
                                 CtkWidget       *child,
				 guint            property_id,
				 GValue          *value,
				 GParamSpec      *pspec);
  CtkWidgetPath * (*get_path_for_child) (CtkContainer *container,
                                         CtkWidget    *child);
};

Base class for containers.

enum CtkResizeMode

The “border-width” property

  “border-width”             guint

The width of the empty border outside the containers children.

Owner: CtkContainer

Flags: Read / Write

Allowed values: <= 65535

Default value: 0

The “child” property

  “child”                    CtkWidget *

Can be used to add a new child to the container.

Owner: CtkContainer

Flags: Write

The “resize-mode” property

  “resize-mode”              CtkResizeMode

Specify how resize events are handled.

Owner: CtkContainer

Flags: Read / Write

Default value: CTK_RESIZE_PARENT

The “add” signal

void
user_function (CtkContainer *ctkcontainer,
               CtkWidget    *arg1,
               gpointer      user_data)

Flags: Run First

The “check-resize” signal

void
user_function (CtkContainer *ctkcontainer,
               gpointer      user_data)

Flags: Run Last

The “remove” signal

void
user_function (CtkContainer *ctkcontainer,
               CtkWidget    *arg1,
               gpointer      user_data)

Flags: Run First

The “set-focus-child” signal

void
user_function (CtkContainer *ctkcontainer,
               CtkWidget    *arg1,
               gpointer      user_data)

Flags: Run First