2003-02-12 02:00:12 +00:00
<Type Name= "Label" FullName= "Gtk.Label" >
2005-05-23 20:41:51 +00:00
<TypeSignature Language= "C#" Maintainer= "Duncan Mak" Value= "public class Label : Gtk.Misc" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2007-12-06 18:37:54 +00:00
<AssemblyVersion > 2.12.0.0</AssemblyVersion>
2003-02-12 02:00:12 +00:00
</AssemblyInfo>
2003-02-23 07:26:30 +00: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 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00: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
2003-05-08 20:26:02 +00:00
the widget used by other widgets, such as <see cref= "T:Gtk.Button" /> and <see cref= "T:Gtk.MenuItem" /> for
2003-04-04 23:13:02 +00:00
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 02:00:12 +00:00
</Docs>
<Base >
<BaseTypeName > Gtk.Misc</BaseTypeName>
</Base>
2007-01-16 16:18:05 +00:00
<Interfaces >
</Interfaces>
2003-02-12 02:00:12 +00:00
<Members >
<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 >
2003-07-29 23:02:50 +00:00
<Parameter Name= "start_offset" Type= "System.Int32" />
<Parameter Name= "end_offset" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary > Selects a range of characters in the label, if the label is selectable.</summary>
<param name= "start_offset" > start offset (in characters not bytes)</param>
<param name= "end_offset" > end offset (in characters not bytes)</param>
<remarks >
<para >
Selects a range of characters in the label, if the label
is selectable. See <see cref= "P:Gtk.Label.Selectable" /> . If the
label is not selectable, this function has no effect. If
2003-07-31 21:44:39 +00:00
<paramref name= "start_offset" /> or
<paramref name= "end_offset" /> are -1, then the end of the
2003-07-29 23:02:50 +00:00
label will be substituted.
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Label (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-07-29 23:02:50 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<summary > Internal constructor</summary>
<param name= "raw" > Pointer to the C object.</param>
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Label (string str);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-07-29 23:02:50 +00:00
<Parameter Name= "str" Type= "System.String" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary >
Creates a new label with the given text inside it. You can
2003-04-22 10:15:35 +00:00
pass <see langword= "null" /> to get an empty label
2003-04-04 23:13:02 +00:00
widget.
</summary>
2008-04-08 18:23:04 +00:00
<param name= "str" > The text of the label. Pass <see langword= "null" /> for no text.</param>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
Creates a new label with the given text inside it. You can
2003-04-22 10:15:35 +00:00
pass <see langword= "null" /> to get an empty label
2008-04-08 18:23:04 +00:00
widget. If <paramref name= "str" /> contains an underscore,
the <see cref= "P:Gtk.Lable.UseUnderline" /> property is
automatically set to <see langword= "true" /> .
2003-04-04 23:13:02 +00:00
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "TextWithMnemonic" >
<MemberSignature Language= "C#" Value= "public string TextWithMnemonic { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-01-09 01:32:46 +00:00
<summary > Sets the text of the label</summary>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
2004-01-09 01:32:46 +00:00
Sets the text of the label. If characters in <paramref name= "value" />
2003-07-29 23:02:50 +00:00
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" /> .
2003-04-04 23:13:02 +00:00
</para>
</remarks>
2005-05-23 20:41:51 +00:00
<value > To be added.</value>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Markup" >
<MemberSignature Language= "C#" Value= "public string Markup { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary > Parses str which is marked up with the Pango text markup language</summary>
2005-05-23 20:41:51 +00:00
<value > a GtkLabel</value>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
2003-07-29 23:02:50 +00:00
Parses <paramref name= "value" /> which is marked up with the
2004-01-09 01:32:46 +00:00
Pango text markup language, setting the text of the label and
2003-04-04 23:13:02 +00:00
attribute list based on the parse results.
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "LineWrap" >
<MemberSignature Language= "C#" Value= "public bool LineWrap { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary > Toggles line wrapping within the GtkLabel widget.</summary>
2005-05-23 20:41:51 +00:00
<value >
<see langword= "true" /> if the lines of the label are automatically wrapped.</value>
2003-04-04 23:13:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Text" >
<MemberSignature Language= "C#" Value= "public string Text { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-01-09 01:32:46 +00:00
<summary > The text within the <see cref= "T:Gtk.Label" /> widget.</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.String" /> </value>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
2004-01-09 01:32:46 +00:00
When setting the text within the <see cref= "T:Gtk.Label" /> widget, it overwrites any text that was there before.
2003-04-04 23:13:02 +00:00
</para>
</remarks>
2003-02-12 02:00:12 +00: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-07-29 23:02:50 +00:00
<summary > Gets the <see cref= "T:Pango.Layout" /> used to display the label.</summary>
2005-05-23 20:41:51 +00:00
<value > the <see cref= "T:Pango.Layout" /> for this label</value>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
2003-07-29 23:02:50 +00:00
Gets the <see cref= "T:Pango.Layout" /> used to display the label. The layout
2003-04-04 23:13:02 +00:00
is useful to e.g. convert text positions to pixel
2003-05-08 20:26:02 +00:00
positions, in combination with <see cref= "M:Gtk.Label.GetLayoutOffset" /> . The returned layout
2003-04-04 23:13:02 +00:00
is owned by the label so need not be freed by the caller.
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "MarkupWithMnemonic" >
<MemberSignature Language= "C#" Value= "public string MarkupWithMnemonic { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary >
2003-07-29 23:02:50 +00:00
Parses <paramref name= "value" /> which is marked up with the
2004-01-09 01:32:46 +00:00
Pango text markup language, setting the text of the label and
2003-04-04 23:13:02 +00:00
attribute list based on the parse results.
</summary>
2005-05-23 20:41:51 +00:00
<value > a new label widget</value>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
2003-07-29 23:02:50 +00:00
Parses <paramref name= "value" /> which is marked up with the
2004-01-09 01:32:46 +00:00
Pango text markup language, setting the text of the label and
2003-04-04 23:13:02 +00:00
attribute list based on the parse results. If characters
2004-01-09 01:32:46 +00:00
in the string are preceded by an underscore, they are underlined
2003-04-04 23:13:02 +00:00
indicating that they represent a keyboard accelerator
called a mnemonic.
</para>
<para >
The mnemonic key can be used to activate another widget,
2003-05-08 20:26:02 +00:00
chosen automatically, or explicitly using <see cref= "M:Gtk.Label.MnemonicWidget" /> .
2003-04-04 23:13:02 +00:00
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "Selectable" >
<MemberSignature Language= "C#" Value= "public bool Selectable { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary > Toggle whether or not the label allow the user to select text from the label, for copy-and-paste.</summary>
2005-05-23 20:41:51 +00:00
<value >
2003-04-22 10:15:35 +00:00
<see langword= "true" /> if the label is selectable, and
<see langword= "false" /> if not.
2005-05-23 20:41:51 +00:00
</value>
2003-04-04 23:13:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("selectable")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Justify" >
<MemberSignature Language= "C#" Value= "public Gtk.Justification Justify { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.Justification</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-04-04 23:13:02 +00:00
<summary > The alignment of the lines in the text of the label relative to each other</summary>
2005-05-23 20:41:51 +00:00
<value > The justification of the label</value>
2003-04-04 23:13:02 +00:00
<remarks >
<para >
Sets the alignment of the lines in the text of the label
2003-05-08 20:26:02 +00:00
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
2003-04-04 23:13:02 +00:00
on labels containing only a single line.
</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("justify")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "CursorPosition" >
<MemberSignature Language= "C#" Value= "public int CursorPosition { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
2003-07-29 23:02:50 +00:00
<summary > The current position of the insertion cursor in characters.</summary>
2005-05-23 20:41:51 +00:00
<value > The current position of the insertion cursor in characters</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("cursor-position")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "SelectionBound" >
<MemberSignature Language= "C#" Value= "public int SelectionBound { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Docs >
2003-07-29 23:02:50 +00:00
<summary > The position of the opposite end of the selection from the cursor in characters.</summary>
2005-05-23 20:41:51 +00:00
<value > The position of the opposite end of the selection from the cursor in characters.</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("selection-bound")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "MnemonicWidget" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget MnemonicWidget { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary > The widget to be activated when the label's mnemonic key is pressed.</summary>
2005-05-23 20:41:51 +00:00
<value > The widget to be activated when the label's mnemonic key is pressed.</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("mnemonic-widget")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "LabelProp" >
<MemberSignature Language= "C#" Value= "public string LabelProp { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-01-09 01:32:46 +00:00
<summary > The text from a label widget including any embedded underlines indicating mnemonics and Pango markup.</summary>
2005-05-23 20:41:51 +00:00
<value > The text of the label widget.</value>
2006-07-26 17:18:12 +00:00
<remarks > You can include markup tags to change your text appearance. See <see cref= "P:Gtk.Label.UseMarkup" /> for more information.</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("label")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Pattern" >
<MemberSignature Language= "C#" Value= "public string Pattern { set; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary > A string with _ characters in positions correspond to characters in the text to underline.</summary>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2005-05-23 20:41:51 +00:00
<value > To be added.</value>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("pattern")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "MnemonicKeyval" >
<MemberSignature Language= "C#" Value= "public uint MnemonicKeyval { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
<Docs >
2003-07-29 23:02:50 +00:00
<summary > The mnemonic accelerator key for this label.</summary>
2005-05-23 20:41:51 +00:00
<value > The mnemonic accelerator key for this label.</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("mnemonic-keyval")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Wrap" >
<MemberSignature Language= "C#" Value= "public bool Wrap { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary > Whether lines should be wrapped if the text becomes too wide.</summary>
2005-05-23 20:41:51 +00:00
<value > whether lines should be wrapped</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("wrap")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "UseUnderline" >
<MemberSignature Language= "C#" Value= "public bool UseUnderline { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary >
Whether an underline in the text indicates the next
character should be used for the mnemonic accelerator key.
</summary>
2005-05-23 20:41:51 +00:00
<value >
2003-07-29 23:02:50 +00:00
Whether an underline in the text indicates the next
character should be used for the mnemonic accelerator key.
2005-05-23 20:41:51 +00:00
</value>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("use-underline")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "UseMarkup" >
<MemberSignature Language= "C#" Value= "public bool UseMarkup { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2006-07-26 17:18:12 +00:00
<summary > Whether the label's text is interpreted as marked up with the Pango text markup language ( more information at http://developer.gnome.org/doc/API/2.0/pango/PangoMarkupFormat.html ).</summary>
<value >
<see langword= "true" /> if the label's text should be parsed for markup</value>
<remarks > Here are a few examples of the markup you can use:
2007-01-16 16:18:05 +00:00
<list type= "table" > <listheader > <term > Tag</term> <description > Description</description> </listheader> <item > <term > < b> </term> <description > Bold</description> </item> <item > <term > < big> </term> <description > Makes font relatively larger</description> </item> <item > <term > < i> </term> <description > Italic</description> </item> <item > <term > < s> </term> <description > Strikethrough</description> </item> <item > <term > < sub> </term> <description > Subscript</description> </item> <item > <term > < sup> </term> <description > Superscript</description> </item> <item > <term > < small> </term> <description > Makes font relatively smaller</description> </item> <item > <term > < tt> </term> <description > Monospace font</description> </item> <item > <term > < u> </term> <description > Underline</description> </item> </list> <example > <code lang= "C#" >
2006-07-26 17:18:12 +00:00
Gtk.Label label = new Gtk.Label();
label.LabelProp = "The brown < u> fox< /u> etc. and the < big> lazy< /big> dog";
label.UseMarkup = true;
</code> </example> </remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("use-markup")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Attributes" >
<MemberSignature Language= "C#" Value= "public Pango.AttrList Attributes { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.AttrList</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-29 23:02:50 +00:00
<summary > The attribute list set on the label.</summary>
2005-05-23 20:41:51 +00:00
<value > the attribute list set on the label</value>
2003-07-29 23:02:50 +00:00
<remarks >
<para >
This function does not reflect attributes that come from
the labels markup (see <see cref= "P:Gtk.Label.Markup" /> ). If you
want to get the effective attributes for the label, use
<see cref= "T:Pango.Layout.Attribute" /> on the label's
<see cref= "P:Gtk.Label.Layout" /> property.
</para>
2003-12-24 01:35:30 +00:00
<para >
</para>
2003-07-29 23:02:50 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("attributes")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "MoveCursor" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.MoveCursorHandler MoveCursor;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-07-29 23:02:50 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.MoveCursorHandler</ReturnType>
2003-07-29 23:02:50 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-07-29 23:02:50 +00:00
<summary > Emitted when the cursor is moved.</summary>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Signal("move_cursor")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "PopulatePopup" >
2004-02-25 23:39:06 +00:00
<MemberSignature Language= "C#" Value= "public event Gtk.PopulatePopupHandler PopulatePopup;" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2003-07-29 23:02:50 +00:00
<ReturnValue >
2004-02-25 23:39:06 +00:00
<ReturnType > Gtk.PopulatePopupHandler</ReturnType>
2003-07-29 23:02:50 +00:00
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-07-29 23:02:50 +00:00
<summary > Emitted when a right-click pop-up menu is displayed</summary>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Signal("populate_popup")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "CopyClipboard" >
<MemberSignature Language= "C#" Value= "public event EventHandler CopyClipboard;" />
<MemberType > Event</MemberType>
2003-07-29 23:02:50 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2003-07-29 23:02:50 +00:00
<summary > Emitted when text is copied to the clipboard.</summary>
2003-12-24 01:35:30 +00:00
<remarks >
</remarks>
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Signal("copy_clipboard")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-21 20:14:42 +00:00
<summary > GType Property.</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:GLib.GType" /> </value>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.Label" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnCopyClipboard" >
<MemberSignature Language= "C#" Value= "protected virtual void OnCopyClipboard ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Label.CopyClipboard" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Label.CopyClipboard" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnPopulatePopup" >
<MemberSignature Language= "C#" Value= "protected virtual void OnPopulatePopup (Gtk.Menu menu);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "menu" Type= "Gtk.Menu" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Label.PopulatePopup" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "menu" > a <see cref= "T:Gtk.Menu" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Label.PopulatePopup" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnMoveCursor" >
<MemberSignature Language= "C#" Value= "protected virtual void OnMoveCursor (Gtk.MovementStep step, int count, bool extend_selection);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "step" Type= "Gtk.MovementStep" />
<Parameter Name= "count" Type= "System.Int32" />
<Parameter Name= "extend_selection" Type= "System.Boolean" />
</Parameters>
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Label.MoveCursor" /> event.</summary>
2003-12-24 01:35:30 +00:00
<param name= "step" > a <see cref= "T:Gtk.MovementStep" /> </param>
<param name= "count" > a <see cref= "T:System.Int32" /> </param>
<param name= "extend_selection" > a <see cref= "T:System.Boolean" /> </param>
2004-06-15 15:41:25 +00:00
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Label.MoveCursor" /> event.</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2003-03-07 01:30:00 +00:00
<Member MemberName= ".ctor" >
2003-12-24 01:35:30 +00:00
<MemberSignature Language= "C#" Value= "protected Label (GLib.GType gtype);" />
2003-03-07 01:30:00 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-12-24 01:35:30 +00:00
<Parameter Name= "gtype" Type= "GLib.GType" />
2003-07-29 23:02:50 +00:00
</Parameters>
2003-03-07 01:30:00 +00:00
<Docs >
2004-01-09 01:32:46 +00:00
<summary > Internal constructor</summary>
2003-12-24 01:35:30 +00:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
2004-01-09 01:32:46 +00:00
<remarks > This is not typically used by C# code.</remarks>
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > System.Obsolete</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2004-01-09 01:32:46 +00:00
<Member MemberName= "New" >
<MemberSignature Language= "C#" Value= "public static Gtk.Label New (string str);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Label</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "str" Type= "System.String" />
</Parameters>
<Docs >
2004-08-29 08:55:30 +00:00
<summary > Basic constructor.</summary>
2004-01-09 01:32:46 +00:00
<param name= "str" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:Gtk.Label" /> </returns>
2004-11-05 21:25:40 +00:00
<remarks />
2003-03-07 01:30:00 +00:00
</Docs>
</Member>
2004-01-09 01:32:46 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Label ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
<summary > Creates a new <see cref= "T:Gtk.Label" /> without text.</summary>
2004-01-12 22:48:13 +00:00
<remarks >
</remarks>
2004-01-09 01:32:46 +00:00
</Docs>
</Member>
2004-11-05 21:25:40 +00:00
<Member MemberName= "ParseUline" >
<MemberSignature Language= "C#" Value= "public uint ParseUline (string str1ng);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.UInt32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "str1ng" Type= "System.String" />
</Parameters>
<Docs >
2005-01-05 19:34:00 +00:00
<summary > Deprecated.</summary>
2004-11-05 21:25:40 +00:00
<param name= "str1ng" > a <see cref= "T:System.String" /> </param>
<returns > a <see cref= "T:System.UInt32" /> </returns>
2005-01-05 19:34:00 +00:00
<remarks >
Checks the string passed as the parameter for underscores,
and then underlines the characters following the
underscores. It will take the first underlined character in
a label and return it as a lower-case accelerator key,
e.g. _Save will return the accelerator key value for "s".
</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
<Member MemberName= "Get" >
<MemberSignature Language= "C#" Value= "public void Get (string str);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "str" Type= "System.String" />
</Parameters>
<Docs >
2005-01-05 19:34:00 +00:00
<summary > Deprecated; do not use in new code.</summary>
2004-11-05 21:25:40 +00:00
<param name= "str" > a <see cref= "T:System.String" /> </param>
2005-01-05 19:34:00 +00:00
<remarks > Gets the current string of text within the Label
2005-04-21 17:10:54 +00:00
object and writes it to <paramref name= "str" /> . It does not make a copy of this
2005-01-05 19:34:00 +00:00
string so you must not write to it.</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2004-11-05 21:25:40 +00:00
</Docs>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "Angle" >
<MemberSignature Language= "C#" Value= "public double Angle { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Double</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Double" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("angle")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "SingleLineMode" >
<MemberSignature Language= "C#" Value= "public bool SingleLineMode { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Boolean" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("single-line-mode")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "Ellipsize" >
<MemberSignature Language= "C#" Value= "public Pango.EllipsizeMode Ellipsize { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.EllipsizeMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:Pango.EllipsizeMode" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("ellipsize")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "WidthChars" >
<MemberSignature Language= "C#" Value= "public int WidthChars { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Int32" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("width-chars")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "MaxWidthChars" >
<MemberSignature Language= "C#" Value= "public int MaxWidthChars { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Int32" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("max-width-chars")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
</Member>
<Member MemberName= "GetLayoutOffsets" >
2005-05-23 20:41:51 +00:00
<MemberSignature Language= "C#" Value= "public void GetLayoutOffsets (out int x, out int y);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "x" Type= "System.Int32&" RefType= "out" />
<Parameter Name= "y" Type= "System.Int32&" RefType= "out" />
</Parameters>
<Docs >
<param name= "x" > To be added.</param>
<param name= "y" > To be added.</param>
<summary > To be added.</summary>
<remarks > To be added.</remarks>
</Docs>
</Member>
2005-06-16 18:56:42 +00:00
<Member MemberName= "GetSelectionBounds" >
2005-05-23 20:41:51 +00:00
<MemberSignature Language= "C#" Value= "public bool GetSelectionBounds (out int start, out int end);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "start" Type= "System.Int32&" RefType= "out" />
<Parameter Name= "end" Type= "System.Int32&" RefType= "out" />
</Parameters>
<Docs >
<param name= "start" > To be added.</param>
<param name= "end" > To be added.</param>
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
</Docs>
2005-04-21 17:10:54 +00:00
</Member>
2006-08-07 17:00:55 +00:00
<Member MemberName= "LineWrapMode" >
<MemberSignature Language= "C#" Value= "public Pango.WrapMode LineWrapMode { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Pango.WrapMode</ReturnType>
</ReturnValue>
<Docs >
<summary > Indicates the wrap mode for the label.</summary>
<value > a <see cref= "T:Pango.WrapMode" /> .</value>
<remarks />
<since version= "Gtk# 2.10" />
</Docs>
2007-01-16 16:18:05 +00:00
<Attributes >
2006-08-07 17:00:55 +00:00
<Attribute >
2007-01-16 16:18:05 +00:00
<AttributeName > GLib.Property("wrap-mode")</AttributeName>
2006-08-07 17:00:55 +00:00
</Attribute>
2007-01-16 16:18:05 +00:00
</Attributes>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2006-08-07 17:00:55 +00:00
</Type>