ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-24 17:25:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

* en/Gtk/TextTag.xml:

Browse source 
* en/Gtk/TextTagTable.xml:
* en/Gtk/TextMark.xml:
* en/Gtk/TextChildAnchor.xml: documented.

svn path=/trunk/gtk-sharp/; revision=16182
This commit is contained in:
Duncan Mak 2003-07-14 00:48:35 +00:00
parent 1200492df5
commit d9a26991fc
6 changed files with 250 additions and 130 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/ChangeLog
View file

@ -1,3 +1,10 @@
2003-07-13 Duncan Mak <duncan@ximian.com>
* en/Gtk/TextTag.xml:
* en/Gtk/TextTagTable.xml:
* en/Gtk/TextMark.xml:
* en/Gtk/TextChildAnchor.xml: documented.
2003-07-12 Duncan Mak <duncan@ximian.com>
* en/Gtk/TextBuffer.xml: all documented except for events.

4
doc/en/Gtk/TextBuffer.xml
View file

@ -102,7 +102,9 @@
</Parameters>
<Docs>
<summary>
Emits the "remove_tag" signal.
Fires the <see cref="E:Gtk.TextBuffer.RemoveTag" /> events
and removes all occurrences of <see paramref="tag" /> from
the given range
</summary>
<param name="tag">the <see cref="T:Gtk.TextTag" /> to remove</param>
<param name="start">the beginning of the range</param>

25
doc/en/Gtk/TextChildAnchor.xml
View file

@ -57,9 +57,16 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Creates a new TextChildAnchor</summary>
<returns>To be added: an object of type 'Gtk.TextChildAnchor'</returns>
<remarks>To be added</remarks>
<remarks>
<para>
To create a new <see cref="T:Gtk.TextChildAnchor" />, you
can also use the factory method <see
cref="M:Gtk.TextBuffer.CreateChildAnchor(Gtk.TextIter)" />
from the <see cref="T:Gtk.TextBuffer" /> class.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -81,9 +88,9 @@
<ReturnType>GLib.List</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.List'</returns>
<remarks>To be added</remarks>
<summary>Gets a list of all widgets anchored at this child anchor.</summary>
<returns>a list of widgets anchored</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Deleted">
@ -93,9 +100,11 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Determines whether the child anchor has been deleted from the buffer.</summary>
<returns>
<see langword="true" /> if the child anchor has been deleted from its buffer
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">

94
doc/en/Gtk/TextMark.xml
View file

@ -1,5 +1,5 @@
<Type Name="TextMark" FullName="Gtk.TextMark">
<TypeSignature Language="C#" Value="public class TextMark : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class TextMark : GLib.Object, IWrapper, IDisposable" Maintainer="duncan" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,34 @@
</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 GtkTextMark is like a bookmark in a text buffer; it preserves a position in the text.
</summary>
<remarks>
<para>
A GtkTextMark is like a bookmark in a text buffer; it
preserves a position in the text. You can convert the mark to
an <see cref="T:Gtk.TextIter" /> iterator using <see
cref="M:Gtk.TextBuffer.GetIterAtMark(Gtk.TextMark)" />. Unlike
iterators, marks remain valid across buffer mutations, because
their behavior is defined when text is inserted or
deleted. When text containing a mark is deleted, the mark
remains in the position originally occupied by the deleted
text. When text is inserted at a mark, a mark with left
gravity will be moved to the beginning of the newly-inserted
text, and a mark with right gravity will be moved to the
end.
</para>
<para>
Marks optionally have names; these can be convenient to avoid
passing the <see cref="T:Gtk.TextMark" /> object around.
</para>
<para>
Marks are typically created using the
<see cref="M:Gtk.TextMark.CreateMark(Gtk.TextMark)" /> function.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -81,9 +107,12 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The name of the mark</summary>
<returns>
Returns the name of the mark and <see langword="null" /> if
it's an anonymous mark
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Deleted">
@ -93,9 +122,16 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether of not the mark has been removed</summary>
<returns>Returns <see langword="true" /> if the mark has been removed from its buffer.</returns>
<remarks>
<para>
Returns <see langword="true" /> if the mark has been
removed from its buffer with <see
cref="M:Gtk.TextBuffer.DeleteMark(Gtk.TextMark)" />. Marks
can't be used once they are deleted.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="LeftGravity">
@ -105,9 +141,17 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether or not the mark has left gravity</summary>
<returns>
<see langword="true" /> if the mark has left gravity,
<see langword="false" /> otherwise.
</returns>
<remarks>
"left" and "right" here refer to logical direction (left is
the toward the start of the buffer); in some languages such
as Hebrew the logically-leftmost text is not actually on the
left when displayed.
</remarks>
</Docs>
</Member>
<Member MemberName="Visible">
@ -120,10 +164,18 @@
<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>The visibility of the mark</summary>
<param name="value">The visibility of the mark</param>
<returns><see langword="true" /> if the mark is visible (i.e. a cursor is displayed for it)</returns>
<remarks>
<para>
The insertion point is normally visible, i.e. you can see
it as a vertical bar. Also, the text widget uses a visible
mark to indicate where a drop will occur when
dragging-and-dropping text. Most other marks are not
visible. Marks are not visible by default.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Buffer">
@ -133,9 +185,13 @@
<ReturnType>Gtk.TextBuffer</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextBuffer'</returns>
<remarks>To be added</remarks>
<summary>
Gets the buffer where this mark is located
</summary>
<returns>The buffer where this mark is applied</returns>
<remarks>
<see langword="null" /> is returned if the mark has been deleted.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">

