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