mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 18:35:38 +00:00
efa9acf122
* en/*/*.xml: Updated all the docs to match the new API. All the nodes that no longer have a corresponding member in the type are now marked as deprecated. We'll have to wait for Miguel to implement this in the browser to stop displaying them. All gtype constructors have been regenerated, because of the 'uint' to 'GLib.Type' change. However, this patch will preserve (well, it was regenerated) the customized text for those GType constructors. A lot of the 'Finalized' methods are also now marked as deprecated, because the classes implement 'Dispose' instead. This is a possible place for customized scripts to generate template documentation, similar to the GType property and GType constructors. svn path=/trunk/gtk-sharp/; revision=12270
500 lines
18 KiB
XML
500 lines
18 KiB
XML
<Type Name="Label" FullName="Gtk.Label">
|
|
<TypeSignature Language="C#" Value="public class Label : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
<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>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Misc</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="NewWithMnemonic">
|
|
<MemberSignature Language="C#" Value="public static Gtk.Label NewWithMnemonic (string str);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Label</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="str">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'Gtk.Label'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetSelectionBounds">
|
|
<MemberSignature Language="C#" Value="public bool GetSelectionBounds (int start, int end);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="start" Type="System.Int32" />
|
|
<Parameter Name="end" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="start">To be added: an object of type 'int'</param>
|
|
<param name="end">To be added: an object of type 'int'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectRegion">
|
|
<MemberSignature Language="C#" Value="public void SelectRegion (int start_offset, int end_offset);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="start_offset" Type="System.Int32" />
|
|
<Parameter Name="end_offset" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="start_offset">To be added: an object of type 'int'</param>
|
|
<param name="end_offset">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetLayoutOffsets">
|
|
<MemberSignature Language="C#" Value="public void GetLayoutOffsets (int x, int y);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="x" Type="System.Int32" />
|
|
<Parameter Name="y" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="x">To be added: an object of type 'int'</param>
|
|
<param name="y">To be added: an object of type 'int'</param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected virtual 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" Deprecated="true">
|
|
<MemberSignature Language="C#" Value="protected Label (uint gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of Label, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Label" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Label (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 Label, 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 Label (string str);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="str" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="str">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'Gtk.Label'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Label ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Gtk.Label'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The GLib Type for Gtk.Label</summary>
|
|
<returns>The GLib Type for the Gtk.Label class.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TextWithMnemonic">
|
|
<MemberSignature Language="C#" Value="public string TextWithMnemonic { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Markup">
|
|
<MemberSignature Language="C#" Value="public string Markup { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LineWrap">
|
|
<MemberSignature Language="C#" Value="public bool LineWrap { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Text">
|
|
<MemberSignature Language="C#" Value="public string Text { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Layout">
|
|
<MemberSignature Language="C#" Value="public Pango.Layout Layout { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Pango.Layout</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'Pango.Layout'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MarkupWithMnemonic">
|
|
<MemberSignature Language="C#" Value="public string MarkupWithMnemonic { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Selectable">
|
|
<MemberSignature Language="C#" Value="public bool Selectable { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Justify">
|
|
<MemberSignature Language="C#" Value="public Gtk.Justification Justify { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Justification</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.Justification" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.Justification'</param>
|
|
<returns>To be added: an object of type 'Gtk.Justification'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CursorPosition">
|
|
<MemberSignature Language="C#" Value="public int CursorPosition { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'int'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectionBound">
|
|
<MemberSignature Language="C#" Value="public int SelectionBound { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'int'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MnemonicWidget">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget MnemonicWidget { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'Gtk.Widget'</param>
|
|
<returns>To be added: an object of type 'Gtk.Widget'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LabelProp">
|
|
<MemberSignature Language="C#" Value="public string LabelProp { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Pattern">
|
|
<MemberSignature Language="C#" Value="public string Pattern { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'string'</param>
|
|
<returns>To be added: an object of type 'string'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MnemonicKeyval">
|
|
<MemberSignature Language="C#" Value="public uint MnemonicKeyval { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>To be added: an object of type 'uint'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Wrap">
|
|
<MemberSignature Language="C#" Value="public bool Wrap { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UseUnderline">
|
|
<MemberSignature Language="C#" Value="public bool UseUnderline { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UseMarkup">
|
|
<MemberSignature Language="C#" Value="public bool UseMarkup { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'bool'</param>
|
|
<returns>To be added: an object of type 'bool'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Attributes">
|
|
<MemberSignature Language="C#" Value="public Pango.AttrList Attributes { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Pango.AttrList</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="Pango.AttrList" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="value">To be added: an object of type 'Pango.AttrList'</param>
|
|
<returns>To be added: an object of type 'Pango.AttrList'</returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MoveCursor">
|
|
<MemberSignature Language="C#" Value="public event GtkSharp.MoveCursorHandler MoveCursor;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PopulatePopup">
|
|
<MemberSignature Language="C#" Value="public event GtkSharp.PopulatePopupHandler PopulatePopup;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CopyClipboard">
|
|
<MemberSignature Language="C#" Value="public event EventHandler CopyClipboard;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Label (GLib.Type gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Internal constructor</summary>
|
|
<param name="gtype">GLib type for the type</param>
|
|
<returns>Creates a new instance of Label, using the GLib-provided type</returns>
|
|
<remarks>
|
|
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Label" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |