Ryujinx-GtkSharp/doc/en/Gtk/HBox.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

146 lines
5.1 KiB
XML

<Type Name="HBox" FullName="Gtk.HBox">
<TypeSignature Language="C#" Maintainer="Lee Mallabone" Value="public class HBox : Gtk.Box" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HBox extends Gtk.Box" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>Gtk.Box</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>An HBox is a specific type of <see cref="T:Gtk.Container" /> for packing widgets horizontally.</summary>
<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>
<example>
<code lang="C#">
using System;
using Gtk;
class HBoxTester {
static void Main ()
{
Application.Init ();
Window myWindow = new Window ("HBox Widget");
HBox myBox = new HBox (false, 4);
//Add some buttons to the horizontal box
AddButton (myBox);
AddButton (myBox);
//Add the box to a Window container
myWindow.Add (myBox);
myWindow.ShowAll ();
Application.Run ();
}
static void AddButton (HBox box)
{
box.PackStart (new Button ("Button"), true, false, 0);
}
}
</code>
</example>
<example>
<code lang="Visual Basic .NET">
Imports System
Imports Gtk
Class HBoxTester
Shared Sub Main ()
Application.Init ()
Dim myWindow As New Window ("HBox Widget")
Dim myBox As New HBox (False, 0)
' Add the box to a Window container
myWindow.Add (myBox)
myWindow.SetDefaultSize (250, 40)
' Add some buttons to the box
HBoxTester.AddButton (myBox)
HBoxTester.AddButton (myBox)
HBoxTester.AddButton (myBox)
myWindow.ShowAll ()
Application.Run ()
End Sub
Shared Sub AddButton (ByVal box As HBox)
box.PackStart (New Button ("Button"), True, False, 0)
End Sub
End Class
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HBox ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HBox (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<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="public HBox (bool homogeneous, int spacing);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool homogeneous, int32 spacing) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="homogeneous" Type="System.Boolean" />
<Parameter Name="spacing" Type="System.Int32" />
</Parameters>
<Docs>
<param name="homogeneous">If <see langword="true" />, all widgets in the box are forced to be equally sized.</param>
<param name="spacing">The number of pixels to place between each widget in the box.</param>
<summary>The main way to create a new HBox.</summary>
<remarks />
</Docs>
</Member>
<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>
<ReturnValue>
<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.HBox" />.</remarks>
</Docs>
</Member>
</Members>
</Type>