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

227 lines
9.7 KiB
XML

<Type Name="Misc" FullName="Gtk.Misc">
<TypeSignature Language="C#" Maintainer="RJS" Value="public class Misc : Gtk.Widget" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Misc extends Gtk.Widget" />
<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.Widget</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>A base class for widgets with alignments and padding.</summary>
<remarks>
<para>
The GtkMisc widget is an abstract widget which is not useful itself, but is used to derive subclasses which have alignment and padding attributes.
</para>
<para>
The horizontal and vertical padding attributes allows extra space to be added around the widget.
</para>
<para>
The horizontal and vertical alignment attributes enable the widget to be positioned within its allocated area. Note that if the widget is added to a container in such a way that it expands automatically to fill its allocated area, the alignment settings will not alter the widgets position.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Misc ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Protected constructor.</summary>
<remarks>Protected constructor.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Misc (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="GetAlignment">
<MemberSignature Language="C#" Value="public void GetAlignment (out float xalign, out float yalign);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetAlignment(float32 xalign, float32 yalign) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xalign" Type="System.Single&amp;" RefType="out" />
<Parameter Name="yalign" Type="System.Single&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="xalign">Location to store X alignment of misc, or <see langword="null" />.</param>
<param name="yalign">Location to store Y alignment of misc, or <see langword="null" />.</param>
<summary>Gets the X and Y alignment of the widget within its allocation. See <see cref="M:Gtk.Misc.SetAlignment" />.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="GetPadding">
<MemberSignature Language="C#" Value="public void GetPadding (out int xpad, out int ypad);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetPadding(int32 xpad, int32 ypad) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xpad" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="ypad" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="xpad">Location to store padding in the X direction, or <see langword="null" />.</param>
<param name="ypad">Location to store padding in the Y direction, or <see langword="null" />.</param>
<summary>Gets the padding in the X and Y directions of the widget. See <see cref="M:Gtk.Misc.SetPadding" />).</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.Misc" />.</remarks>
</Docs>
</Member>
<Member MemberName="SetAlignment">
<MemberSignature Language="C#" Value="public void SetAlignment (float xalign, float yalign);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAlignment(float32 xalign, float32 yalign) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xalign" Type="System.Single" />
<Parameter Name="yalign" Type="System.Single" />
</Parameters>
<Docs>
<param name="xalign">The horizontal alignment, from 0 (left) to 1 (right).</param>
<param name="yalign">The vertical alignment, from 0 (top) to 1 (bottom).</param>
<summary>Sets the alignment of the widget.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetPadding">
<MemberSignature Language="C#" Value="public void SetPadding (int xpad, int ypad);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPadding(int32 xpad, int32 ypad) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="xpad" Type="System.Int32" />
<Parameter Name="ypad" Type="System.Int32" />
</Parameters>
<Docs>
<param name="xpad">The amount of space to add on the left and right of the widget, in pixels.</param>
<param name="ypad">The amount of space to add on the top and bottom of the widget, in pixels.</param>
<summary>Sets the amount of space to add around the widget.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Xalign">
<MemberSignature Language="C#" Value="public float Xalign { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 Xalign" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("xalign")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The horizontal alignment</summary>
<value>The horizontal alignment</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Xpad">
<MemberSignature Language="C#" Value="public int Xpad { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Xpad" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("xpad")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The amount of space to add on the top and bottom of the widget, in pixels.</summary>
<value>The amount of space to add on the top and bottom of the widget, in pixels.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Yalign">
<MemberSignature Language="C#" Value="public float Yalign { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float32 Yalign" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("yalign")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The vertical alignment</summary>
<value>The vertical alignment</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Ypad">
<MemberSignature Language="C#" Value="public int Ypad { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Ypad" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("ypad")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The amount of space to add on the left and right of the widget, in pixels.</summary>
<value>The amount of space to add on the left and right of the widget, in pixels.</value>
<remarks />
</Docs>
</Member>
</Members>
</Type>