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

306 lines
13 KiB
XML

<Type Name="Layout" FullName="Gtk.Layout">
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class Layout : Gtk.Container, Gtk.Scrollable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Layout extends Gtk.Container implements class GLib.IWrapper, class Gtk.Scrollable" />
<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.Container</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gtk.Scrollable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Infinite scrollable area containing child widgets and/or custom drawing</summary>
<remarks>
<see cref="T:Gtk.Layout" /> is similar to <see cref="T:Gtk.DrawingArea" /> in that it is a "blank slate" and does not do anything but paint a blank background by default. It is different in that it supports scrolling natively (you can add it to a <see cref="T:Gtk.ScrolledWindow" />), and it can contain child widgets, since it is a <see cref="T:Gtk.Container" />. However, if you are just going to draw, a <see cref="T:Gtk.DrawingArea" /> is a better choice, since it has lower overhead.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (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 Layout (Gtk.Adjustment hadjustment, Gtk.Adjustment vadjustment);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gtk.Adjustment hadjustment, class Gtk.Adjustment vadjustment) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="hadjustment" Type="Gtk.Adjustment" />
<Parameter Name="vadjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<param name="hadjustment">an object of type <see cref="T:Gtk.Adjustment" /></param>
<param name="vadjustment">an object of type <see cref="T:Gtk.Adjustment" /></param>
<summary>Creates a new <see cref="T:Gtk.Layout" /> object.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="BinWindow">
<MemberSignature Language="C#" Value="public Gdk.Window BinWindow { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Window BinWindow" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Docs>
<summary>The window object for this layout widget.</summary>
<value>a <see cref="T:Gdk.Window" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (out uint width, out uint height);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetSize(unsigned int32 width, unsigned int32 height) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.UInt32&amp;" RefType="out" />
<Parameter Name="height" Type="System.UInt32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="width">an object of type <see cref="T:System.UInt32" /></param>
<param name="height">an object of type <see cref="T:System.UInt32" /></param>
<summary>Gets the size of the scrollbar area for the <see cref="T:Gtk.Layout" />.</summary>
<remarks>
</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.Layout" />.</remarks>
</Docs>
</Member>
<Member MemberName="Hadjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Hadjustment { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Adjustment Hadjustment" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("hadjustment")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The <see cref="T:Gtk.Adjustment" /> for the horizontal position.</summary>
<value>an object of type <see cref="T:Gtk.Adjustment" /></value>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public uint Height { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Height" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("height")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The height of the layout.</summary>
<value>an object of type <see cref="T:System.UInt32" /></value>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="HscrollPolicy">
<MemberSignature Language="C#" Value="public Gtk.ScrollablePolicy HscrollPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.ScrollablePolicy HscrollPolicy" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("hscroll-policy")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.ScrollablePolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<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>
<ReturnValue>
<ReturnType>Gtk.Container+ContainerChild</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child" Type="Gtk.Widget" />
</Parameters>
<Docs>
<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="Move">
<MemberSignature Language="C#" Value="public void Move (Gtk.Widget child_widget, int x, int y);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Move(class Gtk.Widget child_widget, int32 x, int32 y) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child_widget" Type="Gtk.Widget" />
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<param name="child_widget">an object of type <see cref="T:Gtk.Widget" /></param>
<param name="x">an object of type <see cref="T:System.Int32" /></param>
<param name="y">an object of type <see cref="T:System.Int32" /></param>
<summary>Moves a current child of <see cref="T:Gtk.Layout" /> to a new position.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Put">
<MemberSignature Language="C#" Value="public void Put (Gtk.Widget child_widget, int x, int y);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Put(class Gtk.Widget child_widget, int32 x, int32 y) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="child_widget" Type="Gtk.Widget" />
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<param name="child_widget">an object of type <see cref="T:Gtk.Widget" /></param>
<param name="x">an object of type <see cref="T:System.Int32" /></param>
<param name="y">an object of type <see cref="T:System.Int32" /></param>
<summary>Adds <paramref name="child_widget" /> to the <see cref="T:Gtk.Layout" />, at position (<paramref name="x" />, <paramref name="y" />).</summary>
<remarks>
<see cref="T:Gtk.Layout" /> becomes the new parent container of <paramref name="child_widget" />.</remarks>
</Docs>
</Member>
<Member MemberName="SetSize">
<MemberSignature Language="C#" Value="public void SetSize (uint width, uint height);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetSize(unsigned int32 width, unsigned int32 height) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.UInt32" />
<Parameter Name="height" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="width">an object of type <see cref="T:System.UInt32" /></param>
<param name="height">an object of type <see cref="T:System.UInt32" /></param>
<summary>Sets the size of the scrollable area for the <see cref="T:Gtk.Layout" />.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Vadjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Vadjustment { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.Adjustment Vadjustment" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("vadjustment")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The <see cref="T:Gtk.Adjustment" /> for the vertical position.</summary>
<value>an object of type <see cref="T:Gtk.Adjustment" /></value>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="VscrollPolicy">
<MemberSignature Language="C#" Value="public Gtk.ScrollablePolicy VscrollPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.ScrollablePolicy VscrollPolicy" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("vscroll-policy")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.ScrollablePolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public uint Width { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Width" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("width")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The width of the layout.</summary>
<value>an object of type <see cref="T:System.UInt32" /></value>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>