docs/tmpl/atkselection.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkSelection
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 The ATK interface implemented by container objects whose #AtkObject children
   7 can be selected.
   8
   9 <!-- ##### SECTION Long_Description ##### -->
  10 <para>
  11 #AtkSelection should be implemented by UI components with children which
  12 are exposed by #atk_object_ref_child and #atk_object_get_n_children, if
  13 the use of the parent UI component ordinarily involves selection of one
  14 or more of the objects corresponding to those #AtkObject children - for
  15 example, selectable lists.
  16 </para>
  17 <para>
  18 Note that other types of "selection" (for instance text selection) are
  19 accomplished a other ATK interfaces - #AtkSelection is limited to the
  20 selection/deselection of children.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25 #AtkText
  26 </para>
  27
  28 <!-- ##### STRUCT AtkSelection ##### -->
  29 <para>
  30 The AtkAction structure does not contain any fields.
  31
  32 </para>
  33
  34
  35 <!-- ##### STRUCT AtkSelectionIface ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @parent:
  41 @add_selection:
  42 @clear_selection:
  43 @ref_selection:
  44 @get_selection_count:
  45 @is_child_selected:
  46 @remove_selection:
  47 @select_all_selection:
  48 @selection_changed:
  49 @pad1:
  50 @pad2:
  51
  52 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @selection:
  58 @i:
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION atk_selection_clear_selection ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @selection:
  68 @Returns:
  69
  70
  71 <!-- ##### FUNCTION atk_selection_ref_selection ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @selection:
  77 @i:
  78 @Returns:
  79
  80
  81 <!-- ##### FUNCTION atk_selection_get_selection_count ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @selection:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION atk_selection_is_child_selected ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @selection:
  96 @i:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION atk_selection_remove_selection ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @selection:
 106 @i:
 107 @Returns:
 108
 109
 110 <!-- ##### FUNCTION atk_selection_select_all_selection ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @selection:
 116 @Returns:
 117
 118
 119 <!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @atkselection: the object which received the signal.
 125