192
doc/en/Gtk/TextTag.xml
View file

@ -1,5 +1,5 @@
<Type Name="TextTag" FullName="Gtk.TextTag">
<TypeSignature Language="C#" Value="public class TextTag : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class TextTag : GLib.Object, IWrapper, IDisposable" Maintainer="duncan" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -326,10 +326,12 @@
<Parameter Name="value" Type="Gdk.Pixmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixmap'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
<summary>Bitmap to use as a mask when drawing the text background.</summary>
<param name="value">
The bitmap of type <see cref="T:Gdk.Pixmap" />
</param>
<returns>The background bitmap</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LeftMargin">
@ -342,10 +344,10 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Width of the left margin in pixels.</summary>
<param name="value">The width of the left margin in pixels</param>
<returns>The width of the margin</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SizePoints">
@ -358,10 +360,10 @@
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Font size in points.</summary>
<param name="value">Font size in points.</param>
<returns>The font size</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Weight">
@ -374,7 +376,7 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This property should be fixed</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
@ -390,10 +392,10 @@
<Parameter Name="value" Type="Gtk.TextDirection" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.TextDirection'</param>
<returns>To be added: an object of type 'Gtk.TextDirection'</returns>
<remarks>To be added</remarks>
<summary>Text direction, e.g. right-to-left or left-to-right.</summary>
<param name="value">The direction of the text</param>
<returns>The text direction</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelsAboveLines">
@ -406,10 +408,12 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Pixels of blank space above paragraphs.</summary>
<param name="value">
The number of pixels of blank space above the paragraphs.
</param>
<returns>The blank space above the paragraphs in pixels</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="WrapMode">
@ -422,10 +426,10 @@
<Parameter Name="value" Type="Gtk.WrapMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.WrapMode'</param>
<returns>To be added: an object of type 'Gtk.WrapMode'</returns>
<remarks>To be added</remarks>
<summary>Whether to wrap lines never, at word boundaries, or at character boundaries.</summary>
<param name="value">The <see cref="T:Gtk.WrapMode" /> of this tag</param>
<returns>a <see cref="T:Gtk.WrapMode" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Name">
@ -435,9 +439,12 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The name of this tag</summary>
<returns>
The name of this name, or <see langword="null" /> if it's an
anonymous tag
</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Indent">
@ -450,10 +457,10 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Amount to indent the paragraph, in pixels</summary>
<param name="value">The amount to indent in pixels</param>
<returns>The indent of the paragraph</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Foreground">
@ -466,10 +473,10 @@
<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>Foreground color</summary>
<param name="value">the foreground color as a string</param>
<returns>the foreground color</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="BackgroundGdk">
@ -482,10 +489,14 @@
<Parameter Name="value" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>
Background color as a (possibly unallocated) <see cref="T:Gdk.Color" />.
</summary>
<param name="value">
The background color as a <see cref="T:Gdk.Color" />.
</param>
<returns>The background color</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ForegroundGdk">
@ -498,10 +509,14 @@
<Parameter Name="value" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
<summary>
Foreground color as a (possibly unallocated) <see cref="T:Gdk.Color" />.
</summary>
<param name="value">
The foreground color as a <see cref="T:Gdk.Color" />.
</param>
<returns>The foreground color</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Tabs">
@ -514,10 +529,10 @@
<Parameter Name="value" Type="Pango.TabArray" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.TabArray'</param>
<returns>To be added: an object of type 'Pango.TabArray'</returns>
<remarks>To be added</remarks>
<summary>Custom tabs for this text.</summary>
<param name="value">a <see cref="T:Pango.TabArray" /></param>
<returns>the custom tabs for this text</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Underline">
@ -530,10 +545,10 @@
<Parameter Name="value" Type="Pango.Underline" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Underline'</param>
<returns>To be added: an object of type 'Pango.Underline'</returns>
<remarks>To be added</remarks>
<summary>Style of underline for this text.</summary>
<param name="value">the underline style</param>
<returns>The underline style for this text</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Scale">
@ -546,10 +561,18 @@
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
<summary>Font size as a scale factor relative to the default font size</summary>
<param name="value">
Font size as a scale factor relative to the default font size.
</param>
<returns>The font size as a scale factor</returns>
<remarks>
<para>
This properly adapts to theme changes etc. so is
recommended. Pango predefines some scales such as <see
cref="T:Pango.Scale.X_Large" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Language">
@ -562,10 +585,10 @@
<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 language this text is in, as an ISO code.</summary>
<param name="value">The ISO code of the language</param>
<returns>The ISO code of the language of this text</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Size">
@ -578,10 +601,10 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Font size</summary>
<param name="value">Font size</param>
<returns>The font size in Pango units</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Style">
@ -594,10 +617,12 @@
<Parameter Name="value" Type="Pango.Style" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Style'</param>
<returns>To be added: an object of type 'Pango.Style'</returns>
<remarks>To be added</remarks>
<summary>Font style</summary>
<param name="value">
The font style in as a <see cref="T:Pango.Style" />
</param>
<returns>the font style of this text</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Variant">
@ -610,10 +635,12 @@
<Parameter Name="value" Type="Pango.Variant" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Variant'</param>
<returns>To be added: an object of type 'Pango.Variant'</returns>
<remarks>To be added</remarks>
<summary>Font variant</summary>
<param name="value">
The font variant as a <see cref="T:Pango.Variant" />
</param>
<returns>The font variant of this text</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Background">
@ -626,10 +653,10 @@
<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>Background color</summary>
<param name="value">The name of the background color</param>
<returns />
<remarks />
</Docs>
</Member>
<Member MemberName="FontDesc">
@ -658,10 +685,13 @@
<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 background color fills the entire line height or only the height of the tagged characters.</summary>
<param name="value">
<see langword="true" /> if the background
color fills the entire line height
</param>
<returns>Whether the background color fills the entire line height or only the height of the tagged characters.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Event">

