Add first draft of Label docs.
svn path=/trunk/gtk-sharp/; revision=13176
This commit is contained in:
Duncan Mak
parent
591c9eca8f
commit
f7495647c1
3 changed files with 160 additions and 43 deletions
|
|
@ -83,6 +83,9 @@
|
|||
|
||||
2003-03-15 Duncan Mak <duncan@ximian.com>
|
||||
|
||||
* gtk/ColorSelectionDialog.custom: Rename the inner Button class
|
||||
to be ColorSelectionButton to avoid a name clash in the doc generator.
|
||||
|
||||
* gtk/TextBuffer.custom: Fix the Text property. Patch from Mathias
|
||||
Hasselmann <mathias.hasselmann@gmx.de>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
2003-04-04 Duncan Mak <duncan@ximian.com>
|
||||
|
||||
* en/Gtk/Label.xml: Add first draft of Label docs.
|
||||
|
||||
2003-03-28 Lee Mallabone <mono-docs@fonicmonkey.net>
|
||||
|
||||
* en/Gtk/Calendar.xml: Second draft.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="Label" FullName="Gtk.Label">
|
||||
<TypeSignature Language="C#" Value="public class Label : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Label : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Duncan Mak" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
|
|
@ -7,8 +7,21 @@
|
|||
</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>
|
||||
<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>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.Misc</BaseTypeName>
|
||||
|
|
@ -39,10 +52,29 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetSelectionBounds">
|
||||
|
|
@ -133,10 +165,20 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
|
|
@ -175,7 +217,17 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Markup">
|
||||
|
|
@ -188,10 +240,16 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="LineWrap">
|
||||
|
|
@ -204,10 +262,14 @@
|
|||
<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>
|
||||
<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 />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Text">
|
||||
|
|
@ -220,10 +282,14 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Layout">
|
||||
|
|
@ -233,9 +299,17 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="MarkupWithMnemonic">
|
||||
|
|
@ -248,10 +322,28 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Selectable">
|
||||
|
|
@ -264,10 +356,16 @@
|
|||
<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>
|
||||
<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 />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Justify">
|
||||
|
|
@ -280,10 +378,21 @@
|
|||
<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>
|
||||
<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>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CursorPosition">
|
||||
|
|
@ -412,10 +521,11 @@
|
|||
<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>
|
||||
<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 />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Attributes">
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue