2003-02-21 18:59:11 +00:00
<Type Name= "Box" FullName= "Gtk.Box" >
2011-11-09 16:01:51 +00:00
<TypeSignature Language= "C#" Maintainer= "Lee Mallabone" Value= "public class Box : Gtk.Container, Gtk.Orientable" />
<TypeSignature Language= "ILAsm" Value= ".class public auto ansi beforefieldinit Box extends Gtk.Container implements class GLib.IWrapper, class Gtk.Orientable" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2011-11-09 16:01:51 +00:00
<Base >
<BaseTypeName > Gtk.Container</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > Gtk.Orientable</InterfaceName>
</Interface>
</Interfaces>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 21:50:19 +00:00
<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>
2003-02-23 07:26:30 +00:00
<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)" /> .
2003-02-18 21:50:19 +00:00
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
<Members >
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Box (IntPtr raw);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "raw" > Pointer to the C object.</param>
<summary > Internal constructor</summary>
2003-02-23 07:26:30 +00:00
<remarks >
2011-11-09 16:01:51 +00:00
<para > This is an internal constructor, and should not be used by user code.</para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Box (Gtk.Orientation orientation, int spacing);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Gtk.Orientation orientation, int32 spacing) cil managed" />
<MemberType > Constructor</MemberType>
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "orientation" Type= "Gtk.Orientation" />
<Parameter Name= "spacing" Type= "System.Int32" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "orientation" > To be added.</param>
<param name= "spacing" > To be added.</param>
<summary > To be added.</summary>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property valuetype GLib.GType GType" />
<MemberType > Property</MemberType>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > GType Property.</summary>
<value > a <see cref= "T:GLib.GType" /> </value>
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.Box" /> .</remarks>
</Docs>
</Member>
<Member MemberName= "Homogeneous" >
<MemberSignature Language= "C#" Value= "public bool Homogeneous { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance bool Homogeneous" />
<MemberType > Property</MemberType>
<Attributes >
<Attribute >
<AttributeName > GLib.Property("homogeneous")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Set the size of all child widgets to be the same</summary>
<value >
<see langword= "true" /> if child widgets size themselves equally, false otherwise.</value>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Item" >
<MemberSignature Language= "C#" Value= "public override Gtk.Container.ContainerChild this[Gtk.Widget child] { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gtk.Container/ContainerChild Item(class Gtk.Widget)" />
<MemberType > Property</MemberType>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.Container+ContainerChild</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "child" > To be added.</param>
<summary > To be added.</summary>
<value > To be added.</value>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName= "Orientation" >
<MemberSignature Language= "C#" Value= "public Gtk.Orientation Orientation { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance valuetype Gtk.Orientation Orientation" />
<MemberType > Property</MemberType>
<Attributes >
<Attribute >
<AttributeName > GLib.Property("orientation")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue >
<ReturnType > Gtk.Orientation</ReturnType>
</ReturnValue>
<Docs >
<summary > To be added.</summary>
<value > To be added.</value>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "PackEnd" >
<MemberSignature Language= "C#" Value= "public void PackEnd (Gtk.Widget child, bool expand, bool fill, uint padding);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void PackEnd(class Gtk.Widget child, bool expand, bool fill, unsigned int32 padding) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 21:50:19 +00:00
<param name= "child" > A widget to pack into the box.</param>
2004-08-24 17:01:00 +00:00
<param name= "expand" > If <see langword= "true" /> , the child widget will expand to use as much space as it is given.</param>
<param name= "fill" > If <see langword= "true" /> , the child widget will request as much space as is available.</param>
2003-02-18 21:50:19 +00:00
<param name= "padding" > The size (in pixels) of a border to place around the specified child widget.</param>
2011-11-09 16:01:51 +00:00
<summary > Add a widget to the 'end' of a box with the specified packing properties.</summary>
2003-02-23 07:26:30 +00:00
<remarks >
<para > To add a widget to the end of a box with default packing, use <see cref= "M:PackEnd()" /> </para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "PackStart" >
<MemberSignature Language= "C#" Value= "public void PackStart (Gtk.Widget child, bool expand, bool fill, uint padding);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void PackStart(class Gtk.Widget child, bool expand, bool fill, unsigned int32 padding) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
2011-11-09 16:01:51 +00:00
<Parameter Name= "expand" Type= "System.Boolean" />
<Parameter Name= "fill" Type= "System.Boolean" />
<Parameter Name= "padding" Type= "System.UInt32" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "child" > A widget to pack into the box.</param>
<param name= "expand" > If <see langword= "true" /> , the child widget will expand to use as much space as it is given.</param>
<param name= "fill" > If <see langword= "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>
<summary > Add a widget to the 'start' of a box with the specified packing properties.</summary>
2003-02-23 07:26:30 +00:00
<remarks >
2011-11-09 16:01:51 +00:00
<para > To add a widget to the start of a box with default packing, use <see cref= "M:PackStart()" /> </para>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2003-10-28 00:48:23 +00:00
<Member MemberName= "QueryChildPacking" >
<MemberSignature Language= "C#" Value= "public void QueryChildPacking (Gtk.Widget child, out bool expand, out bool fill, out uint padding, out Gtk.PackType pack_type);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void QueryChildPacking(class Gtk.Widget child, bool expand, bool fill, unsigned int32 padding, valuetype Gtk.PackType pack_type) cil managed" />
2003-10-28 00:48:23 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "expand" Type= "System.Boolean&" RefType= "out" />
<Parameter Name= "fill" Type= "System.Boolean&" RefType= "out" />
<Parameter Name= "padding" Type= "System.UInt32&" RefType= "out" />
<Parameter Name= "pack_type" Type= "Gtk.PackType&" RefType= "out" />
</Parameters>
<Docs >
2004-08-06 13:18:10 +00:00
<param name= "child" > the <see cref= "T:Gtk.Widget" /> of the child to query.</param>
<param name= "expand" > a <see cref= "T:System.Boolean&" /> , the returned value of the expand field in the BoxChild object.</param>
<param name= "fill" > a <see cref= "T:System.Boolean&" /> , the returned value of the fill field in the BoxChild object.</param>
<param name= "padding" > a <see cref= "T:System.UInt32&" /> , the retuned value of the padding field in the BoxChild object.</param>
<param name= "pack_type" > a <see cref= "T:Gtk.PackType&" /> , the returned value of the pack field in the BoxChild object.</param>
2011-11-09 16:01:51 +00:00
<summary > Returns information about how <paramref name= "child" /> is packed into <paramref name= "box" /> .</summary>
2004-08-06 13:18:10 +00:00
<remarks />
2003-10-28 00:48:23 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "ReorderChild" >
<MemberSignature Language= "C#" Value= "public void ReorderChild (Gtk.Widget child, int position);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void ReorderChild(class Gtk.Widget child, int32 position) cil managed" />
<MemberType > Method</MemberType>
2003-12-24 01:35:30 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-12-24 01:35:30 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "position" Type= "System.Int32" />
</Parameters>
2003-12-24 01:35:30 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
<summary > Alters the position of a child widget that has already been packed into a Box.</summary>
<remarks />
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "SetChildPacking" >
<MemberSignature Language= "C#" Value= "public void SetChildPacking (Gtk.Widget child, bool expand, bool fill, uint padding, Gtk.PackType pack_type);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void SetChildPacking(class Gtk.Widget child, bool expand, bool fill, unsigned int32 padding, valuetype Gtk.PackType pack_type) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<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" />
2003-12-24 01:35:30 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "child" > The child widget whose layout should be adjusted</param>
<param name= "expand" > If <see langword= "true" /> , the child widget will expand to use as much space as it is given.</param>
<param name= "fill" > If <see langword= "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>
<summary > Change the packing properties of a child that is currently in this box.</summary>
<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>
2003-12-24 01:35:30 +00:00
</Docs>
2011-11-09 16:01:51 +00:00
</Member>
<Member MemberName= "Spacing" >
<MemberSignature Language= "C#" Value= "public int Spacing { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32 Spacing" />
<MemberType > Property</MemberType>
2005-08-23 17:02:47 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("spacing")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-08-23 17:02:47 +00:00
</Attributes>
2011-11-09 16:01:51 +00:00
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
</Parameters>
2004-06-01 18:05:26 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Adjust the spacing between child widgets.</summary>
<value > The current pixel spacing between child widgets</value>
<remarks />
2004-11-08 15:03:02 +00:00
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2005-05-23 20:41:51 +00:00
</Type>
