docs/tmpl/atkselection.sgml

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