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 <!-- ##### SECTION Stability_Level ##### -->
  29
  30
  31 <!-- ##### SECTION Image ##### -->
  32
  33
  34 <!-- ##### STRUCT AtkSelection ##### -->
  35 <para>
  36 The AtkAction structure does not contain any fields.
  37
  38 </para>
  39
  40
  41 <!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
  42 <para>
  43 The "selection-changed" signal is emitted by an object which implements
  44 AtkSelection interface when the selection changes.
  45 </para>
  46
  47 @atkselection: the object which received the signal.
  48
  49 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @selection:
  55 @i:
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION atk_selection_clear_selection ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @selection:
  65 @Returns:
  66
  67
  68 <!-- ##### FUNCTION atk_selection_ref_selection ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @selection:
  74 @i:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION atk_selection_get_selection_count ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @selection:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION atk_selection_is_child_selected ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @selection:
  93 @i:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION atk_selection_remove_selection ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @selection:
 103 @i:
 104 @Returns:
 105
 106
 107 <!-- ##### FUNCTION atk_selection_select_all_selection ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @selection:
 113 @Returns:
 114
 115