<Type Name="Box" FullName="Gtk.Box"> <TypeSignature Language="C#" Value="public class Box : Gtk.Container, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" /> <AssemblyInfo> <AssemblyName>gtk-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> <Attributes /> </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> <summary>A Box is a Gtk container that holds an arbitrary number of widgets. This means its sole purpose is to provide layout, size and spacing for other widgets.</summary> <remarks> <para>A Box is a rectangular area organized into either a single row or a single column of child widgets, depending upon whether the box is horizontally or vertically oriented, respectively.</para> <para>A Box is abstract - specific layout containers are provided in its sub classes, including a horizontal box, (<see cref="T:Gtk.HBox" />), a vertical box (<see cref="T:Gtk.VBox" />), and button boxes, (<see cref="T:Gtk.ButtonBox" />).</para> <para> Widgets that are 'packed' into a box are considered to be the children of the box, and the box controls their layout. Properties such as <see cref="P:Homogeneous" /> control the layout of all the children in the box, whereas specific packing settings can be applied to each child individually, such as <see cref="M:SetChildPacking(Gtk.Widget,bool,bool,uint,Gtk.PackType)" />. </para> </remarks> </Docs> <Base> <BaseTypeName>Gtk.Container</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>Atk.Implementor</InterfaceName> </Interface> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> <Interface> <InterfaceName>GLib.IWrapper</InterfaceName> </Interface> <Interface> <InterfaceName>System.IDisposable</InterfaceName> </Interface> </Interfaces> <Attributes /> <Members> <Member MemberName="SetChildPacking"> <MemberSignature Language="C#" Value="public void SetChildPacking (Gtk.Widget child, bool expand, bool fill, uint padding, Gtk.PackType pack_type);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="fill" Type="System.Boolean" /> <Parameter Name="padding" Type="System.UInt32" /> <Parameter Name="pack_type" Type="Gtk.PackType" /> </Parameters> <Docs> <summary>Change the packing properties of a child that is currently in this box.</summary> <param name="child">The child widget whose layout should be adjusted</param> <param name="expand">If <lang keyword="true" />, the child widget will expand to use as much space as it is given.</param> <param name="fill">If <lang keyword="true" />, the child widget will request as much space as is available.</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param> <param name="pack_type">Whether this child widget should be packed from the beginning of the box, (eg. the left, or the top), or from the end, (eg. the right or the bottom)</param> <remarks> <para>It is more common to set any specific packing requirements on child widgets when they are initially added to the box. This can be done using <see cref="M:PackStart(Gtk.Widget,bool,bool,uint)" /> and <see cref="M:PackEnd(Gtk.Widget,bool,bool,uint)" />.</para> </remarks> </Docs> </Member> <Member MemberName="QueryChildPacking"> <MemberSignature Language="C#" Value="public void QueryChildPacking (Gtk.Widget child, bool expand, bool fill, uint padding, Gtk.PackType pack_type);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="fill" Type="System.Boolean" /> <Parameter Name="padding" Type="System.UInt32" /> <Parameter Name="pack_type" Type="Gtk.PackType" /> </Parameters> <Docs> <summary>To be added</summary> <param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="expand">To be added: an object of type 'bool'</param> <param name="fill">To be added: an object of type 'bool'</param> <param name="padding">To be added: an object of type 'uint'</param> <param name="pack_type">To be added: an object of type 'Gtk.PackType'</param> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="PackEnd"> <MemberSignature Language="C#" Value="public void PackEnd (Gtk.Widget widget);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="widget" Type="Gtk.Widget" /> </Parameters> <Docs> <summary>Add a widget to the 'end' of a box with default packing settings.</summary> <param name="widget">The child widget to add to the box.</param> <remarks> <para>The 'end' of a box is the right hand side in a <see cref="T:Gtk.HBox" /> and the bottom in a <see cref="T:Gtk.VBox" />.</para> </remarks> </Docs> </Member> <Member MemberName="PackStart"> <MemberSignature Language="C#" Value="public void PackStart (Gtk.Widget widget);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="widget" Type="Gtk.Widget" /> </Parameters> <Docs> <summary>Add a widget to the 'start' of a box with default packing settings.</summary> <param name="widget">The child widget to add to the box.</param> <remarks> <para>The 'start' of a box is the left hand side in a <see cref="T:Gtk.HBox" /> and the top in a <see cref="T:Gtk.VBox" />.</para> </remarks> </Docs> </Member> <Member MemberName="PackStart"> <MemberSignature Language="C#" Value="public void PackStart (Gtk.Widget child, bool expand, bool fill, uint padding);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="fill" Type="System.Boolean" /> <Parameter Name="padding" Type="System.UInt32" /> </Parameters> <Docs> <summary>Add a widget to the 'start' of a box with the specified packing properties.</summary> <param name="child">A widget to pack into the box.</param> <param name="expand">If <lang keyword="true" />, the child widget will expand to use as much space as it is given.</param> <param name="fill">If <lang keyword="true" />, the child widget will request as much space as is available.</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param> <remarks> <para>To add a widget to the start of a box with default packing, use <see cref="M:PackStart()" /></para> </remarks> </Docs> </Member> <Member MemberName="PackEnd"> <MemberSignature Language="C#" Value="public void PackEnd (Gtk.Widget child, bool expand, bool fill, uint padding);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="expand" Type="System.Boolean" /> <Parameter Name="fill" Type="System.Boolean" /> <Parameter Name="padding" Type="System.UInt32" /> </Parameters> <Docs> <summary>Add a widget to the 'end' of a box with the specified packing properties.</summary> <param name="child">A widget to pack into the box.</param> <param name="expand">If <lang keyword="true" />, the child widget will expand to use as much space as it is given.</param> <param name="fill">If <lang keyword="true" />, the child widget will request as much space as is available.</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param> <remarks> <para>To add a widget to the end of a box with default packing, use <see cref="M:PackEnd()" /></para> </remarks> </Docs> </Member> <Member MemberName="ReorderChild"> <MemberSignature Language="C#" Value="public void ReorderChild (Gtk.Widget child, int position);" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="child" Type="Gtk.Widget" /> <Parameter Name="position" Type="System.Int32" /> </Parameters> <Docs> <summary>Alters the position of a child widget that has already been packed into a Box.</summary> <param name="child">A widget that has already been packed into this box.</param> <param name="position"> <para>The new position for this widget, indexed from zero. If negative, the <paramref name="child" /> will be placed at the end of the box.</para> </param> <remarks /> </Docs> </Member> <Member MemberName="Finalize"> <MemberSignature Language="C#" Value="protected virtual void Finalize ();" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Disposes the resources associated with the object.</summary> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Box (IntPtr raw);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="raw" Type="System.IntPtr" /> </Parameters> <Docs> <summary>Internal constructor</summary> <param name="raw">Pointer to the C object.</param> <returns>An instance of Box, wrapping the C object.</returns> <remarks> <para>This is an internal constructor, and should not be used by user code.</para> </remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Box ();" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters /> <Docs> <summary>Internal constructor</summary> <returns /> <remarks /> </Docs> </Member> <Member MemberName="GType"> <MemberSignature Language="C#" Value="public static uint GType { get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.UInt32</ReturnType> </ReturnValue> <Docs> <summary>The GLib Type for Gtk.Box</summary> <returns>The GLib Type for the Gtk.Box class.</returns> <remarks /> </Docs> </Member> <Member MemberName="Spacing"> <MemberSignature Language="C#" Value="public int Spacing { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters> <Parameter Name="value" Type="System.Int32" /> </Parameters> <Docs> <summary>Adjust the spacing between child widgets.</summary> <param name="value">The number of pixels of space to put between child widgets.</param> <returns>The current pixel spacing between child widgets</returns> <remarks /> </Docs> </Member> <Member MemberName="Homogeneous"> <MemberSignature Language="C#" Value="public bool Homogeneous { set; get; };" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="value" Type="System.Boolean" /> </Parameters> <Docs> <summary>Set the size of all child widgets to be the same</summary> <param name="value">If <see langword="true" />, all child widgets are forced to have the same size, otherwise they appear at their preferred size.</param> <returns> <see langword="true" /> if child widgets size themselves equally, false otherwise.</returns> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Box (GLib.Type gtype);" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="gtype" Type="GLib.Type" /> </Parameters> <Docs> <summary>Internal constructor</summary> <param name="gtype">GLib type for the type</param> <returns>Creates a new instance of Box, using the GLib-provided type</returns> <remarks> <para>This is a constructor used by derivative types of <see cref="T:Gtk.Box" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para> </remarks> </Docs> </Member> </Members> </Type>