Index

Package: Container

Description

package Gtk.Container is

Base class for widgets that have children.

When writing your own container widgets, you need to fully handle the size_allocate event, by also resizing all the children (based on their size requisition). The size_allocate event will always be sent to the parent when a child calls Gtk.Widget.Queue_Resize.

Binding from C File version 2.8.17

Packages

For_Pkg (generic)

<doc_ignore>

Classes

Gtk_Container_Record

type Gtk_Container_Record is new Gtk.Widget.Gtk_Widget_Record with private;

Ancestors:

Immediate Children:

Primitive operations:

Check_Resize
Child_Get_Property
Child_Set_Property
Get_Border_Width
Get_Children
Get_Focus_Chain
Get_Focus_Child
Get_Focus_Hadjustment
Get_Focus_Vadjustment
Get_Resize_Mode
Glib.Object.Deallocate (Inherited)
Glib.Object.Get_Type (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)
Gtk.Widget.Activate (Inherited)
Gtk.Widget.Add_Accelerator (Inherited)
Gtk.Widget.Add_Events (Inherited)
Gtk.Widget.Add_Mnemonic_Label (Inherited)
Gtk.Widget.Can_Activate_Accel (Inherited)
Gtk.Widget.Child_Notify (Inherited)
Gtk.Widget.Class_Path (Inherited)
Gtk.Widget.Class_Path_Reversed (Inherited)
Gtk.Widget.Create_Pango_Context (Inherited)
Gtk.Widget.Create_Pango_Layout (Inherited)
Gtk.Widget.Destroy (Inherited)
Gtk.Widget.Draw (Inherited)
Gtk.Widget.Ensure_Style (Inherited)
Gtk.Widget.Error_Bell (Inherited)
Gtk.Widget.Flag_Is_Set (Inherited)
Gtk.Widget.Flags (Inherited)
Gtk.Widget.Freeze_Child_Notify (Inherited)
Gtk.Widget.Get_Allocation_Height (Inherited)
Gtk.Widget.Get_Allocation_Width (Inherited)
Gtk.Widget.Get_Allocation_X (Inherited)
Gtk.Widget.Get_Allocation_Y (Inherited)
Gtk.Widget.Get_Ancestor (Inherited)
Gtk.Widget.Get_Child_Requisition (Inherited)
Gtk.Widget.Get_Child_Visible (Inherited)
Gtk.Widget.Get_Colormap (Inherited)
Gtk.Widget.Get_Composite_Name (Inherited)
Gtk.Widget.Get_Direction (Inherited)
Gtk.Widget.Get_Events (Inherited)
Gtk.Widget.Get_Extension_Events (Inherited)
Gtk.Widget.Get_Has_Tooltip (Inherited)
Gtk.Widget.Get_Name (Inherited)
Gtk.Widget.Get_No_Show_All (Inherited)
Gtk.Widget.Get_Pango_Context (Inherited)
Gtk.Widget.Get_Parent (Inherited)
Gtk.Widget.Get_Parent_Window (Inherited)
Gtk.Widget.Get_Pointer (Inherited)
Gtk.Widget.Get_Root_Window (Inherited)
Gtk.Widget.Get_Size_Request (Inherited)
Gtk.Widget.Get_Snapshot (Inherited)
Gtk.Widget.Get_State (Inherited)
Gtk.Widget.Get_Style (Inherited)
Gtk.Widget.Get_Tooltip_Markup (Inherited)
Gtk.Widget.Get_Tooltip_Text (Inherited)
Gtk.Widget.Get_Tooltip_Window (Inherited)
Gtk.Widget.Get_Toplevel (Inherited)
Gtk.Widget.Get_Visual (Inherited)
Gtk.Widget.Get_Window (Inherited)
Gtk.Widget.Grab_Default (Inherited)
Gtk.Widget.Grab_Focus (Inherited)
Gtk.Widget.Has_Screen (Inherited)
Gtk.Widget.Hide (Inherited)
Gtk.Widget.Hide_All (Inherited)
Gtk.Widget.Input_Shape_Combine_Mask (Inherited)
Gtk.Widget.Intersect (Inherited)
Gtk.Widget.Is_Ancestor (Inherited)
Gtk.Widget.Is_Composited (Inherited)
Gtk.Widget.Is_Focus (Inherited)
Gtk.Widget.Keynav_Failed (Inherited)
Gtk.Widget.List_Mnemonic_Labels (Inherited)
Gtk.Widget.Map (Inherited)
Gtk.Widget.Mnemonic_Activate (Inherited)
Gtk.Widget.Modify_Base (Inherited)
Gtk.Widget.Modify_Bg (Inherited)
Gtk.Widget.Modify_Cursor (Inherited)
Gtk.Widget.Modify_Fg (Inherited)
Gtk.Widget.Modify_Font (Inherited)
Gtk.Widget.Modify_Text (Inherited)
Gtk.Widget.Path (Inherited)
Gtk.Widget.Path_Reversed (Inherited)
Gtk.Widget.Queue_Clear (Inherited)
Gtk.Widget.Queue_Clear_Area (Inherited)
Gtk.Widget.Queue_Draw (Inherited)
Gtk.Widget.Queue_Draw_Area (Inherited)
Gtk.Widget.Queue_Resize (Inherited)
Gtk.Widget.Queue_Resize_No_Redraw (Inherited)
Gtk.Widget.Realize (Inherited)
Gtk.Widget.Region_Intersect (Inherited)
Gtk.Widget.Remove_Accelerator (Inherited)
Gtk.Widget.Remove_Mnemonic_Label (Inherited)
Gtk.Widget.Render_Icon (Inherited)
Gtk.Widget.Reparent (Inherited)
Gtk.Widget.Reset_Rc_Styles (Inherited)
Gtk.Widget.Reset_Shapes (Inherited)
Gtk.Widget.Restore_Default_Style (Inherited)
Gtk.Widget.Send_Expose (Inherited)
Gtk.Widget.Set_Accel_Path (Inherited)
Gtk.Widget.Set_App_Paintable (Inherited)
Gtk.Widget.Set_Child_Visible (Inherited)
Gtk.Widget.Set_Colormap (Inherited)
Gtk.Widget.Set_Composite_Name (Inherited)
Gtk.Widget.Set_Direction (Inherited)
Gtk.Widget.Set_Double_Buffered (Inherited)
Gtk.Widget.Set_Events (Inherited)
Gtk.Widget.Set_Extension_Events (Inherited)
Gtk.Widget.Set_Flags (Inherited)
Gtk.Widget.Set_Has_Tooltip (Inherited)
Gtk.Widget.Set_Name (Inherited)
Gtk.Widget.Set_No_Show_All (Inherited)
Gtk.Widget.Set_Parent (Inherited)
Gtk.Widget.Set_Parent_Window (Inherited)
Gtk.Widget.Set_Redraw_On_Allocate (Inherited)
Gtk.Widget.Set_Scroll_Adjustments (Inherited)
Gtk.Widget.Set_Sensitive (Inherited)
Gtk.Widget.Set_Size_Request (Inherited)
Gtk.Widget.Set_State (Inherited)
Gtk.Widget.Set_Style (Inherited)
Gtk.Widget.Set_Tooltip_Markup (Inherited)
Gtk.Widget.Set_Tooltip_Text (Inherited)
Gtk.Widget.Set_Tooltip_Window (Inherited)
Gtk.Widget.Set_UPosition (Inherited)
Gtk.Widget.Set_USize (Inherited)
Gtk.Widget.Set_Window (Inherited)
Gtk.Widget.Shape_Combine_Mask (Inherited)
Gtk.Widget.Show (Inherited)
Gtk.Widget.Show_All (Inherited)
Gtk.Widget.Show_Now (Inherited)
Gtk.Widget.Size_Allocate (Inherited)
Gtk.Widget.Size_Request (Inherited)
Gtk.Widget.Style_Get_Property (Inherited)
Gtk.Widget.Thaw_Child_Notify (Inherited)
Gtk.Widget.Trigger_Tooltip_Query (Inherited)
Gtk.Widget.Unmap (Inherited)
Gtk.Widget.Unrealize (Inherited)
Gtk.Widget.Unset_Flags (Inherited)
Propagate_Expose
Resize_Children
Set_Border_Width
Set_Focus_Chain
Set_Focus_Child
Set_Focus_Hadjustment
Set_Focus_Vadjustment
Set_Reallocate_Redraws
Set_Resize_Mode
Unset_Focus_Chain

