mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 18:35:38 +00:00
320 lines
14 KiB
XML
320 lines
14 KiB
XML
<Type Name="Alignment" FullName="Gtk.Alignment">
|
|
<TypeSignature Language="C#" Value="public class Alignment : Gtk.Bin, Implementor, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<AssemblyCulture>neutral</AssemblyCulture>
|
|
<Attributes />
|
|
</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>A container that controls the alignment and size of its child.</summary>
|
|
<remarks>
|
|
<para>An Alignment widget controls the alignment and size of its child widget. It has four settings: <see cref="P:Gtk.Alignment.Xscale" />, <see cref="P:Gtk.Alignment.Yscale" />, <see cref="P:Gtk.Alignment.Xalign" />, and <see cref="P:Gtk.Alignment.Yalign" />.</para>
|
|
<para>The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).</para>
|
|
<para>The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect.</para>
|
|
<para>To add a child to an Alignment, use the <see cref="M:Gtk.Container.Add" /> method from the <see cref="T:Gtk.Container" /> class.</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Bin</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>Atk.Implementor</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (float xalign, float yalign, float xscale, float yscale);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xalign" Type="System.Single" />
|
|
<Parameter Name="yalign" Type="System.Single" />
|
|
<Parameter Name="xscale" Type="System.Single" />
|
|
<Parameter Name="yscale" Type="System.Single" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adjusts all the alignment and scale properties.</summary>
|
|
<param name="xalign">The horizontal alignment of the child widget, from 0 (left) to 1 (right).</param>
|
|
<param name="yalign">The vertical alignment of the child widget, from 0 (top) to 1 (bottom).</param>
|
|
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
|
|
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
|
|
<remarks>
|
|
<para>For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Disposes the resources associated with the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Alignment (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>
|
|
<returns>An instance of Alignment, wrapping the C object.</returns>
|
|
<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 Alignment (float xalign, float yalign, float xscale, float yscale);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="xalign" Type="System.Single" />
|
|
<Parameter Name="yalign" Type="System.Single" />
|
|
<Parameter Name="xscale" Type="System.Single" />
|
|
<Parameter Name="yscale" Type="System.Single" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new Alignment with the specified alignment and spacing.</summary>
|
|
<param name="xalign">The horizontal alignment of the child widget, from 0 (left) to 1 (right).</param>
|
|
<param name="yalign">The vertical alignment of the child widget, from 0 (top) to 1 (bottom).</param>
|
|
<param name="xscale">The amount that the child widget expands horizontally to fill up unused space, from 0 to 1.</param>
|
|
<param name="yscale">The amount that the child widget expands vertically to fill up unused space, from 0 to 1.</param>
|
|
<returns>A new Alignment.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Yalign">
|
|
<MemberSignature Language="C#" Value="public float Yalign { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Single</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Manage the vertical alignment of the child widget.</summary>
|
|
<param name="value">A new vertical alignment for the child widget.</param>
|
|
<returns>The child widget's current vertical alignment.</returns>
|
|
<remarks>
|
|
<para>This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Xalign">
|
|
<MemberSignature Language="C#" Value="public float Xalign { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Single</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Manage the horizontal alignment of the child widget.</summary>
|
|
<param name="value">A new horizontal alignment for the child widget.</param>
|
|
<returns>The child widget's current horizontal alignment.</returns>
|
|
<remarks>
|
|
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Xscale">
|
|
<MemberSignature Language="C#" Value="public float Xscale { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Single</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Manage the horizontal expansion of the child widget.</summary>
|
|
<param name="value">The proportion that the child widget should expand horizontally.</param>
|
|
<returns>The current horizontal expansion of the child widget.</returns>
|
|
<remarks>
|
|
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Yscale">
|
|
<MemberSignature Language="C#" Value="public float Yscale { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Single</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Manage the vertical expansion of the child widget.</summary>
|
|
<param name="value">The proportion that the child widget should expand vertically.</param>
|
|
<returns>The current vertical expansion of the child widget.</returns>
|
|
<remarks>
|
|
<para>This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size.</para>
|
|
</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>
|
|
<returns>a <see cref="T:GLib.GType" /></returns>
|
|
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.Alignment" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Alignment (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>
|
|
<returns>a <see cref="T:Gtk.Alignment" /></returns>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LeftPadding">
|
|
<MemberSignature Language="C#" Value="public uint LeftPadding { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The padding to insert at the left of the child widget.</summary>
|
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="BottomPadding">
|
|
<MemberSignature Language="C#" Value="public uint BottomPadding { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The padding to insert at the bottom of the child widget.</summary>
|
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TopPadding">
|
|
<MemberSignature Language="C#" Value="public uint TopPadding { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The padding to insert at the top of the child widget.</summary>
|
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RightPadding">
|
|
<MemberSignature Language="C#" Value="public uint RightPadding { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The padding to insert at the right of the child widget.</summary>
|
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPadding">
|
|
<MemberSignature Language="C#" Value="public void GetPadding (out uint padding_top, out uint padding_bottom, out uint padding_left, out uint padding_right);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="padding_top" Type="System.UInt32&" RefType="out" />
|
|
<Parameter Name="padding_bottom" Type="System.UInt32&" RefType="out" />
|
|
<Parameter Name="padding_left" Type="System.UInt32&" RefType="out" />
|
|
<Parameter Name="padding_right" Type="System.UInt32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>
|
|
Gets the padding on the different sides of the widget.
|
|
</summary>
|
|
<param name="padding_top">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_bottom">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_left">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_right">a <see cref="T:System.UInt32" /></param>
|
|
<remarks>This is a convenience method.
|
|
See also <see cref="M:Gtk.Alignment.SetPadding" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetPadding">
|
|
<MemberSignature Language="C#" Value="public void SetPadding (uint padding_top, uint padding_bottom, uint padding_left, uint padding_right);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="padding_top" Type="System.UInt32" />
|
|
<Parameter Name="padding_bottom" Type="System.UInt32" />
|
|
<Parameter Name="padding_left" Type="System.UInt32" />
|
|
<Parameter Name="padding_right" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>
|
|
Sets the padding on the different sides of the widget.
|
|
</summary>
|
|
<param name="padding_top">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_bottom">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_left">a <see cref="T:System.UInt32" /></param>
|
|
<param name="padding_right">a <see cref="T:System.UInt32" /></param>
|
|
<remarks>
|
|
<para>
|
|
The padding adds blank space to the vertical or horizontal sides
|
|
of the widget. For instance, this can be used to indent the child
|
|
widget towards the right by adding padding on the left.
|
|
</para>
|
|
<para>
|
|
This is a convenience method; the properties can also
|
|
be set directly.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |