ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Box, HBox and VBox from Lee

Browse source 
svn path=/trunk/gtk-sharp/; revision=11705
This commit is contained in:
Miguel de Icaza 2003-02-18 21:50:19 +00:00
parent ff931046db
commit 5e4d158452
3 changed files with 116 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
doc/en/Gtk/Box.xml
View file

@ -5,10 +5,15 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>Box is not a thread-safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <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>To be added</remarks> <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> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Container</BaseTypeName> <BaseTypeName>Gtk.Container</BaseTypeName>
@ -43,13 +48,13 @@
<Parameter Name="pack_type" Type="Gtk.PackType" /> <Parameter Name="pack_type" Type="Gtk.PackType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Change the packing properties of a child that is currently in this box.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">The child widget whose layout should be adjusted</param>
<param name="expand">To be added: an object of type 'bool'</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">To be added: an object of type 'bool'</param> <param name="fill">If <lang keyword="true"/>, the child widget will request as much space as is available.</param>
<param name="padding">To be added: an object of type 'uint'</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param>
<param name="pack_type">To be added: an object of type 'Gtk.PackType'</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>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="QueryChildPacking"> <Member MemberName="QueryChildPacking">
@ -85,9 +90,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Add a widget to the 'end' of a box with default packing settings.</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">The child widget to add to the box.</param>
<remarks>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="PackStart"> <Member MemberName="PackStart">
@ -100,9 +105,9 @@
<Parameter Name="widget" Type="Gtk.Widget" /> <Parameter Name="widget" Type="Gtk.Widget" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Add a widget to the 'start' of a box with default packing settings.</summary>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param> <param name="widget">The child widget to add to the box.</param>
<remarks>To be added</remarks> <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> </Docs>
</Member> </Member>
<Member MemberName="PackStart"> <Member MemberName="PackStart">
@ -118,12 +123,12 @@
<Parameter Name="padding" Type="System.UInt32" /> <Parameter Name="padding" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Add a widget to the 'start' of a box with the specified packing properties.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">A widget to pack into the box.</param>
<param name="expand">To be added: an object of type 'bool'</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">To be added: an object of type 'bool'</param> <param name="fill">If <lang keyword="true"/>, the child widget will request as much space as is available.</param>
<param name="padding">To be added: an object of type 'uint'</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param>
<remarks>To be added</remarks> <remarks><para>To add a widget to the start of a box with default packing, use <see cref="M:PackStart()"/></para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PackEnd"> <Member MemberName="PackEnd">
@ -139,12 +144,12 @@
<Parameter Name="padding" Type="System.UInt32" /> <Parameter Name="padding" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Add a widget to the 'end' of a box with the specified packing properties.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">A widget to pack into the box.</param>
<param name="expand">To be added: an object of type 'bool'</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">To be added: an object of type 'bool'</param> <param name="fill">If <lang keyword="true"/>, the child widget will request as much space as is available.</param>
<param name="padding">To be added: an object of type 'uint'</param> <param name="padding">The size (in pixels) of a border to place around the specified child widget.</param>
<remarks>To be added</remarks> <remarks><para>To add a widget to the end of a box with default packing, use <see cref="M:PackEnd()"/></para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ReorderChild"> <Member MemberName="ReorderChild">
@ -158,10 +163,10 @@
<Parameter Name="position" Type="System.Int32" /> <Parameter Name="position" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Alters the position of a child widget that has already been packed into a Box.</summary>
<param name="child">To be added: an object of type 'Gtk.Widget'</param> <param name="child">A widget that has already been packed into this box.</param>
<param name="position">To be added: an object of type 'int'</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>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Finalize"> <Member MemberName="Finalize">
@ -172,8 +177,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy and free all resources used by this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -184,10 +189,10 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.Box'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -198,10 +203,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.Box'</returns> <returns>A C# Gtk.Box that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -210,9 +215,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<returns>To be added: an object of type 'Gtk.Box'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -222,9 +227,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns>A number that uniquely identifies this type in the GLib object system.</returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Spacing"> <Member MemberName="Spacing">
@ -237,10 +242,10 @@
<Parameter Name="value" Type="System.Int32" /> <Parameter Name="value" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adjust the spacing between child widgets.</summary>
<param name="value">To be added: an object of type 'int'</param> <param name="value">The number of pixels of space to put between child widgets.</param>
<returns>To be added: an object of type 'int'</returns> <returns>The current pixel spacing between child widgets</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Homogeneous"> <Member MemberName="Homogeneous">
@ -253,10 +258,10 @@
<Parameter Name="value" Type="System.Boolean" /> <Parameter Name="value" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set the size of all child widgets to be the same</summary>
<param name="value">To be added: an object of type 'bool'</param> <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>To be added: an object of type 'bool'</returns> <returns><see langword="true"/> if child widgets size themselves equally, false otherwise.</returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

