Maintainer	gtk2hs-users@lists.sourceforge.net
Stability	provisional
Portability	portable (depends on GHC)
Safe Haskell	None
Language	Haskell98

Graphics.UI.Gtk.Abstract.Container

Contents

Detail
Class Hierarchy
Types
Methods
Attributes
Signals
Deprecated

Description

Base class for widgets which contain other widgets

Synopsis

Detail

A Gtk+ user interface is constructed by nesting widgets inside widgets. Container widgets are the inner nodes in the resulting tree of widgets: they contain other widgets. So, for example, you might have a Window containing a Frame containing a Label. If you wanted an image instead of a textual label inside the frame, you might replace the Label widget with a Image widget.

There are two major kinds of container widgets in Gtk+. Both are subclasses of the abstract Container base class.

The first type of container widget has a single child widget and derives from Bin. These containers are decorators, which add some kind of functionality to the child. For example, a Button makes its child into a clickable button; a Frame draws a frame around its child and a Window places its child widget inside a top-level window.

The second type of container can have more than one child; its purpose is to manage layout. This means that these containers assign sizes and positions to their children. For example, a HBox arranges its children in a horizontal row, and a Table arranges the widgets it contains in a two-dimensional grid.

To fulfill its task, a layout container must negotiate the size requirements with its parent and its children. This negotiation is carried out in two phases, size requisition and size allocation.

Size Requisition

The size requisition of a widget is it's desired width and height. This is represented by a Requisition.

How a widget determines its desired size depends on the widget. A Label, for example, requests enough space to display all its text. Container widgets generally base their size request on the requisitions of their children.

The size requisition phase of the widget layout process operates top-down. It starts at a top-level widget, typically a Window. The top-level widget asks its child for its size requisition by calling widgetSizeRequest. To determine its requisition, the child asks its own children for their requisitions and so on. Finally, the top-level widget will get a requisition back from its child.

Size Allocation

When the top-level widget has determined how much space its child would like to have, the second phase of the size negotiation, size allocation, begins. Depending on its configuration (see windowSetResizable), the top-level widget may be able to expand in order to satisfy the size request or it may have to ignore the size request and keep its fixed size. It then tells its child widget how much space it gets by calling widgetSizeAllocate. The child widget divides the space among its children and tells each child how much space it got, and so on. Under normal circumstances, a Window will always give its child the amount of space the child requested.

A child's size allocation is represented by an Allocation. This contains not only a width and height, but also a position (i.e. X and Y coordinates), so that containers can tell their children not only how much space they have gotten, but also where they are positioned inside the space available to the container.

Widgets are required to honor the size allocation they receive; a size request is only a request, and widgets must be able to cope with any size.

Child attributes

Container introduces child attributes - these are object attributes that are not specific to either the container or the contained widget, but rather to their relation. Typical examples of child attributes are the position or pack-type of a widget which is contained in a Box.

The Container class does not itself define any child attributes, they are defined (and documented) by the various Container subclasses.

Child attributes can be set or obtained in a similar way to ordinary attributes. So ordinary attributes are set like so:

set object [ attr := value ]

Whereas child attributes take the child object as a parameter:

set container [ attr child := value ]

And similarily for getting a child attribute's value:

value <- get container (attr child)

Class Hierarchy

| GObject
| +----Object
| +----Widget
| +----Container
| +----Bin
| +----Box
| +----CList
| +----Fixed
| +----Paned
| +----IconView
| +----Layout
| +----List
| +----MenuShell
| +----Notebook
| +----Socket
| +----Table
| +----TextView
| +----Toolbar
| +----TreeView

Types

data Container Source

Instances

Eq Container Source
Ord Container Source
GObjectClass Container Source
ContainerClass Container Source
WidgetClass Container Source

class WidgetClass o => ContainerClass o Source

Instances

ContainerClass TreeView Source
ContainerClass Toolbar Source
ContainerClass TextView Source
ContainerClass Table Source
ContainerClass Notebook Source
ContainerClass MenuBar Source
ContainerClass RecentChooserMenu Source
ContainerClass Menu Source
ContainerClass MenuShell Source
ContainerClass Layout Source
ContainerClass IconView Source
ContainerClass VPaned Source
ContainerClass HPaned Source
ContainerClass Paned Source
ContainerClass Fixed Source
ContainerClass Grid Source
ContainerClass Statusbar Source
ContainerClass FileChooserButton Source
ContainerClass InfoBar Source
ContainerClass HBox Source
ContainerClass FileChooserWidget Source
ContainerClass FontSelection Source
ContainerClass ColorSelection Source
ContainerClass RecentChooserWidget Source
ContainerClass VBox Source
ContainerClass VButtonBox Source
ContainerClass HButtonBox Source
ContainerClass ButtonBox Source
ContainerClass Box Source
ContainerClass SeparatorToolItem Source
ContainerClass RadioToolButton Source
ContainerClass ToggleToolButton Source
ContainerClass MenuToolButton Source
ContainerClass ToolButton Source
ContainerClass ToolItem Source
ContainerClass ComboBox Source
ContainerClass Expander Source
ContainerClass Viewport Source
ContainerClass ScrolledWindow Source
ContainerClass HandleBox Source
ContainerClass EventBox Source
ContainerClass MessageDialog Source
ContainerClass FontSelectionDialog Source
ContainerClass FileChooserDialog Source
ContainerClass ColorSelectionDialog Source
ContainerClass AboutDialog Source
ContainerClass Dialog Source
ContainerClass OffscreenWindow Source
ContainerClass Assistant Source
ContainerClass Window Source
ContainerClass Overlay Source
ContainerClass SeparatorMenuItem Source
ContainerClass ImageMenuItem Source
ContainerClass TearoffMenuItem Source
ContainerClass RadioMenuItem Source
ContainerClass CheckMenuItem Source
ContainerClass MenuItem Source
ContainerClass FontButton Source
ContainerClass ColorButton Source
ContainerClass RadioButton Source
ContainerClass CheckButton Source
ContainerClass ToggleButton Source
ContainerClass LinkButton Source
ContainerClass VolumeButton Source
ContainerClass ScaleButton Source
ContainerClass Button Source
ContainerClass AspectFrame Source
ContainerClass Frame Source
ContainerClass Alignment Source
ContainerClass Bin Source
ContainerClass ToolItemGroup Source
ContainerClass ToolPalette Source
ContainerClass Container Source
ContainerClass Plug Source
ContainerClass Socket Source

