2003-02-12 03:00:12 +01:00
<Type Name= "Label" FullName= "Gtk.Label" >
2003-04-05 01:13:02 +02:00
<TypeSignature Language= "C#" Value= "public class Label : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer= "Duncan Mak" />
2003-02-12 03:00:12 +01:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
<AssemblyVersion > 0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
2003-02-23 08:26:30 +01:00
<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>
2003-02-12 03:00:12 +01:00
<Docs >
2003-04-05 01:13:02 +02:00
<summary > A widget that displays a small to medium amount of text</summary>
<remarks >
<para >
This widget displays a small to medium amount of text, it is
the widget used by other widgets, such as <see
cref="T:Gtk.Button" /> and <see cref= "T:Gtk.MenuItem" /> for
displaying text.
</para>
<para >
Labels may contain mnemonics; mnemonics are underlined
characters in the label, used for keyboard navigation. To
provide the mnemonic, put an underscore before the mnemonic
character, such as "_File".
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > Creates a new label widget, containing the text in
<paramref name= "str" /> .</summary>
<param name= "str" > The text of the label, with an optional underscore to mark the mnemonic character</param>
<returns > a new <see cref= "T:Gtk.Label" /> widget</returns>
<remarks >
<para >
If characters in str are preceded by an underscore, they
are underlined. If you need a literal underscore character
in a label, use '__' (two underscores). The first
underlined character represents a keyboard accelerator
called a mnemonic. The mnemonic key can be used to
activate another widget, chosen automatically, or
explicitly using <see cref= "P:Gtk.Label.MnemonicWidget" /> .
</para>
<para >
If <see cref= "P:Gtk.Label.MnemonicWidget" /> is not set, then the
first activatable ancestor of the <see cref= "T:Gtk.Label" /> will be chosen
as the mnemonic widget. For instance, if the label is
inside a button or menu item, the button or menu item will
automatically become the mnemonic widget and be activated
by the mnemonic.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-02-23 08:26:30 +01:00
<summary > Disposes the resources associated with the object.</summary>
<remarks />
2003-02-12 03:00:12 +01:00
</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 >
2003-02-23 08:26:30 +01:00
<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>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary >
Creates a new label with the given text inside it. You can
pass <see cref= "langword:null" /> to get an empty label
widget.
</summary>
<param name= "str" > The text of the label</param>
<returns > the new label widget</returns>
<remarks >
<para >
Creates a new label with the given text inside it. You can
pass <see cref= "langword:null" /> to get an empty label
widget.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-02-23 08:26:30 +01:00
<summary > The GLib Type for Gtk.Label</summary>
2003-03-07 02:30:00 +01:00
<returns > The GLib Type for the Gtk.Label class.</returns>
2003-02-23 08:26:30 +01:00
<remarks />
2003-02-12 03:00:12 +01:00
</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>
2003-04-05 01:13:02 +02:00
<remarks >
<para >
Sets the label's text from the string <paramref
name="str"/>. If characters in <paramref name= "str" /> are preceded by an
underscore, they are underlined indicating that they
represent a keyboard accelerator called a mnemonic. The
mnemonic key can be used to activate another widget,
chosen automatically, or explicitly using
<see cref= "M:Gtk.Label.MnemonicWidget" /> .
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > Parses str which is marked up with the Pango text markup language</summary>
<param name= "value" > a markup string (see Pango markup format)</param>
<returns > a GtkLabel</returns>
<remarks >
<para >
Parses <paramref name= "str" /> which is marked up with the
Pango text markup language, setting the label's text and
attribute list based on the parse results.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > Toggles line wrapping within the GtkLabel widget.</summary>
<param name= "value" >
<see cref= "langword:true" /> makes it
break lines if text exceeds the widget's size. <see cref= "langword:false" /> lets the text get cut off by the edge
of the widget if it exceeds the widget size.
</param>
<returns > <see cref= "langword:true" /> if the lines of the label are automatically wrapped.</returns>
<remarks />
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > The text within the GtkLabel widget.</summary>
<param name= "value" > The text you want to set.</param>
<returns > a GtkLabel</returns>
<remarks >
<para >
When setting the text within the GtkLabel widget, it overwrites any text that was there before.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</Docs>
</Member>
<Member MemberName= "Layout" >
<MemberSignature Language= "C#" Value= "public Pango.Layout Layout { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.Layout</ReturnType>
</ReturnValue>
<Docs >
2003-04-05 01:13:02 +02:00
<summary > Gets the PangoLayout used to display the label.</summary>
<returns > the PangoLayout for this label</returns>
<remarks >
<para >
Gets the PangoLayout used to display the label. The layout
is useful to e.g. convert text positions to pixel
positions, in combination with <see
cref="M:Gtk.Label.GetLayoutOffset" />. The returned layout
is owned by the label so need not be freed by the caller.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary >
Parses <paramref name= "str" /> which is marked up with the
Pango text markup language, setting the label's text and
attribute list based on the parse results.
</summary>
<param name= "value" > a markup string (see Pango markup format)</param>
<returns > a new label widget</returns>
<remarks >
<para >
Parses <paramref name= "str" /> which is marked up with the
Pango text markup language, setting the label's text and
attribute list based on the parse results. If characters
in str are preceded by an underscore, they are underlined
indicating that they represent a keyboard accelerator
called a mnemonic.
</para>
<para >
The mnemonic key can be used to activate another widget,
chosen automatically, or explicitly using <see
cref="M:Gtk.Label.MnemonicWidget" />.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > Toggle whether or not the label allow the user to select text from the label, for copy-and-paste.</summary>
<param name= "value" >
<see cref= "langword:true" /> to allow selecting text in the
label, and <see cref= "langword:false" /> to disallow.
</param>
<returns >
<see cref= "langword:true" /> if the label is selectable, and
<see cref= "langword:false" /> if not.
</returns>
<remarks />
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > The alignment of the lines in the text of the label relative to each other</summary>
<param name= "value" > a <see cref= "T:Gtk.Justification" /> </param>
<returns > The justification of the label</returns>
<remarks >
<para >
Sets the alignment of the lines in the text of the label
relative to each other. <see
cref="T:Gtk.Justification.Left" /> is the default value
when the widget is first created with <see
cref="C:Gtk.Label" />. If you instead want to set the
alignment of the label as a whole, set <see
cref="P:Gtk.Misc.Alignment" /> instead. This has no effect
on labels containing only a single line.
</para>
</remarks>
2003-02-12 03:00:12 +01:00
</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 >
2003-04-05 01:13:02 +02:00
<summary > Whether the label's text is interpreted as marked up with the Pango text markup language.</summary>
<param name= "value" > <see cref= "langword:true" /> to parse the
text as Pango markup, <see cref= "langword:false" /> as plain-text</param>
<returns />
<remarks />
2003-02-12 03:00:12 +01:00
</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>
2003-03-07 02:30:00 +01:00
<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>
2003-02-12 03:00:12 +01:00
</Members>
</Type>
