GtkSharp/doc/en/Gtk/Layout.xml
Mike Kestner 5b8c8ab531 2005-05-23 Mike Kestner <mkestner@novell.com>
* Makefile.am : add an update-delete target for --delete.
	* en/*/*.xml : update-delete.

svn path=/trunk/gtk-sharp/; revision=44918
2005-05-23 21:11:27 +00:00

315 lines
13 KiB
XML

<Type Name="Layout" FullName="Gtk.Layout">
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class Layout : Gtk.Container" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</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>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>
<Base>
<BaseTypeName>Gtk.Container</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMember(MemberName="Item")</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName="GetSize">
<MemberSignature Language="C#" Value="public void GetSize (out uint width, out uint height);" />
<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>
<summary>Gets the size of the scrollbar area for the <see cref="T:Gtk.Layout" />.</summary>
<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>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="SetSize">
<MemberSignature Language="C#" Value="public void SetSize (uint width, uint height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.UInt32" />
<Parameter Name="height" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Sets the size of the scrollable area for the <see cref="T:Gtk.Layout" />.</summary>
<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>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Move">
<MemberSignature Language="C#" Value="public void Move (Gtk.Widget child_widget, int x, int y);" />
<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>
<summary>Moves a current child of <see cref="T:Gtk.Layout" /> to a new position.</summary>
<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>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Put">
<MemberSignature Language="C#" Value="public void Put (Gtk.Widget child_widget, int x, int y);" />
<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>
<summary>Adds <paramref name="child_widget" /> to the <see cref="T:Gtk.Layout" />, at position (<paramref name="x" />, <paramref name="y" />).</summary>
<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>
<remarks>
<see cref="T:Gtk.Layout" /> becomes the new parent container of <paramref name="child_widget" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Layout (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>
<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);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="hadjustment" Type="Gtk.Adjustment" />
<Parameter Name="vadjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.Layout" /> object.</summary>
<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>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public uint Width { set; get; };" />
<MemberType>Property</MemberType>
<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>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="width")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="Hadjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Hadjustment { set; get; };" />
<MemberType>Property</MemberType>
<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>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="hadjustment")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="Vadjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Vadjustment { set; get; };" />
<MemberType>Property</MemberType>
<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>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="vadjustment")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public uint Height { set; get; };" />
<MemberType>Property</MemberType>
<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>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="height")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="ScrollAdjustmentsSet">
<MemberSignature Language="C#" Value="public event Gtk.ScrollAdjustmentsSetHandler ScrollAdjustmentsSet;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gtk.ScrollAdjustmentsSetHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Fired whenever the scroll adjustment units are set for this widget.</summary>
<remarks />
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal(CName="set_scroll_adjustments")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="BinWindow">
<MemberSignature Language="C#" Value="public Gdk.Window BinWindow { get; };" />
<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="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<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="OnScrollAdjustmentsSet">
<MemberSignature Language="C#" Value="protected virtual void OnScrollAdjustmentsSet (Gtk.Adjustment hadjustment, Gtk.Adjustment vadjustment);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hadjustment" Type="Gtk.Adjustment" />
<Parameter Name="vadjustment" Type="Gtk.Adjustment" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Layout.ScrollAdjustmentsSet" /> event.</summary>
<param name="hadjustment">a <see cref="T:Gtk.Adjustment" /></param>
<param name="vadjustment">a <see cref="T:Gtk.Adjustment" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Layout.ScrollAdjustmentsSet" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Layout (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="Thaw">
<MemberSignature Language="C#" Value="public void Thaw ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deprecated. Do not use.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Freeze">
<MemberSignature Language="C#" Value="public void Freeze ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deprecated. Do not use.</summary>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>