diff --git a/doc/en/Gtk/Application.xml b/doc/en/Gtk/Application.xml index db872b035..9f12d3139 100644 --- a/doc/en/Gtk/Application.xml +++ b/doc/en/Gtk/Application.xml @@ -260,10 +260,10 @@ void LongComputation () - To be added + Returns the event currently taking place. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Box.xml b/doc/en/Gtk/Box.xml index ca138ec6a..95bd76e4c 100644 --- a/doc/en/Gtk/Box.xml +++ b/doc/en/Gtk/Box.xml @@ -235,13 +235,13 @@ - To be added - a - a - a - a - a - To be added + Returns information about how is packed into . + the of the child to query. + a , the returned value of the expand field in the BoxChild object. + a , the returned value of the fill field in the BoxChild object. + a , the retuned value of the padding field in the BoxChild object. + a , the returned value of the pack field in the BoxChild object. + @@ -277,10 +277,10 @@ - To be added + Protected constructor. a - To be added + Chain to this constructor if you have not manually registered a native value for your subclass. (FIXME: make sure this is correct.) - \ No newline at end of file + diff --git a/doc/en/Gtk/CellEditable.xml b/doc/en/Gtk/CellEditable.xml index 8d781eed4..9593471fb 100644 --- a/doc/en/Gtk/CellEditable.xml +++ b/doc/en/Gtk/CellEditable.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - An object for editing a single cell. + An interface for editing a single cell. @@ -98,4 +98,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ColorSelection.xml b/doc/en/Gtk/ColorSelection.xml index ef7829367..25bfb1a18 100644 --- a/doc/en/Gtk/ColorSelection.xml +++ b/doc/en/Gtk/ColorSelection.xml @@ -176,10 +176,10 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + The color that was selected before the current one. + An object of type + a + @@ -192,10 +192,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Color[]' - To be added + Parses a color palette string; the string is a colon-separated list of color names readable by + A palette string to parse + An array of objects. + @@ -208,10 +208,10 @@ - To be added - To be added: an object of type 'Gdk.Color[]' - To be added: an object of type 'string' - To be added + Encodes a palette as a string; useful for persistent storage. + An array of objects. + A string encoding of the palette. + @@ -269,4 +269,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Curve.xml b/doc/en/Gtk/Curve.xml index 1a4c2ade1..8cf092976 100644 --- a/doc/en/Gtk/Curve.xml +++ b/doc/en/Gtk/Curve.xml @@ -16,7 +16,7 @@ The 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 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. - 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#?) @@ -315,4 +315,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Editable.xml b/doc/en/Gtk/Editable.xml index b7c0998a5..4f5e1bdbf 100644 --- a/doc/en/Gtk/Editable.xml +++ b/doc/en/Gtk/Editable.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Interface for text-editing widgets. + @@ -32,10 +32,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Selects a region of text. + An integer, the start of the selected region. + An integer, the end of the selected region. + The characters that are selected are those characters at positions from up to, but not including . If is negative, then the the characters selected will be those characters from to the end of the text. + @@ -49,11 +50,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from up to, but not including . If is negative, then the the characters retrieved will be those characters from to the end of the text. + An integer; the start position + An integer; the end position + The characters between and (but not including) . + @@ -67,10 +68,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + + Deletes a sequence of characters. The characters that are deleted are those characters at positions from up to, but not including . If is negative, then the the characters deleted will be those characters from to the end of the text. + An integer; the start position + An integer; the end position + @@ -81,8 +83,8 @@ - To be added - To be added + Causes the characters in the current selection to be copied to the clipboard. + @@ -93,8 +95,8 @@ - To be added - To be added + Causes the characters in the current selection to be deleted. + @@ -108,11 +110,11 @@ - To be added - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added: an object of type 'bool' - To be added + Gets the current selection bounds, if there is a selection + An IntPtr to store the start position in. + An IntPtr to store the end position in. + Boolean, TRUE if there is a selection. + @@ -123,8 +125,8 @@ - To be added - To be added + Causes the characters in the current selection to be copied to the clipboard and then deleted from the widget. + @@ -135,8 +137,8 @@ - To be added - To be added + Causes the contents of the clipboard to be pasted into the given widget at the current cursor position. + @@ -148,10 +150,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether or not the user can edit the text in the editable widget or not. + A boolean; TRUE if the user can edit the text. + A boolean; TRUE if the user can edit the text. + @@ -163,10 +165,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The current cursor position. + An integer position for the cursor. + An integer position for the cursor. + @@ -177,8 +179,8 @@ - To be added - To be added + Fired whenever the user inserts text. + 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().) @@ -189,8 +191,8 @@ - To be added - To be added + Fired whenever the user deletes text. + 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 and parameters are interpreted as for (FIXME: need equivalent for gtk_signal_emit_stop().) @@ -201,8 +203,8 @@ - To be added - To be added + Fired when the user has changed the contents of the widget. + @@ -216,11 +218,11 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'int&' - To be added + Inserts at . + A string to insert. + A pointer to the position within the Editable object for inserting the string. + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileSelection.xml b/doc/en/Gtk/FileSelection.xml index 3e995c6b4..e509eb610 100644 --- a/doc/en/Gtk/FileSelection.xml +++ b/doc/en/Gtk/FileSelection.xml @@ -179,9 +179,9 @@ class FileSelectionSample Gtk.HButtonBox - To be added + The widget enclosing the items that can be acted upon. an object of type - To be added + (FIXME: how is this different from ButtonArea? Gtk+ docs are thin about this.) @@ -191,9 +191,9 @@ class FileSelectionSample Gtk.HButtonBox - To be added + A widget to contain all the button objects in this dialog. an object of type - To be added + @@ -477,4 +477,4 @@ class FileSelectionSample - \ No newline at end of file + diff --git a/doc/en/Gtk/IMContext.xml b/doc/en/Gtk/IMContext.xml index dbc6aa813..f44f69b75 100644 --- a/doc/en/Gtk/IMContext.xml +++ b/doc/en/Gtk/IMContext.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + A base class for input method contexts. To be added @@ -416,4 +416,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/IconSet.xml b/doc/en/Gtk/IconSet.xml index 8d88493c3..21558974d 100644 --- a/doc/en/Gtk/IconSet.xml +++ b/doc/en/Gtk/IconSet.xml @@ -94,7 +94,7 @@ Adds an IconSource to the current IconSet. - To be added: an object of type 'Gtk.IconSource' + an object of type Icon sets have a list of , @@ -217,9 +217,9 @@ Gtk.IconSize[] - To be added + The available icon sizes on this system. a - To be added + @@ -236,4 +236,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/IconSize.xml b/doc/en/Gtk/IconSize.xml index 5bf095f4b..b0cadd930 100644 --- a/doc/en/Gtk/IconSize.xml +++ b/doc/en/Gtk/IconSize.xml @@ -13,7 +13,7 @@ The possible icon sizes - This class contains all the valid icon sizes that is supported + This class contains all the valid icon sizes that are supported by Gtk. @@ -132,4 +132,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/IconSource.xml b/doc/en/Gtk/IconSource.xml index 9a0030d8b..2c2e3d23d 100644 --- a/doc/en/Gtk/IconSource.xml +++ b/doc/en/Gtk/IconSource.xml @@ -220,7 +220,7 @@ The base image used when creating icon variants of a - To be added: an object of type 'Gdk.Pixbuf' + An object of type the source pixbuf, or if none is set. @@ -382,4 +382,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ImageIconSetData.xml b/doc/en/Gtk/ImageIconSetData.xml index 52af0a67d..7f0b21b89 100644 --- a/doc/en/Gtk/ImageIconSetData.xml +++ b/doc/en/Gtk/ImageIconSetData.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Represents a set of image icons. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Generates an empty object. + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.ImageIconSetData' - To be added + Constructor. + An , the underlying C object. + A new + This is for internal use; application developers shouldn't need to call this. @@ -56,11 +56,11 @@ - To be added - To be added: an object of type 'Gtk.IconSet' - To be added: an object of type 'Gtk.IconSet' - To be added + The underlying in this data. + a + an object of type + - \ No newline at end of file + diff --git a/doc/en/Gtk/Init.xml b/doc/en/Gtk/Init.xml index cb3776782..14a071d9d 100644 --- a/doc/en/Gtk/Init.xml +++ b/doc/en/Gtk/Init.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + 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. To be added @@ -64,7 +64,7 @@ - In Gtk# 0.98, this function's second argument is of type , when it should be an "out String[]". Until corrected, this function shall not work as expected. + In Gtk# 0.98, this function's second argument is of type , when it should be an "out String[]". Until corrected, this function shall not work as expected. (FIXME 1.0: is this fixed?) @@ -115,4 +115,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Layout.xml b/doc/en/Gtk/Layout.xml index 8f6dcb35b..d1e1d4e8d 100644 --- a/doc/en/Gtk/Layout.xml +++ b/doc/en/Gtk/Layout.xml @@ -227,8 +227,8 @@ - To be added - To be added + Fired whenever the scroll adjustment units are set for this widget. + @@ -238,9 +238,9 @@ Gdk.Window - To be added + The window object for this layout widget. a - To be added + @@ -288,4 +288,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Rc.xml b/doc/en/Gtk/Rc.xml index 6cb03da6c..1f6a5d370 100644 --- a/doc/en/Gtk/Rc.xml +++ b/doc/en/Gtk/Rc.xml @@ -217,10 +217,10 @@ Creates up a 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. a - a , the widget path to use when looking up the style, or NULL if no matching against the widget path should be done - a , the class path to use when looking up the style, or NULL if no matching against the class path should be done. + a , the widget path to use when looking up the style, or if no matching against the widget path should be done + a , the class path to use when looking up the style, or if no matching against the class path should be done. a , a type that will be used along with parent types of this type when matching against class styles, or G_TYPE_NONE - a ,a style created by matching with the supplied paths, or NULL if nothing matching was specified and the default style should be used. + a ,a style created by matching with the supplied paths, or if nothing matching was specified and the default style should be used. 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()?) diff --git a/doc/en/Gtk/SettingsPropertyValue.xml b/doc/en/Gtk/SettingsPropertyValue.xml index f85e35f3f..55e399302 100644 --- a/doc/en/Gtk/SettingsPropertyValue.xml +++ b/doc/en/Gtk/SettingsPropertyValue.xml @@ -31,11 +31,11 @@ - To be added - a + Constructor. + a , a pointer to the underlying C object. a - To be added + This is not for general developer use; it's mostly internal. - \ No newline at end of file + diff --git a/doc/en/Gtk/StockItem.xml b/doc/en/Gtk/StockItem.xml index 94d78541d..56ff69ce8 100644 --- a/doc/en/Gtk/StockItem.xml +++ b/doc/en/Gtk/StockItem.xml @@ -56,7 +56,7 @@ - To be added + Frees the memory used by this object. @@ -110,8 +110,8 @@ - To be added - To be added + Sets the modifier, if any, for this object's accelerator. + See for eligible keys and mouse button values. @@ -141,4 +141,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index 3d3266a09..b36556f2d 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -37,7 +37,7 @@ - To be added + Gets the foreground color for a particular state To be added: an object of type 'Gtk.StateType' To be added: an object of type 'Gdk.Color' To be added @@ -184,9 +184,9 @@ - To be added - To be added: an object of type 'Gtk.Style' - To be added + Copy this style object to a new style object. + A , a duplicate of this style. + @@ -215,10 +215,10 @@ - To be added - To be added: an object of type 'Gdk.Window' - To be added: an object of type 'Gtk.Style' - To be added + 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. + , the window to attach the style to + Either , or a newly-created . 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. + @@ -255,9 +255,9 @@ - To be added - To be added: an object of type 'Gtk.Style' - To be added + Public constructor + A new + @@ -267,9 +267,9 @@ Pango.FontDescription - To be added - To be added: an object of type 'Pango.FontDescription' - To be added + The font description used for a widget. + a + @@ -296,10 +296,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The X thickness, which is used for horizontal padding. + An integer to set the xthickness to. + An integer. + (FIXME: xthickness and ythickness could be better documented.) @@ -309,7 +309,7 @@ Gdk.Color [] - To be added + The foreground colors To be added: an object of type 'Gdk.Color []' To be added @@ -1257,4 +1257,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Text.xml b/doc/en/Gtk/Text.xml index c8820b725..31e813d4e 100644 --- a/doc/en/Gtk/Text.xml +++ b/doc/en/Gtk/Text.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Represents text. + GTK+ deprecates GtkText; this object is not the same as GtkText. System.Object @@ -29,10 +29,10 @@ - To be added + Test whether a given byte begins a UTF8 character. a - a - To be added + a , true if this byte is the start of a UTF8 character. + @@ -41,10 +41,10 @@ - To be added - a - To be added + Construct an empty string. + a new object. + (FIXME: what is this used for, given that it has no arguments?) - \ No newline at end of file + diff --git a/doc/en/Gtk/TextDeletedArgs.xml b/doc/en/Gtk/TextDeletedArgs.xml index 4bb0d5c53..9cff513df 100644 --- a/doc/en/Gtk/TextDeletedArgs.xml +++ b/doc/en/Gtk/TextDeletedArgs.xml @@ -58,9 +58,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The end position within the widget for the text that was deleted. + An integer for the end position; this character is not included in the deleted text. + @@ -70,10 +70,10 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The start position within the widget for the text that was deleted. + An integer for the start position. + - \ No newline at end of file + diff --git a/doc/en/Gtk/TextInsertedArgs.xml b/doc/en/Gtk/TextInsertedArgs.xml index ac60a8921..e302e2b1b 100644 --- a/doc/en/Gtk/TextInsertedArgs.xml +++ b/doc/en/Gtk/TextInsertedArgs.xml @@ -58,9 +58,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The position within the widget text where the text was inserted. + An integer, the insert position. + @@ -70,9 +70,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The length of the inserted text. + An integer, the length of the inserted text. + @@ -82,10 +82,10 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The text that was inserted. + A string that was inserted. + - \ No newline at end of file + diff --git a/doc/en/Gtk/TextIter.xml b/doc/en/Gtk/TextIter.xml index e4942b301..749214187 100644 --- a/doc/en/Gtk/TextIter.xml +++ b/doc/en/Gtk/TextIter.xml @@ -261,9 +261,9 @@ You do not want to use this function to decide whether text can be inserted at i - Moves iter forward by one character offset. - To be added: an object of type 'bool' - 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 for convenience when writing loops. + Moves this iterator forward by one character offset. + A boolean: if the iterator moved and is dereferenceable. + 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 for convenience when writing loops. @@ -542,7 +542,7 @@ The values parameter should be initialized to the default settings you wish to u Moves iter to the start of the next line. - To be added: an object of type 'bool' + A boolean; whether the iterator is dereferenceable Returns if there was a next line to move to, and 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. @@ -1167,4 +1167,4 @@ If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisibl - \ No newline at end of file + diff --git a/doc/en/Gtk/TextMark.xml b/doc/en/Gtk/TextMark.xml index afc9a0536..90addb216 100644 --- a/doc/en/Gtk/TextMark.xml +++ b/doc/en/Gtk/TextMark.xml @@ -100,7 +100,7 @@ System.Boolean - Whether of not the mark has been removed + Whether or not the mark has been removed Returns if the mark has been removed from its buffer. @@ -210,4 +210,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TextMarkBody.xml b/doc/en/Gtk/TextMarkBody.xml index 57552d4cc..7c564f46c 100644 --- a/doc/en/Gtk/TextMarkBody.xml +++ b/doc/en/Gtk/TextMarkBody.xml @@ -40,4 +40,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ThemeEngine.xml b/doc/en/Gtk/ThemeEngine.xml index f4bc92345..094444f16 100644 --- a/doc/en/Gtk/ThemeEngine.xml +++ b/doc/en/Gtk/ThemeEngine.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object wrapper for a Gtk theme engine. + GLib.Object @@ -116,10 +116,10 @@ - To be added + Protected constructor. a - To be added + Chain to this constructor if you have not manually registered a native value for your subclass. - \ No newline at end of file + diff --git a/doc/en/Gtk/TreeDragDest.xml b/doc/en/Gtk/TreeDragDest.xml index cf9e4f747..4a4d092aa 100644 --- a/doc/en/Gtk/TreeDragDest.xml +++ b/doc/en/Gtk/TreeDragDest.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - An object to represent the rows of a tree when something is drag-and-dropped onto them. + An interface to represent the rows of a tree when something is drag-and-dropped onto them. diff --git a/doc/en/Gtk/TreeDragSource.xml b/doc/en/Gtk/TreeDragSource.xml index 206064d38..335d41cf2 100644 --- a/doc/en/Gtk/TreeDragSource.xml +++ b/doc/en/Gtk/TreeDragSource.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - An object to represent the rows of a tree when one of them is dragged to another location. + An interface to represent the rows of a tree when one of them is dragged to another location. diff --git a/doc/en/Gtk/TreeModelSort.xml b/doc/en/Gtk/TreeModelSort.xml index c0962d068..276d5e018 100644 --- a/doc/en/Gtk/TreeModelSort.xml +++ b/doc/en/Gtk/TreeModelSort.xml @@ -43,9 +43,9 @@ - To be added - To be added: an object of type 'int' - To be added + Returns the number of children the object's iterator has. + An integer. + As a special case, if iter is , then the number of toplevel nodes is returned. @@ -430,9 +430,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The number of columns supported by the object. + An integer count of the columns. + @@ -442,9 +442,9 @@ Gtk.TreeModelFlags - To be added - To be added: an object of type 'Gtk.TreeModelFlags' - To be added + Returns a set of flags supported by this interface. The flags are a bitwise combination of . + a + The flags supported should not change during the lifecycle of the tree model. @@ -479,8 +479,8 @@ - To be added - To be added + Fired when a new row is inserted into the tree. + @@ -491,8 +491,8 @@ - To be added - To be added + Fired when a row is deleted from the tree. + @@ -503,8 +503,8 @@ - To be added - To be added + Fired when a tree row is changed. + @@ -515,8 +515,8 @@ - To be added - To be added + Fired when rows are reordered or moved around. +