castToContainer :: GObjectClass obj => obj -> Container Source

gTypeContainer :: GType Source

toContainer :: ContainerClass o => o -> Container Source

type ContainerForeachCB = Widget -> IO () Source

A function that is invoked for all widgets in a container.

data ResizeMode Source

Resize mode, for containers

ResizeParent Pass resize request to the parent
ResizeQueue Queue resizes on this widget
ResizeImmediate Perform the resizes now

Constructors

ResizeParent
ResizeQueue
ResizeImmediate

Instances

Enum ResizeMode Source
Eq ResizeMode Source
Show ResizeMode Source

Methods

containerAdd Source

Arguments

:: (ContainerClass self, WidgetClass widget)
=> self
-> widget	`widget` - a widget to be placed inside `container`
-> IO ()

Adds widget to the container. Typically used for simple containers such as Window, Frame, or Button; for more complicated layout containers such as Box or Table, this function will pick default packing parameters that may not be correct. So consider functions such as boxPackStart and tableAttach as an alternative to containerAdd 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.

containerRemove Source

Arguments

:: (ContainerClass self, WidgetClass widget)
=> self
-> widget	`widget` - a current child of `container`
-> IO ()

Removes widget from container. widget must be inside container.

containerForeach :: ContainerClass self => self -> ContainerForeachCB -> IO () Source

Maps callback over each non-internal child of container. See containerForall for details on what constitutes an "internal" child. Most applications should use containerForeach, rather than containerForall.

containerForall Source

Arguments

:: ContainerClass self
=> self
-> ContainerForeachCB	`callback` - a callback
-> IO ()

Maps callback over each 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 containerForeach, rather than containerForall.

containerGetChildren :: ContainerClass self => self -> IO [Widget] Source

Returns the container's non-internal children. See containerForall for details on what constitutes an "internal" child.

containerSetFocusChild Source

Arguments

:: (ContainerClass self, WidgetClass child)
=> self
-> child	child
-> IO ()

Give the focus to a specific child of the container.

containerSetFocusChain Source

Arguments

:: ContainerClass self
=> self
-> [Widget]	`focusableWidgets` - the new focus chain.
-> IO ()

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

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.

containerGetFocusChain :: ContainerClass self => self -> IO (Maybe [Widget]) Source

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, Gtk+ computes the focus chain based on the positions of the children. In that case the function returns Nothing.

containerUnsetFocusChain :: ContainerClass self => self -> IO () Source

Removes a focus chain explicitly set with containerSetFocusChain.

containerSetFocusVAdjustment Source

Arguments

:: ContainerClass self
=> self
-> Adjustment	`adjustment` - an adjustment which should be adjusted when the focus is moved among the descendents of `container`
-> IO ()

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 scrolledWindowGetVAdjustment for a typical way of obtaining the adjustment and containerSetFocusHAdjustment 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.

containerGetFocusVAdjustment Source

Arguments

:: ContainerClass self
=> self
-> IO (Maybe Adjustment)	returns the vertical focus adjustment, or `Nothing` if none has been set.

Retrieves the vertical focus adjustment for the container. See containerSetFocusVAdjustment.

containerSetFocusHAdjustment Source

Arguments

:: ContainerClass self
=> self
-> Adjustment	`adjustment` - an adjustment which should be adjusted when the focus is moved among the descendents of `container`
-> IO ()

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 scrolledWindowGetHAdjustment for a typical way of obtaining the adjustment and containerSetFocusVAdjustment 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.

containerGetFocusHAdjustment Source

Arguments

:: ContainerClass self
=> self
-> IO (Maybe Adjustment)	returns the horizontal focus adjustment, or `Nothing` if none has been set.

Retrieves the horizontal focus adjustment for the container. See containerSetFocusHAdjustment.

containerResizeChildren :: ContainerClass self => self -> IO () Source

Make the container resize its children.

containerSetBorderWidth Source

Arguments

:: ContainerClass self
=> self
-> Int	`borderWidth` - amount of blank space to leave outside the container. Valid values are in the range 0-65535 pixels.
-> IO ()

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 Window; 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, one approach is to create a Alignment widget, call widgetSetUsize to give it a size, and place it on the side of the container as a spacer.

containerGetBorderWidth Source

Arguments

:: ContainerClass self
=> self
-> IO Int	returns the current border width

Retrieves the border width of the container. See containerSetBorderWidth.

containerGetResizeMode Source

Arguments

:: ContainerClass self
=> self
-> IO ResizeMode	returns the current resize mode

Returns the resize mode for the container. See containerSetResizeMode.

containerSetResizeMode Source

Arguments

:: ContainerClass self
=> self
-> ResizeMode	`resizeMode` - the new resize mode.
-> IO ()

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.