ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-08-06 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/: More documentation, largely for tree-related
	classes, icons, and text widgets.

svn path=/trunk/gtk-sharp/; revision=31978
This commit is contained in:
Shane Landrum 2004-08-06 13:18:10 +00:00
parent 227eea5f5e
commit 92553bb827
28 changed files with 204 additions and 202 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/en/Gtk/Application.xml
View file

@ -260,10 +260,10 @@ void LongComputation ()
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns the event currently taking place.</summary>
<returns>a <see cref="T:Gdk.Event" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

20
doc/en/Gtk/Box.xml
View file

@ -235,13 +235,13 @@
<Parameter Name="pack_type" Type="Gtk.PackType&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="child">a <see cref="T:Gtk.Widget" /></param>
<param name="expand">a <see cref="T:System.Boolean&amp;" /></param>
<param name="fill">a <see cref="T:System.Boolean&amp;" /></param>
<param name="padding">a <see cref="T:System.UInt32&amp;" /></param>
<param name="pack_type">a <see cref="T:Gtk.PackType&amp;" /></param>
<remarks>To be added</remarks>
<summary>Returns information about how <paramref name="child" /> is packed into <paramref name="box" />.</summary>
<param name="child">the <see cref="T:Gtk.Widget" /> of the child to query.</param>
<param name="expand">a <see cref="T:System.Boolean&amp;" />, the returned value of the expand field in the BoxChild object.</param>
<param name="fill">a <see cref="T:System.Boolean&amp;" />, the returned value of the fill field in the BoxChild object.</param>
<param name="padding">a <see cref="T:System.UInt32&amp;" />, the retuned value of the padding field in the BoxChild object.</param>
<param name="pack_type">a <see cref="T:Gtk.PackType&amp;" />, the returned value of the pack field in the BoxChild object.</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -277,10 +277,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.Box" /></returns>
<remarks>To be added</remarks>
<remarks>Chain to this constructor if you have not manually registered a native <see cref="T:GLib.GType" /> value for your subclass. (FIXME: make sure this is correct.)</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -10,7 +10,7 @@
</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>An object for editing a single cell.</summary>
<summary>An interface for editing a single cell.</summary>
<remarks>
</remarks>
</Docs>
@ -98,4 +98,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

26
doc/en/Gtk/ColorSelection.xml
View file

