From bf3872b0ae67417c5c0c32f0cc080f7784a1bd8d Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Tue, 22 Jun 2004 19:42:27 +0000 Subject: [PATCH] More docs, papacito svn path=/trunk/gtk-sharp/; revision=30138 --- doc/en/Atk/Relation.xml | 22 +++++--- doc/en/Atk/RelationSet.xml | 55 +++++++++++--------- doc/en/Atk/Selection.xml | 100 +++++++++++++++++++++++++++---------- 3 files changed, 123 insertions(+), 54 deletions(-) diff --git a/doc/en/Atk/Relation.xml b/doc/en/Atk/Relation.xml index 9dca19a44..91ed69635 100644 --- a/doc/en/Atk/Relation.xml +++ b/doc/en/Atk/Relation.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 + An describes a relation between an object and one or more other objects. + + + An describes a relation between an object and + one or more other objects. + + + The actual relations that an object has with other objects are + defined as an , which is a set of + . + + GLib.Object @@ -63,7 +73,7 @@ - + n To be added an object of type an object of type @@ -79,9 +89,9 @@ Atk.RelationType - To be added - an object of type - To be added + Gets the type of relation. + The type of this relation + diff --git a/doc/en/Atk/RelationSet.xml b/doc/en/Atk/RelationSet.xml index d903cf77e..b342ed961 100644 --- a/doc/en/Atk/RelationSet.xml +++ b/doc/en/Atk/RelationSet.xml @@ -10,8 +10,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + A set of , normally the set which + an has. + + GLib.Object @@ -36,10 +39,13 @@ - To be added - an object of type - an object of type - To be added + Determines the relation at the specified position in the relation set. + An representing a position in the set, starting from 0. + + An , which is the relation at + position in the set. + + @@ -52,10 +58,10 @@ - To be added - an object of type - an object of type - To be added + Finds a relation that matches the specified type. + An + An , which is a relation matching the specified type. + @@ -68,9 +74,9 @@ - To be added - an object of type - To be added + Add a new relation to the current relation set if it is not already present. + an + @@ -83,10 +89,13 @@ - To be added - an object of type - an object of type - To be added + Determines whether the relation set contains a relation that matches the specified type. + An . + + if relationship is the relationship + type of a relation in set, otherwise. + + @@ -99,9 +108,9 @@ - To be added - an object of type - To be added + Removes a relation from the relation set. + An . + @@ -150,9 +159,9 @@ System.Int32 - To be added - an object of type - To be added + Determines the number of relations in a relation set. + An integer representing the number of relations in the set. + diff --git a/doc/en/Atk/Selection.xml b/doc/en/Atk/Selection.xml index ac07cb88a..bec5e8a7b 100644 --- a/doc/en/Atk/Selection.xml +++ b/doc/en/Atk/Selection.xml @@ -10,8 +10,28 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + The ATK interface implemented by container objects whose children can be selected. + + + + The ATK interface implemented by container objects whose children can be selected. + + + This should be implemented by UI components with children + which are exposed by and + , if the use of the parent UI + component ordinarily involves selection of one or more of the + objects corresponding to those AtkObject children - for + example, selectable lists. + + + Note that other types of "selection" (for instance text + selection) are accomplished a other ATK interfaces - + is limited to the selection/deselection of + children. + + @@ -29,9 +49,11 @@ - To be added - To be added: an object of type 'bool' - To be added + Causes every child of the object to be selected if the object supports multiple selections. + + if success, otherwise. + + @@ -44,10 +66,16 @@ - 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 child of the object from the object's selection. + + A specifying the index in the selection set. (e.g. the + ith selection as opposed to the ith child). + + + if success, + otherwise. + + @@ -60,10 +88,17 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Determines if the current child of this object is selected. + A specifying the child index. + A bool representing the specified child is selected, or 0 if selection does not implement this interface. + + + Callers should not rely on 0 or on a zero value for + indication of whether AtkSelectionIface is implemented, they + should use type checking/interface checking macros or the + atk_get_accessible_value() convenience method. + + @@ -74,9 +109,11 @@ - To be added - To be added: an object of type 'bool' - To be added + Clears the selection in the object so that no children in the object are selected. + + if success, otherwise. + + @@ -89,10 +126,12 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Adds the specified accessible child of the object to the object's selection. + A specifying the child index. + + if success, otherwise. + + @@ -118,9 +157,20 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Gets the number of accessible children currently selected. + + A representing the number of items + selected, or 0 if selection does not implement this + interface. + + + + Callers should not rely on 0 or on a zero value for + indication of whether AtkSelectionIface is implemented, + they should use type checking/interface checking macros or + the atk_get_accessible_value() convenience method. + + @@ -131,8 +181,8 @@ - To be added - To be added + Event fired when the selected is changed. +