237c8ca92d
* en/Gtk/Dialog.xml * en/Gtk/HBox.xml * en/Gtk/Image.xml * en/Gtk/Init.xml * en/Gtk/Invisible.xml * en/Gtk/Misc.xml * en/Gtk/NotebookTab.xml * en/Gtk/Paned.xml * en/Gtk/Quit.xml * en/Gtk/RedirectArgs.xml * en/Gtk/RulerMetric.xml * en/Gtk/Scale.xml * en/Gtk/ScrolledWindow.xml * en/Gtk/Selection.xml * en/Gtk/SelectionData.xml * en/Gtk/TargetEntry.xml * en/Gtk/TargetList.xml * en/Gtk/TargetPair.xml * en/Gtk/TextLogAttrCache.xml: Miscellaneous docs. * ChangeLog: fixes for 2 prior commit logs. svn path=/trunk/gtk-sharp/; revision=32985
251 lines
10 KiB
XML
251 lines
10 KiB
XML
<Type Name="Misc" FullName="Gtk.Misc">
|
|
<TypeSignature Language="C#" Value="public class Misc : Gtk.Widget, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="RJS" />
|
|
<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 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>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Widget</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="SetAlignment">
|
|
<MemberSignature Language="C#" Value="public void SetAlignment (float xalign, float yalign);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xalign" Type="System.Single" />
|
|
<Parameter Name="yalign" Type="System.Single" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the alignment of the widget.</summary>
|
|
<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>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetPadding">
|
|
<MemberSignature Language="C#" Value="public void SetPadding (int xpad, int ypad);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xpad" Type="System.Int32" />
|
|
<Parameter Name="ypad" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the amount of space to add around the widget.</summary>
|
|
<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>
|
|
</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 Misc (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 Misc, 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="protected Misc ();" />
|
|
<MemberType>Internal constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Internal constructor.</summary>
|
|
<returns>A <see cref="T:Gtk.Misc"/></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>The vertical alignment</summary>
|
|
<param name="value">The vertical alignment, from 0 (top) to 1 (bottom).</param>
|
|
<returns>The vertical alignment</returns>
|
|
<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>The horizontal alignment</summary>
|
|
<param name="value">The horizontal alignment, from 0 (left) to 1 (right).</param>
|
|
<returns>The horizontal alignment</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ypad">
|
|
<MemberSignature Language="C#" Value="public int Ypad { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<param name="value">The amount of space to add on the left and right of the widget, in pixels.</param>
|
|
<returns>The amount of space to add on the left and right of the widget, in pixels.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Xpad">
|
|
<MemberSignature Language="C#" Value="public int Xpad { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<param name="value">The amount of space to add on the top and bottom of the widget, in pixels.</param>
|
|
<returns>The amount of space to add on the top and bottom of the widget, in pixels.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPadding">
|
|
<MemberSignature Language="C#" Value="public void GetPadding (out int xpad, out int ypad);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xpad" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="ypad" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the padding in the X and Y directions of the widget. See <see cref="M:Gtk.Misc.SetPadding" />).</summary>
|
|
<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>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetAlignment">
|
|
<MemberSignature Language="C#" Value="public void GetAlignment (out float xalign, out float yalign);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xalign" Type="System.Single&" RefType="out" />
|
|
<Parameter Name="yalign" Type="System.Single&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the X and Y alignment of the widget within its allocation. See <see cref="M:Gtk.Misc.SetAlignment" />.</summary>
|
|
<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>
|
|
<remarks>
|
|
</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.Misc" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Misc (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.Misc" /></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=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Misc ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Protected constructor.</summary>
|
|
<returns>a <see cref="T:Gtk.Misc" /></returns>
|
|
<remarks>Protected constructor.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|