From 076642e2c725d90ca2cf35db4a86903fd86857b7 Mon Sep 17 00:00:00 2001 From: John Luke Date: Mon, 2 Aug 2004 02:38:30 +0000 Subject: [PATCH] some more docs: Glade and Atk mostly svn path=/trunk/gtk-sharp/; revision=31721 --- doc/en/Atk/Attribute.xml | 20 +- doc/en/Atk/FocusHandler.xml | 2 +- doc/en/Atk/PropertyChangeHandler.xml | 2 +- doc/en/Atk/Text.xml | 283 +++++++++++++++------- doc/en/Atk/Util.xml | 4 +- doc/en/Atk/Value.xml | 25 +- doc/en/Glade/AccelInfo.xml | 14 +- doc/en/Glade/AtkActionInfo.xml | 16 +- doc/en/Glade/AtkRelationInfo.xml | 16 +- doc/en/Glade/ChildInfo.xml | 16 +- doc/en/Glade/Global.xml | 8 +- doc/en/Glade/HandlerNotFoundException.xml | 4 +- doc/en/Glade/Interface.xml | 28 +-- doc/en/Glade/Parser.xml | 19 +- doc/en/Glade/Property.xml | 16 +- doc/en/Glade/SignalInfo.xml | 16 +- doc/en/Glade/Standard.xml | 16 +- doc/en/Glade/WidgetInfo.xml | 16 +- doc/en/Glade/XML.xml | 20 +- 19 files changed, 326 insertions(+), 215 deletions(-) diff --git a/doc/en/Atk/Attribute.xml b/doc/en/Atk/Attribute.xml index 100ca70a9..d6b28aca2 100644 --- a/doc/en/Atk/Attribute.xml +++ b/doc/en/Atk/Attribute.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 + A string name/value pair representing a text attribute. + System.ValueType @@ -27,7 +27,7 @@ - To be added + Returns an empty To be added @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Atk.Attribute' - To be added + Internal method + an object of type + a new + This is an internal method and should not be used by user code. @@ -56,8 +56,8 @@ - To be added - To be added + The attribute name. + @@ -69,7 +69,7 @@ - To be added + the value of the attribute, represented as a string. To be added diff --git a/doc/en/Atk/FocusHandler.xml b/doc/en/Atk/FocusHandler.xml index 718611a01..0075b6dd9 100644 --- a/doc/en/Atk/FocusHandler.xml +++ b/doc/en/Atk/FocusHandler.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Event handler. To be added diff --git a/doc/en/Atk/PropertyChangeHandler.xml b/doc/en/Atk/PropertyChangeHandler.xml index 09b699acb..b29d8e161 100644 --- a/doc/en/Atk/PropertyChangeHandler.xml +++ b/doc/en/Atk/PropertyChangeHandler.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Event handler. To be added diff --git a/doc/en/Atk/Text.xml b/doc/en/Atk/Text.xml index 41c0b3e3b..32a7a2b3e 100644 --- a/doc/en/Atk/Text.xml +++ b/doc/en/Atk/Text.xml @@ -40,12 +40,13 @@ - 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 'Atk.CoordType' - To be added: an object of type 'int' - To be added + Gets the offset of the character located at coordinates and . + screen x-position of character + screen y-position of character + specify whether coordinates are relative to the screen or widget window + the offset to the character which is located at the specified x and y coordinates. + + and are interpreted as being relative to the screen or this widget's window depending on . @@ -60,12 +61,13 @@ - 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 'int' - To be added: an object of type 'bool' - To be added + Changes the start and end offset of the specified selection. + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. + the new start position of the selection + the new end position of the selection + + if success, otherwise + @@ -78,10 +80,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Sets the caret (cursor) position to the specified offset. + position + + if success, otherwise. + @@ -94,10 +97,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Removes the specified selection. + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. + + if success, otherwise + @@ -111,11 +115,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 + Gets the specified text. + start position + end position + the text from up to, but not including . + @@ -129,11 +133,12 @@ - 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 + Adds a selection bounded by the specified offsets. + the start position of the selected region + the end position of the selected region + + if success, otherwise + @@ -143,9 +148,9 @@ GLib.SList - To be added - To be added: an object of type 'GLib.SList' - To be added + Creates an which consists of the default values of attributes for the text. + an which contains the default values of attributes, at . + See the enum for types of text attributes that can be returned. Note that other attributes may also be returned. @@ -155,9 +160,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the number of selected regions. + The number of selected regions, or -1 if a failure occurred. + @@ -167,9 +172,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the offset position of the caret (cursor). + the offset position of the caret (cursor). + @@ -179,9 +184,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the character count. + the number of characters. + @@ -192,8 +197,8 @@ - To be added - To be added + Emitted when the text of the object which implements the AtkText interface changes. + This signal will have a detail which is either "insert" or "delete" which identifies whether the text change was an insertion or a deletion. @@ -204,8 +209,8 @@ - To be added - To be added + Emitted when the selected text of an object which implements AtkText changes. + @@ -216,8 +221,8 @@ - To be added - To be added + Emitted when the caret position of the text of an object which implements AtkText changes. + @@ -228,8 +233,8 @@ - To be added - To be added + Emitted when the text attributes of the text of an object which implements AtkText changes. + @@ -245,13 +250,47 @@ - To be added - a + Gets the specified text. + position a - a - a - a - To be added + the start offset of the returned string. + the end offset of the returned string. + the text after bounded by the specified . + + +If the is the character after the offset is returned. + + +If the is the returned string is from the word start after the offset to the next word start. + + +The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word. + + +If the is the returned string is from the word end at or after the offset to the next work end. + + +The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word. + + +If the is the returned string is from the sentence start after the offset to the next sentence start. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence. + + +If the is the returned string is from the sentence end at or after the offset to the next sentence end. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence. + + +If the is the returned string is from the line start after the offset to the next line start. + + +If the is the returned string is from the line end at or after the offset to the next line start. + + @@ -266,12 +305,12 @@ - To be added - a - a - a - a - To be added + Gets the text from the specified selection. + The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. + passes back the start position of the selected region + passes back the end position of the selected region + the selected text. + @@ -287,13 +326,47 @@ - To be added - a + Gets the specified text. + position a - a - a - a - To be added + the start offset of the returned string. + the end offset of the returned string. + the text before bounded by the specified . + + +If the is the character after the offset is returned. + + +If the is the returned string is from the word start after the offset to the next word start. + + +The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word. + + +If the is the returned string is from the word end at or after the offset to the next work end. + + +The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word. + + +If the is the returned string is from the sentence start after the offset to the next sentence start. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence. + + +If the is the returned string is from the sentence end at or after the offset to the next sentence end. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence. + + +If the is the returned string is from the line start after the offset to the next line start. + + +If the is the returned string is from the line end at or after the offset to the next line start. + + @@ -311,14 +384,14 @@ - To be added - a - a - a - a - a - a - To be added + Get the bounding box containing the glyph representing the character at a particular text offset. + The offset of the text character for which bounding information is required. + Pointer for the x cordinate of the bounding box. + Pointer for the y cordinate of the bounding box. + Pointer for the width of the bounding box + Pointer for the height of the bounding box. + specify whether coordinates are relative to the screen or widget window + @@ -333,12 +406,12 @@ - To be added - a - a - a - a - To be added + Creates an which consists of the attributes explicitly set at the position offset in the text. and are set to the start and end of the range around where the attributes are invariant. + the offset at which to get the attributes + the address to put the start offset of the range + the address to put the end offset of the range + an which contains the attributes explicitly set at . + See the enum for types of text attributes that can be returned. Note that other attributes may also be returned. @@ -354,13 +427,47 @@ - To be added - a + Gets the specified text. + position a - a - a - a - To be added + the start offset of the returned string. + the end offset of the returned string. + the text at bounded by the specified . + + +If the is the character after the offset is returned. + + +If the is the returned string is from the word start after the offset to the next word start. + + +The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word. + + +If the is the returned string is from the word end at or after the offset to the next work end. + + +The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word. + + +If the is the returned string is from the sentence start after the offset to the next sentence start. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence. + + +If the is the returned string is from the sentence end at or after the offset to the next sentence end. + + +The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence. + + +If the is the returned string is from the line start after the offset to the next line start. + + +If the is the returned string is from the line end at or after the offset to the next line start. + + diff --git a/doc/en/Atk/Util.xml b/doc/en/Atk/Util.xml index f33f30f88..3ad0a2421 100644 --- a/doc/en/Atk/Util.xml +++ b/doc/en/Atk/Util.xml @@ -87,9 +87,9 @@ - To be added + Default constructor a - To be added + diff --git a/doc/en/Atk/Value.xml b/doc/en/Atk/Value.xml index c5a521f39..f6e06da9f 100644 --- a/doc/en/Atk/Value.xml +++ b/doc/en/Atk/Value.xml @@ -33,9 +33,10 @@ - To be added - an object of type - an object of type + Sets the value of this object. + an object of type which is the desired new accessible value. + + if new value is successfully set, otherwise . To be added @@ -49,9 +50,9 @@ - To be added - an object of type - To be added + Gets the minimum value of this object. + an object of type representing the minimum accessible value + @@ -64,9 +65,9 @@ - To be added - an object of type - To be added + Gets the maximum value of this object. + an object of type representing the maximum accessible value + @@ -79,9 +80,9 @@ - Internal constructor - To be added: an object of type 'GLib.Value' - This is a constructor used by derivative types of that would have their own GLib.GType assigned to it. This is not typically used by C# code. + Gets the value of this object. + an object of type representing the current accessible value + diff --git a/doc/en/Glade/AccelInfo.xml b/doc/en/Glade/AccelInfo.xml index df46d030e..815a12fbc 100644 --- a/doc/en/Glade/AccelInfo.xml +++ b/doc/en/Glade/AccelInfo.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + The structure is used as part of the output of libglade's XML parser. To be added @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.AccelInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/AtkActionInfo.xml b/doc/en/Glade/AtkActionInfo.xml index 6ceebb6e7..429c369d2 100644 --- a/doc/en/Glade/AtkActionInfo.xml +++ b/doc/en/Glade/AtkActionInfo.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 + This structure is used as part of the output of libglade's XML parser. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.AtkActionInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/AtkRelationInfo.xml b/doc/en/Glade/AtkRelationInfo.xml index 78608bb65..a4c3ea529 100644 --- a/doc/en/Glade/AtkRelationInfo.xml +++ b/doc/en/Glade/AtkRelationInfo.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 + The structure is used as part of the output of libglade's XML parser. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.AtkRelationInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/ChildInfo.xml b/doc/en/Glade/ChildInfo.xml index 74ccc3ce6..c100f74ad 100644 --- a/doc/en/Glade/ChildInfo.xml +++ b/doc/en/Glade/ChildInfo.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 + The structure is used as part of the output of libglade's XML parser. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.ChildInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/Global.xml b/doc/en/Glade/Global.xml index 454f5b159..cb02c43a8 100644 --- a/doc/en/Glade/Global.xml +++ b/doc/en/Glade/Global.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 + Global API elements for + System.Object @@ -88,9 +88,9 @@ - To be added + Default constructor a - To be added + diff --git a/doc/en/Glade/HandlerNotFoundException.xml b/doc/en/Glade/HandlerNotFoundException.xml index c34873259..c8ac3e0b6 100644 --- a/doc/en/Glade/HandlerNotFoundException.xml +++ b/doc/en/Glade/HandlerNotFoundException.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 + Exception thrown when signal autoconnection fails. + System.Exception diff --git a/doc/en/Glade/Interface.xml b/doc/en/Glade/Interface.xml index 72b651f06..69c93fd55 100644 --- a/doc/en/Glade/Interface.xml +++ b/doc/en/Glade/Interface.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 + The structures described here are the output of libglade's XML parser. + These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.Interface' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. @@ -55,8 +55,8 @@ - To be added - To be added + Frees the resources of this interface. + @@ -69,9 +69,9 @@ - To be added - To be added: an object of type 'string' - To be added + This function dumps the contents of a into a file as XML. + a + It is intended mainly as a debugging tool. @@ -82,7 +82,7 @@ To be added - To be added: an object of type 'Glade.WidgetInfo' + an object of type To be added diff --git a/doc/en/Glade/Parser.xml b/doc/en/Glade/Parser.xml index 17efa0a72..d2384892d 100644 --- a/doc/en/Glade/Parser.xml +++ b/doc/en/Glade/Parser.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 + Glade's parser used to turn XML into its internal format. + System.Object @@ -30,11 +30,11 @@ - To be added + This function parses a Glade XML interface file to a object (which is libglade's internal representation of the interface data). a a a - To be added + Generally, user code will not need to call this function. Instead, it should go through the interfaces. @@ -48,11 +48,14 @@ - To be added + This function is similar to , except that it parses XML data from a buffer in memory. a a a - To be added + This could be used to embed an interface into the executable, for instance. + +Generally, user code will not need to call this function. Instead, it should go through the interfaces. + @@ -61,9 +64,9 @@ - To be added + Default constructor a - To be added + diff --git a/doc/en/Glade/Property.xml b/doc/en/Glade/Property.xml index e393d7b43..027524ff7 100644 --- a/doc/en/Glade/Property.xml +++ b/doc/en/Glade/Property.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 + The structure is used as part of the output of libglade's XML parser. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.Property' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/SignalInfo.xml b/doc/en/Glade/SignalInfo.xml index dca889db7..100ec1c00 100644 --- a/doc/en/Glade/SignalInfo.xml +++ b/doc/en/Glade/SignalInfo.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 + The structure is used as part of the output of libglade's XML parser. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.SignalInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/Standard.xml b/doc/en/Glade/Standard.xml index adc3e95ea..28461863d 100644 --- a/doc/en/Glade/Standard.xml +++ b/doc/en/Glade/Standard.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 + Some standard methods used by glade to build widgets. + System.Object @@ -31,11 +31,11 @@ - To be added + This is the standard child building function. a a a - To be added + It simply calls on each child to add them to the parent, and process any packing properties using the generic container packing properties interfaces. @@ -44,9 +44,9 @@ - To be added + Default constructor a - To be added + @@ -61,12 +61,12 @@ - To be added + This is the standard widget building function. a a a a - To be added + It processes all the widget properties using the standard object properties interfaces. This function will be sufficient for most widget types, thus reducing the amount of work needed to wrap a library. diff --git a/doc/en/Glade/WidgetInfo.xml b/doc/en/Glade/WidgetInfo.xml index 8e168611e..04823093e 100644 --- a/doc/en/Glade/WidgetInfo.xml +++ b/doc/en/Glade/WidgetInfo.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 + The structures described here are the output of libglade's XML parser. + These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Glade.WidgetInfo' - To be added + Internal method + an object of type + an object of type + This is an internal method and should not be used by user code. diff --git a/doc/en/Glade/XML.xml b/doc/en/Glade/XML.xml index 1d303ff98..e5d094e9d 100644 --- a/doc/en/Glade/XML.xml +++ b/doc/en/Glade/XML.xml @@ -652,8 +652,8 @@ public class GladeApp This is used while the tree is being built to set the toplevel window that is currently being built. - To be added: an object of type 'Gtk.Window' - To be added: an object of type 'Gtk.Window' + an object of type + an object of type This is used while the tree is being built to set the @@ -735,8 +735,8 @@ public class GladeApp returns a widget created from the glade xml file. - a or null when the the widget with taht name is't found. - To be added + a or null when the the widget with that name is not found. + An indexer of the widgets that acts like GetWidget @@ -751,12 +751,12 @@ public class GladeApp - To be added + Creates a new from a stream. a a a a - To be added + Reads the contents of the stream and parses it. It must be in correct Glade format @@ -772,13 +772,13 @@ public class GladeApp - To be added + Returns a new from a resource in an assembly. a a a a a - To be added + Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format @@ -793,12 +793,12 @@ public class GladeApp - To be added + Returns a new from a resource in the current assembly. a a a a - To be added + Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format