GtkSharp/doc/en/Gtk/AccelLabel.xml

186 lines
7.3 KiB
XML
Raw Normal View History

<Type Name="AccelLabel" FullName="Gtk.AccelLabel">
<TypeSignature Language="C#" Value="public class AccelLabel : Gtk.Label, Implementor, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
<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 widget that displays an accelerator key on the right of the text.</summary>
<remarks>
<para>
The <see cref="T:Gtk.AccelLabel" /> widget is a subclass of <see cref="T:Gtk.Label" /> that also displays an accelerator key on the right of the label text. The <see cref="T:Gtk.AccelLabel" /> widget is commonly used in menus to show the keyboard shortcuts for commands.
</para>
<para>
The accelerator key to display is not set explicitly instead, the <see cref="T:Gtk.AccelLabel" /> displays the accelerators which have been added to a particular widget. This widget is set by calling <see cref="P:Gtk.AccelLabel.AccelWidget" />.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Label</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="Refetch">
<MemberSignature Language="C#" Value="public bool Refetch ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Recreates the string representing the accelerator keys.</summary>
<returns>
<see langword="false" /> Default, since the strings are updated this is not needed</returns>
<remarks>
<para>
Recreates the string representing the accelerator keys. This should not be needed since the string is automatically updated whenever accelerators are added or removed from the associated widget.
</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 AccelLabel (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 AccelLabel, 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 AccelLabel (string str1ng);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates an accelerator label.</summary>
<param name="str1ng">The accelerator label.</param>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="AccelWidth">
<MemberSignature Language="C#" Value="public uint AccelWidth { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Returns the width needed to display the accelerator key(s).</summary>
<returns>The width needed to display the accelerator key(s)</returns>
<remarks>
<para>
Returns the width needed to display the accelerator key(s). This is used by menus to align all of the <see cref="T:Gtk.MenuItem" /> widgets, and shouldn't be needed by applications.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AccelClosure">
<MemberSignature Language="C#" Value="public IntPtr AccelClosure { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Sets the closure to be monitored by this accelerator label.</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>
<para>
Sets the closure to be monitored by this accelerator label. The closure must be connected to an accelerator group. See <see cref="P:Gtk.AccelLabel.AccelWidget" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AccelWidget">
<MemberSignature Language="C#" Value="public Gtk.Widget AccelWidget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Fetches the widget monitored by this acceleretaor label.</summary>
<param name="value">The widget to be monitored</param>
<returns>The object monitored by the accelerator label, or <see langword="null" /></returns>
<remarks>
<para>
Fetches the widget monitored by this acceleretaor label.
</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>The GLib Type assigned to this class.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Used internally.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected AccelLabel (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.AccelLabel" /></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>
</Members>
</Type>