diff --git a/doc/ChangeLog b/doc/ChangeLog index dda5b01a3..0cefad018 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2004-07-27 John Luke + + some GLib and Atk docs + 2004-07-21 John Luke * en/Gtk/TextView.xml: diff --git a/doc/en/Atk/Document.xml b/doc/en/Atk/Document.xml index e60d7ffa9..d5e12f34d 100644 --- a/doc/en/Atk/Document.xml +++ b/doc/en/Atk/Document.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 interface which allows access to a DOM associated with on object. + The interface should be supported by any object that has an associated document object model (DOM). This interface provides the standard mechanism allowing an assistive technology access to the DOM. @@ -28,9 +28,9 @@ System.IntPtr - To be added - To be added: an object of type 'IntPtr' - To be added + Gets a pointer that points to an instance of the DOM. + a pointer to an instance of the DOM. + @@ -40,9 +40,9 @@ System.String - To be added - To be added: an object of type 'string' - To be added + Gets a string indicating the document type. + a string indicating the document type + diff --git a/doc/en/Atk/Hypertext.xml b/doc/en/Atk/Hypertext.xml index 511f66351..47a66323b 100644 --- a/doc/en/Atk/Hypertext.xml +++ b/doc/en/Atk/Hypertext.xml @@ -10,8 +10,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The interface which provides standard mechanism for manipulating hyperlinks. + + @@ -31,10 +32,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The index into the array of hyperlinks that is associated with the character specified by , or -1 if there is no hyperlink associated with this character. + a character index + an index into the array of hyperlinks in hypertext + @@ -47,10 +48,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'Atk.Hyperlink' - To be added + The link in this hypertext document at index + an integer specifying the desired link + the link in this hypertext document at index + @@ -60,9 +61,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The number of links within this hypertext document. + The number of links within this hypertext document. + diff --git a/doc/en/Atk/StreamableContent.xml b/doc/en/Atk/StreamableContent.xml index 0593b729b..0381362a2 100644 --- a/doc/en/Atk/StreamableContent.xml +++ b/doc/en/Atk/StreamableContent.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 interface which provides access to streamable content. + @@ -31,10 +31,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'string' - To be added + The string of the specified mime type. + an int representing the position of the mime type starting from 0 + a string representing the specified mime type + The first mime type is at position 0, the second at position 1, and so on. @@ -44,9 +44,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The number of mime types supported by this object. + the number of mime types supported by the object. + diff --git a/doc/en/Atk/Table.xml b/doc/en/Atk/Table.xml index da9c7af71..2ccafe2fc 100644 --- a/doc/en/Atk/Table.xml +++ b/doc/en/Atk/Table.xml @@ -10,8 +10,18 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The interface implemented for UI components which contain tabular or row/column information. + + + should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple "columns". Individual elements of an are typically referred to as "cells", and these cells are exposed by as child s of the . Both row/column and child-index-based access to these children is provided. + + +Children of are frequently "lightweight" objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient. + + +Since tables are often very complex, includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are s which may implement other interfaces (, , etc.) as appropriate. summaries may themselves be (simplified) s, etc. + + diff --git a/doc/en/Atk/Text.xml b/doc/en/Atk/Text.xml index 3771479bd..41c0b3e3b 100644 --- a/doc/en/Atk/Text.xml +++ b/doc/en/Atk/Text.xml @@ -10,8 +10,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The interface implemented by components with text content. + + + should be implemented by s on behalf of widgets that have text content which is either attributed or otherwise non-trivial. s whose text content is simple, unattributed, and very brief may expose that content via atk_object_get_name instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the interface should be used to expose the text content. In the case of editable text content, (a subtype of the interface) should be implemented instead. + + + provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. + + diff --git a/doc/en/Atk/Util.xml b/doc/en/Atk/Util.xml index 15c7b85df..f33f30f88 100644 --- a/doc/en/Atk/Util.xml +++ b/doc/en/Atk/Util.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 is a utility class which supports the adding and removal of event listeners. + The adding and removing of the listeners must be done in the same thread. The file also contains a number of utility functions. GLib.Object diff --git a/doc/en/Atk/Value.xml b/doc/en/Atk/Value.xml index 2749fa4cd..c5a521f39 100644 --- a/doc/en/Atk/Value.xml +++ b/doc/en/Atk/Value.xml @@ -10,8 +10,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The interface implemented by valuators and components which display or select a value from a bounded range of values. + + + should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have representations which implement on the component's behalf. s may be read-only, in which case attempts to alter the value return to indicate failure. diff --git a/doc/en/GLib/MainContext.xml b/doc/en/GLib/MainContext.xml index 82da8dfaf..d9a2b3b9e 100644 --- a/doc/en/GLib/MainContext.xml +++ b/doc/en/GLib/MainContext.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 + Manages events in the main context. + System.Object @@ -27,9 +27,9 @@ - To be added + Checks if any sources have pending events for the given context. an object of type - To be added + @@ -42,10 +42,10 @@ - To be added + Runs a single iteration for the given main loop. an object of type an object of type - To be added + This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and is , waiting for a source to become ready, then dispatching the highest priority events sources that are ready. Note that even when is , it is still possible for g_main_context_iteration() to return , since the the wait may be interrupted for other reasons than an event source becoming ready. @@ -56,9 +56,9 @@ - To be added + Runs a single iteration for the given main loop. an object of type - To be added + This is a convenience overload for with passed in. diff --git a/doc/en/GLib/Markup.xml b/doc/en/GLib/Markup.xml index bcf6a4f93..d26761021 100644 --- a/doc/en/GLib/Markup.xml +++ b/doc/en/GLib/Markup.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. - To be added - To be added + Wrapper for glib markup + System.Object @@ -29,10 +29,11 @@ - To be added - an object of type - an object of type - To be added + Escapes text so that the markup parser will parse it verbatim. + some valid Utf8 text + escaped text + Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser. +Note that this function does not protect whitespace and line endings from being processed according to the XML rules for normalization of line endings and attribute values. diff --git a/doc/en/GLib/Object.xml b/doc/en/GLib/Object.xml index 64de3445c..8a1a5ecae 100644 --- a/doc/en/GLib/Object.xml +++ b/doc/en/GLib/Object.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 + Base class for all of Gtk#. + System.Object