the rest of what I could find about Gtk.Text* from the c-docs

svn path=/trunk/gtk-sharp/; revision=31391
This commit is contained in:
John Luke 2004-07-22 21:52:21 +00:00
parent f579d4098e
commit fe72969e47
5 changed files with 78 additions and 56 deletions

View file

@ -172,8 +172,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Should be paired with a call to <see cref="M:Gtk.TextBuffer.BeginUserAction()" />.</summary>
<remarks>See <see cref="M:Gtk.TextBuffer.BeginUserAction()" /> for an explanation.</remarks>
</Docs>
</Member>
<Member MemberName="InsertChildAnchor">
@ -242,8 +242,13 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Called to indicate that the buffer operations between here and a call to <see cref="M:Gtk.TextBuffer.EndUserAction()" /> are part of a single user-visible operation.</summary>
<remarks>
<para>The operations between <see cref="M:Gtk.TextBuffer.BeginUserAction()" /> and <see cref="M:Gtk.TextBuffer.EndUserAction()" /> can then be grouped when creating an undo stack. <see cref="T:Gtk.TextBuffer" /> maintains a count of calls to <see cref="M:Gtk.TextBuffer.BeginUserAction()" /> that have not been closed with a call to <see cref="M:Gtk.TextBuffer.EndUserAction()" />, and emits <see cref="E:Gtk.TextBuffer.UserActionBegun" /> and <see cref="E:Gtk.TextBuffer.UserActionEnded" /> signals only for the outermost pair of calls. This allows you to build user actions from other user actions.
</para>
<para>The "interactive" buffer mutation functions, such as <see cref="M:Gtk.TextBuffer.InsertInteractive()" />, automatically call begin/end user action around the buffer operations they perform, so there is no need to add extra calls if you user action consists solely of a single call to one of those functions.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="PasteClipboard">
@ -509,9 +514,9 @@
<Parameter Name="clipboard" Type="Gtk.Clipboard" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Removes a <see cref="T:Gtk.Clipboard" /> added with <see cref="M:Gtk.TextBuffer.AddSelectionClipboard()" />.</summary>
<param name="clipboard">an object of type <see cref="T:Gtk.Clipboard" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Delete">
@ -580,9 +585,9 @@
<Parameter Name="clipboard" Type="Gtk.Clipboard" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds <parmred name="clipboard" /> to the list of clipboards in which the selection contents of buffer are available.</summary>
<param name="clipboard">an object of type <see cref="T:Gtk.Clipboard" /></param>
<remarks>To be added</remarks>
<remarks>In most cases, clipboard will be the <see cref="T:Gtk.Clipboard" /> of type <see cref="F:Gdk.Selection.Primary" /> for a view of buffer.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteMark">
@ -838,10 +843,10 @@
<Parameter Name="default_editable" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Copies the currently-selected text to a clipboard, then deletes said text if it is editable.</summary>
<param name="clipboard">an object of type <see cref="T:Gtk.Clipboard" /></param>
<param name="default_editable">an object of type <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -1053,8 +1058,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a UserAction ends on the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TagRemoved">
@ -1065,8 +1070,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a tag is removed from the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="UserActionBegun">
@ -1077,8 +1082,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a UserAction is begun on the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MarkSet">
@ -1089,8 +1094,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a mark is set in the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TagApplied">
@ -1101,8 +1106,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a tag is applied to the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ChildAnchorInserted">
@ -1113,8 +1118,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a ChildAnchor has been inserted in the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MarkDeleted">
@ -1125,8 +1130,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a mark has been deleted from the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="DeleteRange">
@ -1137,8 +1142,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a range of text has been deleted from the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="PixbufInserted">
@ -1149,8 +1154,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when a Pixbuf is inserted into the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Changed">
@ -1161,8 +1166,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the text in the buffer has been changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertText">
@ -1173,8 +1178,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when text is inserted into the buffer.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ModifiedChanged">
@ -1185,8 +1190,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the Modified status of the buffer is changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GetIterAtOffset">
@ -1331,9 +1336,9 @@
<Parameter Name="clipboard" Type="Gtk.Clipboard" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Pastes the contents of a clipboard at the insertion point.</summary>
<param name="clipboard">a <see cref="T:Gtk.Clipboard" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -1652,11 +1657,11 @@
<Parameter Name="tags" Type="Gtk.TextTag[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Inserts <paramref name="text" /> into buffer at <paramref name="iter" />, applying the list of <paramref name="tags" /> to the newly-inserted text.</summary>
<param name="iter">a <see cref="T:Gtk.TextIter" /></param>
<param name="text">a <see cref="T:System.String" /></param>
<param name="tags">a <see cref="T:Gtk.TextTag" /></param>
<remarks>To be added</remarks>
<remarks>Equivalent to calling <see cref="M:Gtk.TextBuffer.Insert()" />, then <see cref="Gtk.TextBuffer.ApplyTag()" /> on the inserted text; It is just a convenience function.</remarks>
</Docs>
</Member>
</Members>

View file

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>
A GtkTextMark is like a bookmark in a text buffer; it preserves a position in the text.
A <see cref="T:Gtk.TextMark" /> is like a bookmark in a text buffer; it preserves a position in the text.
</summary>
<remarks>
<para>
@ -204,9 +204,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Gtk.TextMark" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

View file

@ -12,7 +12,14 @@
<Docs>
<summary>
A tag that can be applied to text in a <see cref="T:Gtk.TextBuffer" /></summary>
<remarks>To be added</remarks>
<remarks>
<para>
Tags should be in the <see cref="T:Gtk.TextTagTable" /> for a given <see cref="T:Gtk.TextBuffer" /> before using them with that buffer.
</para>
<para>
<see cref="M:Gtk.TextBuffer.CreateTag()" /> is the best way to create tags.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -106,7 +113,7 @@
<returns>The priority of the current tag</returns>
<remarks>
<para>
Sets the priority of a GtkTextTag. Valid priorities are
Sets the priority of a <see cref="T:Gtk.TextTag" />. Valid priorities are
start at 0 and go to one less than
<see cref="P:Gtk.TextTagTable.Size" />.
</para>
@ -628,10 +635,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.FontDescription'</param>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
<summary>The FontDescription for the tag.</summary>
<param name="value">a <see cref="T:Pango.FontDescription" /></param>
<returns>a <see cref="T:Pango.FontDescription" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="BackgroundFullHeight">
@ -660,9 +667,19 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Font weight as an integer.</summary>
<returns>a <see cref="T:Pango.Weight" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
see predefined values in <see cref="T:Pango.Weight" />; for example, <see cref="F:Pango.Weight.Bold" />.
</para>
<para>
Allowed values: &gt;= 0
</para>
<para>
Default value: 400
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="TextEvent">

View file

@ -98,9 +98,9 @@
<Parameter Name="func" Type="Gtk.TextTagTableForeach" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="func">To be added: an object of type 'Gtk.TextTagTableForeach'</param>
<remarks>To be added</remarks>
<summary>Calls func on each tag in table</summary>
<param name="func">a <see cref="T:Gtk.TextTagTableForeach" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -137,9 +137,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TextTagTable'</returns>
<remarks>To be added</remarks>
<summary>Default constructor</summary>
<returns>a <see cref="T:Gtk.TextTagTable" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Size">

View file

@ -670,7 +670,7 @@ class TextViewSample
</ReturnValue>
<Docs>
<summary>The default text attributes</summary>
<returns>To be added: an object of type 'Gtk.TextAttributes'</returns>
<returns>a <see cref="T:Gtk.TextAttribute" />s</returns>
<remarks>
<para>
Obtains a copy of the default text attributes. These are