gtkmm: Gtk::Container Class Reference

# Gtk::Container Class Reference
[Widgets]

Abstract container class. More...

Inherits Gtk::Widget.

Inherited by Gtk::Bin, Gtk::Box, Gtk::ComboDropDown, Gtk::Fixed, Gtk::IconView, Gtk::Layout, Gtk::MenuShell, Gtk::Notebook, Gtk::Paned, Gtk::Socket, Gtk::Table, Gtk::TextView, Gtk::Toolbar, Gtk::ToolItemGroup, Gtk::ToolPalette, and Gtk::TreeView.

Collaboration diagram for Gtk::Container:
[legend]

List of all members.

## Public Types

typedef sigc::slot< void, Widget& > | ForeachSlot
| For instance, void on_foreach(Gtk::Widget* widget);.

## Public Member Functions

virtual | ~Container ()
GtkContainer* | gobj ()
| Provides access to the underlying C GtkObject.
const GtkContainer* | gobj () const
| Provides access to the underlying C GtkObject.
void | set_border_width (guint border_width)
| Sets the border width of the container.
guint | get_border_width () const
| Retrieves the border width of the container.
virtual void | add (Widget& widget)
void | remove (Widget& widget)
| Removes widget from container.
void | set_resize_mode (ResizeMode resize_mode)
| Sets the resize mode for the container.
ResizeMode | get_resize_mode () const
| Returns the resize mode for the container.
void | check_resize ()
| Request that contained widgets check their size.
void | foreach (const ForeachSlot& slot)
| Operate on contained items This is largely an internal used mainly for things like creating duplicates of internal lists and other such operations.
Glib::ListHandle< Widget* > | get_children ()
| (internal) Operate on contained items (see foreach())
Glib::ListHandle< const Widget* > | get_children () const
| Returns the container's non-internal children.
void | propagate_expose (Widget& child, GdkEventExpose* event)
| When a container receives an expose event, it must send synthetic expose events to all children that don't have their own Gdk::Windows.
void | set_focus_chain (const Glib::ListHandle< Widget* >& focusable_widgets)
| Sets a focus chain, overriding the one computed automatically by GTK+.
bool | has_focus_chain () const
Glib::ListHandle< Widget* > | get_focus_chain ()
Glib::ListHandle< const Widget* > | get_focus_chain () const
void | unset_focus_chain ()
| Removes a focus chain explicitly set with set_focus_chain().
void | set_reallocate_redraws (bool needs_redraws=true)
| Sets the reallocate_redraws flag of the container to the given value.
void | set_focus_child (Widget& widget)
| Sets the focus on a child.
void | set_focus_vadjustment (Adjustment& 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.
Adjustment* | get_focus_vadjustment ()
| Retrieves the vertical focus adjustment for the container.
const Adjustment* | get_focus_vadjustment () const
| Retrieves the vertical focus adjustment for the container.
void | set_focus_hadjustment (Adjustment& 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.
Adjustment* | get_focus_hadjustment ()
| Retrieves the horizontal focus adjustment for the container.
const Adjustment* | get_focus_hadjustment () const
| Retrieves the horizontal focus adjustment for the container.
void | resize_children ()
GType | child_type () const
| Returns the type of the children supported by the container.
Glib::SignalProxy1< void, Widget* > | signal_add ()
Glib::SignalProxy1< void, Widget* > | signal_remove ()
Glib::SignalProxy0< void > | signal_check_resize ()
Glib::SignalProxy1< void, Widget* > | signal_set_focus_child ()
void | show_all_children (bool recursive=true)

## Protected Member Functions

virtual void | on_add (Widget* widget)
virtual void | on_remove (Widget* widget)
virtual void | on_check_resize ()
virtual void | on_set_focus_child (Widget* widget)
| Container ()
virtual GType | child_type_vfunc () const
virtual void | forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
virtual char* | composite_name_vfunc (GtkWidget* child)
virtual void | set_child_property_vfunc (GtkWidget* child, guint property_id, const GValue*value, GParamSpec* pspec)
virtual void | get_child_property_vfunc (GtkWidget* child, guint property_id, GValue*value, GParamSpec* pspec) const
Glib::PropertyProxy< guint > | property_border_width ()
| The width of the empty border outside the containers children.
Glib::PropertyProxy_ReadOnly < guint > | property_border_width () const
| The width of the empty border outside the containers children.
Glib::PropertyProxy< ResizeMode > | property_resize_mode ()
| Specify how resize events are handled.
Glib::PropertyProxy_ReadOnly < ResizeMode > | property_resize_mode () const
| Specify how resize events are handled.
Glib::PropertyProxy_WriteOnly < Widget* > | property_child ()
| Can be used to add a new child to the container.

## Related Functions

(Note that these are not member functions.)
Gtk::Container* | wrap (GtkContainer* object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Detailed Description

Abstract container class.

This is the abstract container from which all gtk+ widgets which hold other items derive from. It mainly houses virtual functions used for inserting and removing children. Containers in gtk+ may hold one item or many items depending on the implementation.

This interface is used for all single item holding containers. Multi-item containers provide their own unique interface as their items are generally more complex. The methods of the derived classes should be prefered over these.

## Member Typedef Documentation

typedef sigc::slot<void, Widget&> Gtk::Container::ForeachSlot

For instance, void on_foreach(Gtk::Widget* widget);.

## Constructor & Destructor Documentation

virtual Gtk::Container::~Container | ( |  | ) | `[virtual]`

Gtk::Container::Container | ( |  | ) | `[protected]`

## Member Function Documentation

virtual void Gtk::Container::add | ( | Widget& | widget | ) | `[virtual]`

Reimplemented in Gtk::ScrolledWindow.

void Gtk::Container::check_resize | ( |  | ) |

Request that contained widgets check their size.

GType Gtk::Container::child_type | ( |  | ) | const

Returns the type of the children supported by the container.

Note that this may return TYPE_NONE to indicate that no more children can be added, e.g. for a Gtk::Paned which already has two children.

Returns:
  A Type.

virtual GType Gtk::Container::child_type_vfunc | ( |  | ) | const`[protected, virtual]`

virtual char* Gtk::Container::composite_name_vfunc | ( | GtkWidget * | child | ) | `[protected, virtual]`

virtual void Gtk::Container::forall_vfunc | ( | gboolean | include_internals,
|  | GtkCallback | callback,
|  | gpointer | callback_data |
| ) |  |  | `[protected, virtual]`

void Gtk::Container::foreach | ( | const ForeachSlot & | slot | ) |

Operate on contained items This is largely an internal used mainly for things like creating duplicates of internal lists and other such operations.

The result is lossy as it only gets the the main child and not its external pieces.

For example notebook pages contain a page, a label, and a menu item. But this only operates on the pages.

guint Gtk::Container::get_border_width | ( |  | ) | const

Retrieves the border width of the container.

See set_border_width().

Returns:
  The current border width.

virtual void Gtk::Container::get_child_property_vfunc | ( | GtkWidget * | child,
|  | guint | property_id,
|  | GValue * | value,
|  | GParamSpec * | pspec |
| ) |  |  | const`[protected, virtual]`

Glib::ListHandle<const Widget*> Gtk::Container::get_children | ( |  | ) | const

Returns the container's non-internal children.

See forall() for details on what constitutes an "internal" child.

Returns:
  A newly-allocated list of the container's non-internal children.

Glib::ListHandle<Widget*> Gtk::Container::get_children | ( |  | ) |

(internal) Operate on contained items (see foreach())

(internal) Operate on contained items (see foreach()) Returns the container's non-internal children. See forall() for details on what constitutes an "internal" child.

Returns:
  A newly-allocated list of the container's non-internal children.

Glib::ListHandle<const Widget*> Gtk::Container::get_focus_chain | ( |  | ) | const

Glib::ListHandle<Widget*> Gtk::Container::get_focus_chain | ( |  | ) |

const Adjustment* Gtk::Container::get_focus_hadjustment | ( |  | ) | const

Retrieves the horizontal focus adjustment for the container.

See set_focus_hadjustment().

Returns:
  The horizontal focus adjustment, or `0` if none has been set.

Adjustment* Gtk::Container::get_focus_hadjustment | ( |  | ) |

Retrieves the horizontal focus adjustment for the container.

See set_focus_hadjustment().

Returns:
  The horizontal focus adjustment, or `0` if none has been set.

const Adjustment* Gtk::Container::get_focus_vadjustment | ( |  | ) | const

Retrieves the vertical focus adjustment for the container.

See set_focus_vadjustment().

Returns:
  The vertical focus adjustment, or `0` if none has been set.

Adjustment* Gtk::Container::get_focus_vadjustment | ( |  | ) |

Retrieves the vertical focus adjustment for the container.

See set_focus_vadjustment().

Returns:
  The vertical focus adjustment, or `0` if none has been set.

ResizeMode Gtk::Container::get_resize_mode | ( |  | ) | const

Returns the resize mode for the container.

See set_resize_mode().

Returns:
  The current resize mode.

const GtkContainer* Gtk::Container::gobj | ( |  | ) | const`[inline]`

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::AboutDialog, Gtk::Alignment, Gtk::AspectFrame, Gtk::Assistant, Gtk::Bin, Gtk::Box, Gtk::VBox, Gtk::HBox, Gtk::Button, Gtk::ButtonBox, Gtk::VButtonBox, Gtk::HButtonBox, Gtk::CheckButton, Gtk::CheckMenuItem, Gtk::ColorButton, Gtk::ColorSelection, Gtk::ColorSelectionDialog, Gtk::ComboBox, Gtk::ComboBoxEntry, Gtk::Dialog, Gtk::EventBox, Gtk::Expander, Gtk::FileChooserButton, Gtk::FileChooserDialog, Gtk::FileChooserWidget, Gtk::FileSelection, Gtk::Fixed, Gtk::FontButton, Gtk::FontSelection, Gtk::FontSelectionDialog, Gtk::Frame, Gtk::HandleBox, Gtk::IconView, Gtk::ImageMenuItem, Gtk::InfoBar, Gtk::Item, Gtk::Layout, Gtk::LinkButton, Gtk::Menu, Gtk::MenuBar, Gtk::MenuItem, Gtk::MenuShell, Gtk::MenuToolButton, Gtk::MessageDialog, Gtk::Notebook, Gtk::OffscreenWindow, Gtk::OptionMenu, Gtk::Paned, Gtk::HPaned, Gtk::VPaned, Gtk::Plug, Gtk::RadioButton, Gtk::RadioMenuItem, Gtk::RadioToolButton, Gtk::RecentChooserDialog, Gtk::RecentChooserMenu, Gtk::RecentChooserWidget, Gtk::ScaleButton, Gtk::ScrolledWindow, Gtk::SeparatorMenuItem, Gtk::SeparatorToolItem, Gtk::Socket, Gtk::Statusbar, Gtk::Table, Gtk::TearoffMenuItem, Gtk::TextView, Gtk::ToggleButton, Gtk::ToggleToolButton, Gtk::Toolbar, Gtk::ToolButton, Gtk::ToolItem, Gtk::ToolItemGroup, Gtk::ToolPalette, Gtk::TreeView, Gtk::Viewport, Gtk::VolumeButton, Gtk::Window, Gtk::PageSetupUnixDialog, Gtk::PrintUnixDialog, Gtk::ComboDropDownItem, Gtk::ComboDropDown, Gtk::Combo, Gtk::GammaCurve, and Gtk::InputDialog.

GtkContainer* Gtk::Container::gobj | ( |  | ) | `[inline]`

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::AboutDialog, Gtk::Alignment, Gtk::AspectFrame, Gtk::Assistant, Gtk::Bin, Gtk::Box, Gtk::VBox, Gtk::HBox, Gtk::Button, Gtk::ButtonBox, Gtk::VButtonBox, Gtk::HButtonBox, Gtk::CheckButton, Gtk::CheckMenuItem, Gtk::ColorButton, Gtk::ColorSelection, Gtk::ColorSelectionDialog, Gtk::ComboBox, Gtk::ComboBoxEntry, Gtk::Dialog, Gtk::EventBox, Gtk::Expander, Gtk::FileChooserButton, Gtk::FileChooserDialog, Gtk::FileChooserWidget, Gtk::FileSelection, Gtk::Fixed, Gtk::FontButton, Gtk::FontSelection, Gtk::FontSelectionDialog, Gtk::Frame, Gtk::HandleBox, Gtk::IconView, Gtk::ImageMenuItem, Gtk::InfoBar, Gtk::Item, Gtk::Layout, Gtk::LinkButton, Gtk::Menu, Gtk::MenuBar, Gtk::MenuItem, Gtk::MenuShell, Gtk::MenuToolButton, Gtk::MessageDialog, Gtk::Notebook, Gtk::OffscreenWindow, Gtk::OptionMenu, Gtk::Paned, Gtk::HPaned, Gtk::VPaned, Gtk::Plug, Gtk::RadioButton, Gtk::RadioMenuItem, Gtk::RadioToolButton, Gtk::RecentChooserDialog, Gtk::RecentChooserMenu, Gtk::RecentChooserWidget, Gtk::ScaleButton, Gtk::ScrolledWindow, Gtk::SeparatorMenuItem, Gtk::SeparatorToolItem, Gtk::Socket, Gtk::Statusbar, Gtk::Table, Gtk::TearoffMenuItem, Gtk::TextView, Gtk::ToggleButton, Gtk::ToggleToolButton, Gtk::Toolbar, Gtk::ToolButton, Gtk::ToolItem, Gtk::ToolItemGroup, Gtk::ToolPalette, Gtk::TreeView, Gtk::Viewport, Gtk::VolumeButton, Gtk::Window, Gtk::PageSetupUnixDialog, Gtk::PrintUnixDialog, Gtk::ComboDropDownItem, Gtk::ComboDropDown, Gtk::Combo, Gtk::GammaCurve, and Gtk::InputDialog.

bool Gtk::Container::has_focus_chain | ( |  | ) | const

virtual void Gtk::Container::on_add | ( | Widget* | widget | ) | `[protected, virtual]`

virtual void Gtk::Container::on_check_resize | ( |  | ) | `[protected, virtual]`

virtual void Gtk::Container::on_remove | ( | Widget* | widget | ) | `[protected, virtual]`

virtual void Gtk::Container::on_set_focus_child | ( | Widget* | widget | ) | `[protected, virtual]`

void Gtk::Container::propagate_expose | ( | Widget& | child,
|  | GdkEventExpose * | event |
| ) |  |  |

When a container receives an expose event, it must send synthetic expose events to all children that don't have their own Gdk::Windows.

This function provides a convenient way of doing this. A container, when it receives an expose event, calls propagate_expose() once for each child, passing in the event the container received.

propagate_expose() takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event.

In most cases, a container can simply either simply inherit the Gtk::Widget::expose implementation from Gtk::Container, or, do some drawing and then chain to the expose implementation from Gtk::Container.

Parameters:

  | child | A child of container.
  | event | A expose event sent to container.

Glib::PropertyProxy_ReadOnly<guint> Gtk::Container::property_border_width | ( |  | ) | const`[protected]`

The width of the empty border outside the containers children.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
  A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<guint> Gtk::Container::property_border_width | ( |  | ) | `[protected]`

The width of the empty border outside the containers children.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
  A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_WriteOnly<Widget*> Gtk::Container::property_child | ( |  | ) | `[protected]`

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

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
  A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<ResizeMode> Gtk::Container::property_resize_mode | ( |  | ) | const`[protected]`

Specify how resize events are handled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
  A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<ResizeMode> Gtk::Container::property_resize_mode | ( |  | ) | `[protected]`

Specify how resize events are handled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
  A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::Container::remove | ( | Widget& | widget | ) |

Removes widget from container.

widget must be inside container. If widget is managed with Gtk::manage(), and you don't want to use widget again then you should delete widget, because there will no longer be any parent container to delete it automatically.

Parameters:

  | widget | A current child of container.

void Gtk::Container::resize_children | ( |  | ) |

void Gtk::Container::set_border_width | ( | 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 Gtk::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 Gtk::Alignment widget, call Gtk::Widget::set_size_request() to give it a size, and place it on the side of the container as a spacer.

Parameters:

  | border_width | Amount of blank space to leave <emphasis>outside</emphasis> the container. Valid values are in the range 0-65535 pixels.

virtual void Gtk::Container::set_child_property_vfunc | ( | GtkWidget * | child,
|  | guint | property_id,
|  | const GValue * | value,
|  | GParamSpec * | pspec |
| ) |  |  | `[protected, virtual]`

void Gtk::Container::set_focus_chain | ( | const Glib::ListHandle< Widget* >& | focusable_widgets | ) |

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.

Parameters:

  | focusable_widgets | The new focus chain.

void Gtk::Container::set_focus_child | ( | Widget& | widget | ) |

Sets the focus on a child.

void Gtk::Container::set_focus_hadjustment | ( | Adjustment& | 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 Gtk::ScrolledWindow::get_hadjustment() for a typical way of obtaining the adjustment and 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.

Parameters:

  | adjustment | An adjustment which should be adjusted when the focus is moved among the descendents of container.

void Gtk::Container::set_focus_vadjustment | ( | Adjustment& | 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 Gtk::ScrolledWindow::get_vadjustment() for a typical way of obtaining the adjustment and 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.

Parameters:

  | adjustment | An adjustment which should be adjusted when the focus is moved among the descendents of container.

void Gtk::Container::set_reallocate_redraws | ( | bool | needs_redraws = `true` | ) |

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.

Parameters:

  | needs_redraws | The new value for the container's reallocate_redraws flag.

void Gtk::Container::set_resize_mode | ( | ResizeMode | 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.

Parameters:

  | resize_mode | The new resize mode.

void Gtk::Container::show_all_children | ( | bool | recursive = `true` | ) |

Glib::SignalProxy1< void,Widget* > Gtk::Container::signal_add | ( |  | ) |

Prototype:
  `void on_my_add(Widget* widget)`

Glib::SignalProxy0< void > Gtk::Container::signal_check_resize | ( |  | ) |

Prototype:
  `void on_my_check_resize()`

Glib::SignalProxy1< void,Widget* > Gtk::Container::signal_remove | ( |  | ) |

Prototype:
  `void on_my_remove(Widget* widget)`

Glib::SignalProxy1< void,Widget* > Gtk::Container::signal_set_focus_child | ( |  | ) |

Prototype:
  `void on_my_set_focus_child(Widget* widget)`

void Gtk::Container::unset_focus_chain | ( |  | ) |

Removes a focus chain explicitly set with set_focus_chain().

## Friends And Related Function Documentation

Gtk::Container* wrap | ( | GtkContainer * | object,
|  | bool | take_copy = `false` |
| ) |  |  | `[related]`

A Glib::wrap() method for this object.

Parameters:

  | object | The C instance.
  | take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:
  A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

- gtkmm/container.h