atk/atkselection.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __ATK_SELECTION_H__
  21 #define __ATK_SELECTION_H__
  22
  23 #include <atk/atkobject.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /*
  30  * This AtkSelection interface provides the standard mechanism for an
  31  * assistive technology to determine what the current selected children are,
  32  * as well as modify the selection set. Any object that has children that
  33  * can be selected should support the AtkSelection interface.
  34  */
  35
  36 #define ATK_TYPE_SELECTION                        (atk_selection_get_type ())
  37 #define ATK_IS_SELECTION(obj)                     G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SELECTION)
  38 #define ATK_SELECTION(obj)                        G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SELECTION, AtkSelection)
  39 #define ATK_SELECTION_GET_IFACE(obj)              (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_SELECTION, AtkSelectionIface))
  40
  41 #ifndef _TYPEDEF_ATK_SELECTION_
  42 #define _TYPEDEF_ATK_SELECTION_
  43 typedef struct _AtkSelection AtkSelection;
  44 #endif
  45 typedef struct _AtkSelectionIface AtkSelectionIface;
  46
  47 struct _AtkSelectionIface
  48 {
  49   GTypeInterface parent;
  50
  51   /*
  52    * Adds the specified accessible child of the object to the
  53    * object's selection.
  54    */
  55   void         (* add_selection)        (AtkSelection   *selection,
  56                                          gint           i);
  57   /*
  58    * Clears the selection in the object so that no children in the object
  59    * are selected.
  60    */
  61   void         (* clear_selection)      (AtkSelection   *selection);
  62   /*
  63    * Returns a reference to the accessible object representing the specified
  64    * selected * child of the object.
  65    */
  66   AtkObject*   (* ref_selection)        (AtkSelection   *selection,
  67                                          gint           i);
  68   /*
  69    * Returns the number of accessible children currently selected.
  70    */
  71   gint         (* get_selection_count)  (AtkSelection   *selection);
  72   /*
  73    * Determines if the current child of this object is selected
  74    */
  75   gboolean     (* is_child_selected)    (AtkSelection   *selection,
  76                                          gint           i);
  77   /*
  78    * Removes the specified child of the object from the object's selection.
  79    */
  80   void         (* remove_selection)     (AtkSelection   *selection,
  81                                          gint           i);
  82   /*
  83    * Causes every child of the object to be selected if the object
  84    * supports multiple selections.
  85    */
  86   void         (* select_all_selection) (AtkSelection   *selection);
  87
  88 };
  89 GType atk_selection_get_type ();
  90
  91 void         atk_selection_add_selection        (AtkSelection   *selection,
  92                                                  gint           i);
  93
  94 void         atk_selection_clear_selection      (AtkSelection   *selection);
  95
  96 AtkObject*   atk_selection_ref_selection        (AtkSelection   *selection,
  97                                                  gint           i);
  98
  99 gint         atk_selection_get_selection_count  (AtkSelection   *selection);
 100
 101 gboolean     atk_selection_is_child_selected    (AtkSelection   *selection,
 102                                                  gint           i);
 103
 104 void         atk_selection_remove_selection     (AtkSelection   *selection,
 105                                                  gint           i);
 106
 107 void         atk_selection_select_all_selection (AtkSelection   *selection);
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif /* __cplusplus */
 112
 113
 114 #endif /* __ATK_SELECTION_H__ */