Remove comments about signals. The description should be in files in
[platform/upstream/atk.git] / docs / tmpl / atkselection.sgml
index fdeb7b7..b3a6148 100644 (file)
@@ -3,37 +3,34 @@ AtkSelection
 
 <!-- ##### SECTION Short_Description ##### -->
 
+The ATK interface implemented by container objects whose #AtkObject children
+can be selected.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+#AtkSelection should be implemented by UI components with children which
+are exposed by #atk_object_ref_child and #atk_object_get_n_children, 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.
 </para>
-
-<!-- ##### SECTION See_Also ##### -->
 <para>
-
+Note that other types of "selection" (for instance text selection) are
+accomplished a other ATK interfaces - #AtkSelection is limited to the
+selection/deselection of children.
 </para>
 
-<!-- ##### STRUCT AtkSelection ##### -->
+<!-- ##### SECTION See_Also ##### -->
 <para>
-
+#AtkText
 </para>
 
-
-<!-- ##### STRUCT AtkSelectionIface ##### -->
+<!-- ##### STRUCT AtkSelection ##### -->
 <para>
+The AtkAction structure does not contain any fields.
 
 </para>
 
-@parent: 
-@add_selection: 
-@clear_selection: 
-@ref_selection: 
-@get_selection_count: 
-@is_child_selected: 
-@remove_selection: 
-@select_all_selection: 
-@selection_changed: 
 
 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
 <para>
@@ -102,3 +99,11 @@ AtkSelection
 @Returns: 
 
 
+<!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
+<para>
+The "selection-changed" signal is emitted by an object which implements 
+AtkSelection interface when the selection changes.
+</para>
+
+@atkselection: the object which received the signal.
+