58
doc/en/Gtk/TextTagTable.xml
View file

@ -7,8 +7,15 @@
</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 tag table defines a set of tags
</summary>
<remarks>
A tag table defines a set of <see cref="T:Gtk.TextTag" /> tags that can be used
together. Each buffer has one tag table associated with it; only
tags from that tag table can be used with the buffer. A single
tag table can be shared between multiple buffers, however.
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -33,9 +40,9 @@
<Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param>
<remarks>To be added</remarks>
<summary>Remove a tag from the table.</summary>
<param name="tag">the tag to be removed</param>
<remarks />
</Docs>
</Member>
<Member MemberName="Add">
@ -48,9 +55,18 @@
<Parameter Name="tag" Type="Gtk.TextTag" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="tag">To be added: an object of type 'Gtk.TextTag'</param>
<remarks>To be added</remarks>
<summary>Add a tag to the table. The tag is assigned the highest priority in the table.</summary>
<param name="tag">the tag to be added</param>
<remarks>
<para>
Add a tag to the table. The tag is assigned the highest
priority in the table.
</para>
<para>
<see paramref="tag" /> must not be in a tag table already,
and may not have the same name as an already-added tag.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Lookup">
@ -63,10 +79,10 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.TextTag'</returns>
<remarks>To be added</remarks>
<summary>Finds a <see cref="T:Gtk.TextTag" /> by its name</summary>
<param name="name">the name of a tag</param>
<returns>The tag, or <see langword="null" /> if none by that name is in the table.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Foreach">
@ -142,9 +158,9 @@
<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>
<summary>The size of the table</summary>
<returns>The number of the tags in this table</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="TagRemoved">
@ -153,8 +169,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a tag is removed from the table</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TagChanged">
@ -163,8 +179,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a tag in the table is changed</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TagAdded">
@ -173,8 +189,8 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a tag is added to the table</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">