52
doc/en/Gtk/HBox.xml
View file

@ -5,10 +5,14 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>HBox is not a thread safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>An HBox is a specific type of <see cref="T:Gtk.Container"/> for packing widgets horizontally.</summary>
<remarks>To be added</remarks> <remarks><para>Other ways of laying out widgets include using a vertical box, (see <see cref="T:Gtk.VBox"/>), a table, (see <see cref="T:Gtk.Table"/>), button boxes, etc.</para>
<para>
Useful methods for manipulating boxes can be found in the superclass for HBox, <see cref="T:Gtk.Box"/>.
</para>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Box</BaseTypeName> <BaseTypeName>Gtk.Box</BaseTypeName>
@ -37,8 +41,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes of this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -49,10 +53,10 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.HBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -63,10 +67,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkHBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.HBox'</returns> <returns>A C# Gtk.HBox that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -78,11 +82,11 @@
<Parameter Name="spacing" Type="System.Int32" /> <Parameter Name="spacing" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The main way to create a new HBox.</summary>
<param name="homogeneous">To be added: an object of type 'bool'</param> <param name="homogeneous">If <see langword="true"/>, all widgets in the box are forced to be equally sized.</param>
<param name="spacing">To be added: an object of type 'int'</param> <param name="spacing">The number of pixels to place between each widget in the box.</param>
<returns>To be added: an object of type 'Gtk.HBox'</returns> <returns><para>A new HBox</para></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -91,9 +95,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor, should not be used.</summary>
<returns>To be added: an object of type 'Gtk.HBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -103,9 +107,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns><para>A number that uniquely identifies this type in the GLib object system.</para></returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

51
doc/en/Gtk/VBox.xml
View file

@ -5,10 +5,13 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes /> <Attributes />
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement> <ThreadSafetyStatement>VBox is not a thread safe object</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>A VBox is a specific type of <see cref="T:Gtk.Container"/> for packing widgets vertically.</summary>
<remarks>To be added</remarks> <remarks><para>Other ways of laying out widgets include using a horizontal box, (see <see cref="T:Gtk.HBox"/>), a table, (see <see cref="T:Gtk.Table"/>), button boxes, etc.</para>
<para>
Useful methods for manipulating boxes can be found in the superclass for HBox, <see cref="T:Gtk.Box"/>.
</para></remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Box</BaseTypeName> <BaseTypeName>Gtk.Box</BaseTypeName>
@ -37,8 +40,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Disposes of this widget</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -49,10 +52,10 @@
<Parameter Name="gtype" Type="System.UInt32" /> <Parameter Name="gtype" Type="System.UInt32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor</summary>
<param name="gtype">To be added: an object of type 'uint'</param> <param name="gtype"></param>
<returns>To be added: an object of type 'Gtk.VBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -63,10 +66,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Used for language bindings only.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A pointer to a GtkVBox, as returned by the Gtk+ C API.</param>
<returns>To be added: an object of type 'Gtk.VBox'</returns> <returns>A C# Gtk.VBox that wraps the <paramref name="raw"/> parameter.</returns>
<remarks>To be added</remarks> <remarks><para>If you don't already know that you need this constructor, it should not be used.</para></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -78,11 +81,11 @@
<Parameter Name="spacing" Type="System.Int32" /> <Parameter Name="spacing" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The main way to create a new VBox</summary>
<param name="homogeneous">To be added: an object of type 'bool'</param> <param name="homogeneous">If <see langword="true"/>, all widgets in the box are forced to be equally sized.</param>
<param name="spacing">To be added: an object of type 'int'</param> <param name="spacing">The number of pixels to place between each widget in the box.</param>
<returns>To be added: an object of type 'Gtk.VBox'</returns> <returns><para>A new VBox</para></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -91,9 +94,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal constructor, should not be used.</summary>
<returns>To be added: an object of type 'Gtk.VBox'</returns> <returns></returns>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -103,9 +106,9 @@
<ReturnType>System.UInt32</ReturnType> <ReturnType>System.UInt32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the type of this object, as registered with the GLib object system.</summary>
<returns>To be added: an object of type 'uint'</returns> <returns><para>A number that uniquely identifies this type in the GLib object system.</para></returns>
<remarks>To be added</remarks> <remarks><para>Mostly for internal use.</para></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>