@ -176,10 +176,10 @@
<Parameters>
</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>The color that was selected before the current one.</summary>
<param name="value">An object of type <see cref='M:Gdk.Color' /></param>
<returns>a <see cref='M:Gdk.Color' /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="PaletteFromString">
@ -192,10 +192,10 @@
<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 'Gdk.Color[]'</returns>
<remarks>To be added</remarks>
<summary>Parses a color palette string; the string is a colon-separated list of color names readable by <see cref="M:Gdk.ColorParse" /></summary>
<param name="str">A palette string to parse</param>
<returns>An array of <see cref="M:Gdk.Color" /> objects.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="PaletteToString">
@ -208,10 +208,10 @@
<Parameter Name="colors" Type="Gdk.Color[]" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="colors">To be added: an object of type 'Gdk.Color[]'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Encodes a palette as a string; useful for persistent storage.</summary>
<param name="colors">An array of <see cref="M:Gdk.Color" /> objects. </param>
<returns>A string encoding of the palette.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="IsAdjusting">
@ -269,4 +269,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -16,7 +16,7 @@
The <see cref="T:Gtk.Curve" /> widget allows the user to edit a curve covering a range of values. It is typically used to fine-tune color balances in graphics applications like the Gimp. The <see cref="T:Gtk.Curve" /> widget has 3 modes of operation - spline, linear and free. In spline mode the user places points on the curve which are automatically connected together into a smooth curve. In linear mode the user places points on the curve which are connected by straight lines. In free mode the user can draw the points of the curve freely, and they are not connected at all.
</para>
<para>
NOTE: this widget is considered too specialized/little-used for GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, we are not accepting new features for the widget, and it will eventually move out of the GTK+ distribution.
NOTE: this widget is considered too specialized/little-used for GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, we are not accepting new features for the widget, and it will eventually move out of the GTK+ distribution. (FIXME: will it remain in GTK#?)
</para>
</remarks>
</Docs>
@ -315,4 +315,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

96
doc/en/Gtk/Editable.xml
View file

@ -10,8 +10,8 @@
</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>Interface for text-editing widgets.</summary>
<remarks />
</Docs>
<Base />
<Interfaces>
@ -32,10 +32,11 @@
<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>
<remarks>To be added</remarks>
<summary>Selects a region of text. </summary>
<param name="start">An integer, the start of the selected region.</param>
<param name="end">An integer, the end of the selected region.</param>
<remarks>The characters that are selected are those characters at positions from <paramref name="start" /> up to, but not including <paramref name="end" />. If <paramref name="end" /> is negative, then the the characters selected will be those characters from <paramref name="start" /> to the end of the text.
</remarks>
</Docs>
</Member>
<Member MemberName="GetChars">
@ -49,11 +50,11 @@
<Parameter Name="end_pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from <paramref name="start_pos" /> up to, but not including <paramref name="end_pos" />. If <paramref name="end_pos" /> is negative, then the the characters retrieved will be those characters from <paramref name="start_pos" /> to the end of the text.</summary>
<param name="start_pos">An integer; the start position</param>
<param name="end_pos">An integer; the end position</param>
<returns>The characters between <paramref name="start_pos" /> and (but not including) <paramref name="end_pos" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DeleteText">
@ -67,10 +68,11 @@
<Parameter Name="end_pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Deletes a sequence of characters. The characters that are deleted are those characters at positions from <paramref name="start_pos" /> up to, but not including <paramref name="end_pos" />. If <paramref name="end_pos" /> is negative, then the the characters deleted will be those characters from <paramref name="start_pos" /> to the end of the text.</summary>
<param name="start_pos">An integer; the start position</param>
<param name="end_pos">An integer; the end position</param>
<remarks />
</Docs>
</Member>
<Member MemberName="CopyClipboard">
@ -81,8 +83,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Causes the characters in the current selection to be copied to the clipboard.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="DeleteSelection">
@ -93,8 +95,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Causes the characters in the current selection to be deleted.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GetSelectionBounds">
@ -108,11 +110,11 @@
<Parameter Name="end" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start">To be added: an object of type 'int&amp;'</param>
<param name="end">To be added: an object of type 'int&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Gets the current selection bounds, if there is a selection</summary>
<param name="start">An IntPtr to store the start position in.</param>
<param name="end">An IntPtr to store the end position in.</param>
<returns>Boolean, TRUE if there is a selection.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CutClipboard">
@ -123,8 +125,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Causes the characters in the current selection to be copied to the clipboard and then deleted from the widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="PasteClipboard">
@ -135,8 +137,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Causes the contents of the clipboard to be pasted into the given widget at the current cursor position.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="IsEditable">
@ -148,10 +150,10 @@
<Parameters>
</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 or not the user can edit the text in the editable widget or not.</summary>
<param name="value">A boolean; TRUE if the user can edit the text.</param>
<returns>A boolean; TRUE if the user can edit the text.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Position">
@ -163,10 +165,10 @@
<Parameters>
</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>The current cursor position.</summary>
<param name="value">An integer position for the cursor.</param>
<returns>An integer position for the cursor.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="TextInserted">
@ -177,8 +179,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the user inserts text.</summary>
<remarks>The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with gtk_signal_emit_stop(), it is possible to modify the inserted text, or prevent it from being inserted entirely. (FIXME: Need Gtk# equivalent for gtk_signal_emit_stop().)</remarks>
</Docs>
</Member>
<Member MemberName="TextDeleted">
@ -189,8 +191,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the user deletes text.</summary>
<remarks>The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with gtk_signal_emit_stop(), it is possible to modify the inserted text, or prevent it from being inserted entirely. The <paramref name="start_pos" /> and <paramref name="end_pos" /> parameters are interpreted as for <see cref="F:Gtk.Editable.DeleteText()" />(FIXME: need equivalent for gtk_signal_emit_stop().)</remarks>
</Docs>
</Member>
<Member MemberName="Changed">
@ -201,8 +203,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when the user has changed the contents of the widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="InsertText">
@ -216,11 +218,11 @@
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
<param name="position">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
<summary>Inserts <paramref name="new_text" /> at <paramref name="position" />.</summary>
<param name="new_text">A string to insert.</param>
<param name="position">A pointer to the position within the Editable object for inserting the string.</param>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/FileSelection.xml
View file

@ -179,9 +179,9 @@ class FileSelectionSample
<ReturnType>Gtk.HButtonBox</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The widget enclosing the items that can be acted upon.</summary>
<returns>an object of type <see cref="T:Gtk.HButtonBox" /></returns>
<remarks>To be added</remarks>
<remarks>(FIXME: how is this different from ButtonArea? Gtk+ docs are thin about this.)</remarks>
</Docs>
</Member>
<Member MemberName="ButtonArea">
@ -191,9 +191,9 @@ class FileSelectionSample
<ReturnType>Gtk.HButtonBox</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>A widget to contain all the button objects in this dialog.</summary>
<returns>an object of type <see cref="T:Gtk.HButtonBox" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="FileopRenFile">
@ -477,4 +477,4 @@ class FileSelectionSample
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -10,7 +10,7 @@
</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>
<summary>A base class for input method contexts.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -416,4 +416,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

8
doc/en/Gtk/IconSet.xml
View file

@ -94,7 +94,7 @@
<summary>
Adds an IconSource to the current IconSet.
</summary>
<param name="source">To be added: an object of type 'Gtk.IconSource'</param>
<param name="source">an object of type <see cref="T:Gtk.IconSource" /></param>
<remarks>
<para>
Icon sets have a list of <see cref="T:Gtk.IconSource" />,
@ -217,9 +217,9 @@
<ReturnType>Gtk.IconSize[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The available icon sizes on this system.</summary>
<returns>a <see cref="T:Gtk.IconSize[]" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -236,4 +236,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -13,7 +13,7 @@
<summary>The possible icon sizes</summary>
<remarks>
<para>
This class contains all the valid icon sizes that is supported
This class contains all the valid icon sizes that are supported
by Gtk.
</para>
</remarks>
@ -132,4 +132,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -220,7 +220,7 @@
<Docs>
<summary>
The base image used when creating icon variants of a <see cref="T:Gtk.IconSet" /></summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<param name="value">An object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>the source pixbuf, or <see langword="null" /> if none is set.</returns>
<remarks>
<para>
@ -382,4 +382,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

26
doc/en/Gtk/ImageIconSetData.xml
View file

@ -10,8 +10,8 @@
</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>Represents a set of image icons.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Generates an empty object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImageIconSetData'</returns>
<remarks>To be added</remarks>
<summary>Constructor.</summary>
<param name="raw">An <see cref="T:IntPtr" />, the underlying C object.</param>
<returns>A new <see cref="T:Gtk.ImageIconSetData" /></returns>
<remarks>This is for internal use; application developers shouldn't need to call this.</remarks>
</Docs>
</Member>
<Member MemberName="icon_set">
@ -56,11 +56,11 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.IconSet'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
<summary>The underlying <see cref='T:Gtk.IconSet' /> in this data.</summary>
<param name="value">a <see cref='T:Gtk.IconSet' /></param>
<returns>an object of type <see cref='T:Gtk.IconSet' /></returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/Init.xml
View file

@ -10,7 +10,7 @@
</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>
<summary>An object that gets invoked at the beginning of an application but before the application main loop starts. It's used largely for application setup--- for example, reading RC files.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -64,7 +64,7 @@
<block subset="none" type="note">
<para>In Gtk# 0.98, this function's second argument is of type <see cref="T:System.String" />, when it should be an "out String[]". Until corrected, this function shall not work as expected.</para>
<para>In Gtk# 0.98, this function's second argument is of type <see cref="T:System.String" />, when it should be an "out String[]". Until corrected, this function shall not work as expected. (FIXME 1.0: is this fixed?)</para>
</block></remarks>
</Docs>
</Member>
@ -115,4 +115,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/Layout.xml
View file

@ -227,8 +227,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired whenever the scroll adjustment units are set for this widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="BinWindow">
@ -238,9 +238,9 @@
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The window object for this layout widget.</summary>
<returns>a <see cref="T:Gdk.Window" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -288,4 +288,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

6
doc/en/Gtk/Rc.xml
View file

@ -217,10 +217,10 @@
<Docs>
<summary>Creates up a <see cref="T:Gtk.Style" /> from styles defined in a RC file by providing the raw components used in matching. This function may be useful when creating pseudo-widgets that should be themed like widgets but don't actually have corresponding GTK# widgets. An example of this would be items inside a GNOME canvas widget.</summary>
<param name="settings">a <see cref="T:Gtk.Settings" /></param>
<param name="widget_path">a <see cref="T:System.String" />, the widget path to use when looking up the style, or NULL if no matching against the widget path should be done</param>
<param name="class_path">a <see cref="T:System.String" />, the class path to use when looking up the style, or NULL if no matching against the class path should be done.</param>
<param name="widget_path">a <see cref="T:System.String" />, the widget path to use when looking up the style, or <see langword="null" /> if no matching against the widget path should be done</param>
<param name="class_path">a <see cref="T:System.String" />, the class path to use when looking up the style, or <see langword="null" /> if no matching against the class path should be done.</param>
<param name="type">a <see cref="T:GLib.GType" />, a type that will be used along with parent types of this type when matching against class styles, or G_TYPE_NONE</param>
<returns>a <see cref="T:Gtk.Style" />,a style created by matching with the supplied paths, or NULL if nothing matching was specified and the default style should be used.
<returns>a <see cref="T:Gtk.Style" />,a style created by matching with the supplied paths, or <see langword="null" /> if nothing matching was specified and the default style should be used.
</returns>
<remarks>The returned value is owned by GTK+ as part of an internal cache, so you must call g_object_ref() on the returned value if you want to keep a reference to it. (FIXME: what's the GTK# equivalent of g_object_ref()?)</remarks>
</Docs>

8
doc/en/Gtk/SettingsPropertyValue.xml
View file

@ -31,11 +31,11 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Constructor.</summary>
<param name="raw">a <see cref="T:System.IntPtr" />, a pointer to the underlying C object.</param>
<returns>a <see cref="T:Gtk.SettingsPropertyValue" /></returns>
<remarks>To be added</remarks>
<remarks>This is not for general developer use; it's mostly internal.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

8
doc/en/Gtk/StockItem.xml
View file

@ -56,7 +56,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Frees the memory used by this object.</summary>
<remarks>
</remarks>
</Docs>
@ -110,8 +110,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Sets the modifier, if any, for this object's accelerator.</summary>
<remarks>See <see cref="M:Gdk.ModifierType" /> for eligible keys and mouse button values.</remarks>
</Docs>
</Member>
<Member MemberName="Keyval">
@ -141,4 +141,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

40
doc/en/Gtk/Style.xml
View file

@ -37,7 +37,7 @@
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the foreground color for a particular state</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
@ -184,9 +184,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
<summary>Copy this style object to a new style object.</summary>
<returns>A <see cref="T:Gtk.Style" />, a duplicate of this style.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LookupIconSet">
@ -215,10 +215,10 @@
<Parameter Name="window" Type="Gdk.Window" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
<summary>Attaches a style to a window; this process allocates the colors and creates the GCs (graphics components) for the style - it specializes it to a particular visual and colormap. The process may involve the creation of a new style if the style has already been attached to a window with a different style and colormap.</summary>
<param name="window"><see cref="T:Gdk.Window" />, the window to attach the style to</param>
<returns> Either <paramref name="style" />, or a newly-created <see cref="T:Gtk.Style" />. If the style is newly created, the style parameter will be dereferenced, and the new style will have a reference count belonging to the caller.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -255,9 +255,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
<summary>Public constructor</summary>
<returns>A new <see cref="T:Gtk.Style" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="FontDescription">
@ -267,9 +267,9 @@
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
<summary>The font description used for a widget.</summary>
<returns>a <see cref="T:Pango.FontDescription" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="YThickness">
@ -296,10 +296,10 @@
<Parameters>
</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>The X thickness, which is used for horizontal padding.</summary>
<param name="value">An integer to set the xthickness to.</param>
<returns>An integer.</returns>
<remarks>(FIXME: xthickness and ythickness could be better documented.)</remarks>
</Docs>
</Member>
<Member MemberName="Foregrounds">
@ -309,7 +309,7 @@
<ReturnType>Gdk.Color []</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The foreground colors</summary>
<returns>To be added: an object of type 'Gdk.Color []'</returns>
<remarks>To be added</remarks>
</Docs>
@ -1257,4 +1257,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

18
doc/en/Gtk/Text.xml
View file

@ -10,8 +10,8 @@
</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>Represents text.</summary>
<remarks>GTK+ deprecates GtkText; this object is not the same as GtkText.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -29,10 +29,10 @@
<Parameter Name="_byte" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Test whether a given byte begins a UTF8 character.</summary>
<param name="_byte">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:System.Boolean" />, true if this byte is the start of a UTF8 character.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -41,10 +41,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Text" /></returns>
<remarks>To be added</remarks>
<summary>Construct an empty string.</summary>
<returns>a new <see cref="T:Gtk.Text" /> object.</returns>
<remarks>(FIXME: what is this used for, given that it has no arguments?)</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

14
doc/en/Gtk/TextDeletedArgs.xml
View file

@ -58,9 +58,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 end position within the widget for the text that was deleted.</summary>
<returns>An integer for the end position; this character is not included in the deleted text.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="StartPos">
@ -70,10 +70,10 @@
<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 start position within the widget for the text that was deleted.</summary>
<returns>An integer for the start position.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

20
doc/en/Gtk/TextInsertedArgs.xml
View file

@ -58,9 +58,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 position within the widget text where the text was inserted.</summary>
<returns>An integer, the insert position.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Length">
@ -70,9 +70,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 length of the inserted text.</summary>
<returns>An integer, the length of the inserted text.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Text">
@ -82,10 +82,10 @@
<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 text that was inserted.</summary>
<returns>A string that was inserted.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/TextIter.xml
View file

@ -261,9 +261,9 @@ You do not want to use this function to decide whether text can be inserted at i
</ReturnValue>
<Parameters />
<Docs>
<summary>Moves iter forward by one character offset.</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>Note that images embedded in the buffer occupy 1 character slot, so this may actually move onto an image instead of a character, if you have images in your buffer. If iter is the end iterator or one character before it, iter will now point at the end iterator, and return <see langword="false" /> for convenience when writing loops.</remarks>
<summary>Moves this iterator forward by one character offset.</summary>
<returns>A boolean: <see langword="true" /> if the iterator moved and is dereferenceable.</returns>
<remarks>Note that images embedded in the buffer occupy 1 character slot, so this may actually move onto an image instead of a character, if you have images in your buffer. If this object is the end iterator or one character before it, the object will now point at the end iterator, and return <see langword="false" /> for convenience when writing loops.</remarks>
</Docs>
</Member>
<Member MemberName="BackwardLines">
@ -542,7 +542,7 @@ The values parameter should be initialized to the default settings you wish to u
<Parameters />
<Docs>
<summary>Moves iter to the start of the next line.</summary>
<returns>To be added: an object of type 'bool'</returns>
<returns>A boolean; whether the iterator is dereferenceable</returns>
<remarks>Returns <see langword="true" /> if there was a next line to move to, and <see langword="false" /> if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer.</remarks>
</Docs>
</Member>
@ -1167,4 +1167,4 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl
</Docs>
</Member>
</Members>
</Type>
</Type>

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

@ -100,7 +100,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether of not the mark has been removed</summary>
<summary>Whether or not the mark has been removed</summary>
<returns>Returns <see langword="true" /> if the mark has been removed from its buffer.</returns>
<remarks>
<para>
@ -210,4 +210,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

2
doc/en/Gtk/TextMarkBody.xml
View file

@ -40,4 +40,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

10
doc/en/Gtk/ThemeEngine.xml
View file

@ -10,8 +10,8 @@
</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>An object wrapper for a Gtk theme engine.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -116,10 +116,10 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.ThemeEngine" /></returns>
<remarks>To be added</remarks>
<remarks>Chain to this constructor if you have not manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

2
doc/en/Gtk/TreeDragDest.xml
View file

@ -10,7 +10,7 @@
</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>An object to represent the rows of a tree when something is drag-and-dropped onto them.</summary>
<summary>An interface to represent the rows of a tree when something is drag-and-dropped onto them.</summary>
<remarks />
</Docs>
<Base />

2
doc/en/Gtk/TreeDragSource.xml
View file

@ -10,7 +10,7 @@
</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>An object to represent the rows of a tree when one of them is dragged to another location.</summary>
<summary>An interface to represent the rows of a tree when one of them is dragged to another location.</summary>
<remarks />
</Docs>
<Base />

34
doc/en/Gtk/TreeModelSort.xml
View file

@ -43,9 +43,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Returns the number of children the object's iterator has.</summary>
<returns>An integer.</returns>
<remarks>As a special case, if iter is <see langword="null" />, then the number of toplevel nodes is returned.</remarks>
</Docs>
</Member>
<Member MemberName="IterChildren">
@ -430,9 +430,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 number of columns supported by the <see cref="T:Gtk.TreeModel" /> object.</summary>
<returns>An integer count of the columns.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Flags">
@ -442,9 +442,9 @@
<ReturnType>Gtk.TreeModelFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.TreeModelFlags'</returns>
<remarks>To be added</remarks>
<summary>Returns a set of flags supported by this interface. The flags are a bitwise combination of <see cref="T:GtkTreeModelFlags" />. </summary>
<returns>a <see cref="T:GtkTreeModelFlags" /></returns>
<remarks>The flags supported should not change during the lifecycle of the tree model.</remarks>
</Docs>
</Member>
<Member MemberName="SortColumnChanged">
@ -479,8 +479,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a new row is inserted into the tree.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowDeleted">
@ -491,8 +491,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a row is deleted from the tree.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowChanged">
@ -503,8 +503,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when a tree row is changed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="RowsReordered">
@ -515,8 +515,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Fired when rows are reordered or moved around.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="IterNthChild">