Types

Gtk_Container

type Gtk_Container is access all Gtk_Container_Record'Class;

Gtk_Callback

type Gtk_Callback is
     access procedure (Item : access Gtk.Widget.Gtk_Widget_Record'Class);
Function that can be call for each child of a container. This is called automatically by the Forall subprogram below.

Constants & Global variables

Border_Width_Property (Glib.Properties.Property_Uint)

Border_Width_Property       : constant Glib.Properties.Property_Uint;

Reallocate_Redraws_Property (Glib.Properties.Property_Boolean)

Reallocate_Redraws_Property : constant Glib.Properties.Property_Boolean;

Signal_Add (Glib.Signal_Name)

Signal_Add             : constant Glib.Signal_Name := "add";

Signal_Check_Resize (Glib.Signal_Name)

Signal_Check_Resize    : constant Glib.Signal_Name := "check_resize";

Signal_Remove (Glib.Signal_Name)

Signal_Remove          : constant Glib.Signal_Name := "remove";

Signal_Set_Focus_Child (Glib.Signal_Name)

Signal_Set_Focus_Child : constant Glib.Signal_Name := "set-focus-child";

Subprograms & Entries

Get_Type

function Get_Type return Glib.GType;
Return the internal value associated with a Gtk_Container.

Set_Border_Width

procedure Set_Border_Width 
(Container: access Gtk_Container_Record;
Border_Width: Guint);

Get_Border_Width

function Get_Border_Width 
(Container: access Gtk_Container_Record) return Guint;
Modify the size of the frame that surrounds the widget. The exact visual impact depends on the specific widget class.

Add

procedure Add 
(Container: access Gtk_Container_Record;
Widget: access Gtk.Widget.Gtk_Widget_Record'Class);
Add a new child to the container. Note that some containers can have only one child. Nothing is done if there is already a child. This basically sends the "add" signal (see below)

Remove

procedure Remove 
(Container: access Gtk_Container_Record;
Widget: access Gtk.Widget.Gtk_Widget_Record'Class);
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 while it's not inside a container, using Glib.Object.Ref. If you don't want to use Widget again it's usually more efficient to simply destroy it directly using Gtk.Widget.Destroy since this will remove it from the container and help break any circular reference count cycles.

Set_Resize_Mode

procedure Set_Resize_Mode 
(Container: access Gtk_Container_Record;
Resize_Mode: Gtk.Enums.Gtk_Resize_Mode);

Get_Resize_Mode

function Get_Resize_Mode 
(Container: access Gtk_Container_Record) return Gtk.Enums.Gtk_Resize_Mode;
Change the resizing behavior for the Container. The default value is Resize_Parent.

Get_Children

function Get_Children 
(Container: access Gtk_Container_Record) return Gtk.Widget.Widget_List.Glist;
Return a list of all the children of the container. The caller must free the returned list.

Propagate_Expose

procedure Propagate_Expose 
(Container: access Gtk_Container_Record;
Child: access Gtk.Widget.Gtk_Widget_Record'Class;
Event: Gdk.Event.Gdk_Event_Expose);
When a container receives an expose event, it must send synthetic expose events to all children that don't have their own Gdk_Window. This function provides a convenient way of doing this. A container, when it receives an expose event, 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 expose implementation from Gtk_Container, or, do some drawing and then chain to the expose implementation from Gtk_Container.

Set_Focus_Chain

procedure Set_Focus_Chain 
(Container: access Gtk_Container_Record;
Focusable_Widgets: Gtk.Widget.Widget_List.Glist);
Set the chain of widgets that can take the focus for a given Container. The list should be freed by the user. This list indicates in which order the widgets will get the focus when the user presses tab or the arrow keys to move from one widget to the next.

Get_Focus_Chain

procedure Get_Focus_Chain 
(Container: access Gtk_Container_Record;
Focusable_Widgets: out Gtk.Widget.Widget_List.Glist;
Success: out Boolean);
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, GTK+ stores null in Focusable_Widgets and returns FALSE. The returned list must be freed by the user.

Unset_Focus_Chain

procedure Unset_Focus_Chain 
(Container: access Gtk_Container_Record);
Undoes the effect of Set_Focus_Chain

Set_Focus_Vadjustment

procedure Set_Focus_Vadjustment 
(Container: access Gtk_Container_Record;
Adjustment: Gtk.Adjustment.Gtk_Adjustment);

Get_Focus_Vadjustment

function Get_Focus_Vadjustment 
(Container: access Gtk_Container_Record) return Gtk.Adjustment.Gtk_Adjustment;
Set the focus to the vertical adjustment. Adjustment should have been created and displayed at some other place in your application. Container will make sure that Adjustment always matches the range for the focus widget's position (y .. y + height).

Set_Focus_Hadjustment

procedure Set_Focus_Hadjustment 
(Container: access Gtk_Container_Record;
Adjustment: Gtk.Adjustment.Gtk_Adjustment);

Get_Focus_Hadjustment

function Get_Focus_Hadjustment 
(Container: access Gtk_Container_Record) return Gtk.Adjustment.Gtk_Adjustment;
Set the focus to the horizontal adjustment. Adjustment should have been created and displayed at some other place in your application. Container will make sure that Adjustment always matches the range for the focus widget's position (x .. x + width).

Set_Focus_Child

procedure Set_Focus_Child 
(Container: access Gtk_Container_Record;
Child: access Gtk.Widget.Gtk_Widget_Record'Class);

Get_Focus_Child

function Get_Focus_Child 
(Container: access Gtk_Container_Record) return Gtk.Widget.Gtk_Widget;
Emit a "set_focus_child" signal, to set the child that currently has the keyboard focus.

Child_Set_Property

procedure Child_Set_Property 
(Container: access Gtk_Container_Record;
Child: access Gtk.Widget.Gtk_Widget_Record'Class;
Property_Name: String;
Value: Glib.Values.GValue);

Child_Get_Property

procedure Child_Get_Property 
(Container: access Gtk_Container_Record;
Child: access Gtk.Widget.Gtk_Widget_Record'Class;
Property_Name: String;
Value: out Glib.Values.GValue);
Sets or Gets the value of a child property for Child and Container. This is property set at the container level, and that applies to all children of that container. These are special type of properties, different from the properties associated with each type of widget. See also Gtk.Widget.Child_Notify You should use Glib.Property_Name to get the name from the property declaration in each of the GtkAda packages

Class_Find_Child_Property

function Class_Find_Child_Property 
(Cclass: Glib.Object.GObject_Class;
Property_Name: String) return Glib.Param_Spec;
Finds a child property of a container class by name. The returned value describes the property (type, allowed range, description,...) You should use Glib.Property_Name to get the name from the property declaration in each of the GtkAda packages

Class_Install_Child_Property

procedure Class_Install_Child_Property 
(Cclass: Glib.Object.GObject_Class;
Property_Id: Guint;
Pspec: Glib.Param_Spec);
Installs a child property on a container class. The Property_Id is an custom id that you choose for your class. It will be used in signals that set or get the property, instead of passing around a string.

Class_List_Child_Properties

function Class_List_Child_Properties 
(Cclass: Glib.Object.GObject_Class) return Glib.Param_Spec_Array;
Returns all child properties of a container class.

Forall

procedure Forall 
(Container: access Gtk_Container_Record;
Func: Gtk_Callback);
Invokes Func on 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. See Gtk.Widget.Set_Composite_Name. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). See also the generic package Forall_Pkg if you want to pass some extra data to Func.

Foreach

procedure Foreach 
(Container: access Gtk_Container_Record;
Func: Gtk_Callback);
Invokes Func on each non-internal child of Container. See Forall for details on what constitutes an "internal" child.

Set_Reallocate_Redraws

procedure Set_Reallocate_Redraws 
(Container: access Gtk_Container_Record;
Needs_Redraws: Boolean := False);
Set the "needs_redraws" field. If Needs_Redraws is True, then a "draw" signal is emitted for the Container whenever one is emitted for a child.

Child_Type

function Child_Type 
(Container: access Gtk_Container_Record) return Gtk.Gtk_Type;
Return the type of the children in Container. If Container can contain any type of widget, Gtk_Type_None is returned.

Resize_Children

procedure Resize_Children 
(Container: access Gtk_Container_Record);
The container hasn't changed size but one of its children queued a resize request. Which means that the allocation is not sufficient for the requisition of some child. Run through the list of widgets and reallocate their size appropriately.

Check_Resize

procedure Check_Resize 
(Container: access Gtk_Container_Record);
Emit the "check_resize" signal

Children

function Children 
(Container: access Gtk_Container_Record) return Gtk.Widget.Widget_List.Glist renames Get_Children;
pragma Obsolescent;