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
   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
  31 </para>
  32
  33
  34 <!-- ##### STRUCT AtkSelectionIface ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @parent:
  40 @add_selection:
  41 @clear_selection:
  42 @ref_selection:
  43 @get_selection_count:
  44 @is_child_selected:
  45 @remove_selection:
  46 @select_all_selection:
  47 @selection_changed:
  48 @pad1:
  49 @pad2:
  50
  51 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @selection:
  57 @i:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION atk_selection_clear_selection ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @selection:
  67 @Returns:
  68
  69
  70 <!-- ##### FUNCTION atk_selection_ref_selection ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @selection:
  76 @i:
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION atk_selection_get_selection_count ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @selection:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION atk_selection_is_child_selected ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @selection:
  95 @i:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION atk_selection_remove_selection ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @selection:
 105 @i:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION atk_selection_select_all_selection ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @selection:
 115 @Returns:
 116
 117