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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  19 #error "Only <atk/atk.h> can be included directly."
  20 #endif
  21
  22 #ifndef __ATK_SELECTION_H__
  23 #define __ATK_SELECTION_H__
  24
  25 #include <atk/atkobject.h>
  26
  27 G_BEGIN_DECLS
  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   gboolean     (* add_selection)        (AtkSelection   *selection,
  52                                          gint           i);
  53   gboolean     (* clear_selection)      (AtkSelection   *selection);
  54   AtkObject*   (* ref_selection)        (AtkSelection   *selection,
  55                                          gint           i);
  56   gint         (* get_selection_count)  (AtkSelection   *selection);
  57   gboolean     (* is_child_selected)    (AtkSelection   *selection,
  58                                          gint           i);
  59   gboolean     (* remove_selection)     (AtkSelection   *selection,
  60                                          gint           i);
  61   gboolean     (* select_all_selection) (AtkSelection   *selection);
  62
  63   /* signal handlers */
  64
  65   void         (*selection_changed)     (AtkSelection   *selection);
  66 };
  67
  68 GType atk_selection_get_type (void);
  69
  70 gboolean     atk_selection_add_selection        (AtkSelection   *selection,
  71                                                  gint           i);
  72
  73 gboolean     atk_selection_clear_selection      (AtkSelection   *selection);
  74
  75 AtkObject*   atk_selection_ref_selection        (AtkSelection   *selection,
  76                                                  gint           i);
  77
  78 gint         atk_selection_get_selection_count  (AtkSelection   *selection);
  79
  80 gboolean     atk_selection_is_child_selected    (AtkSelection   *selection,
  81                                                  gint           i);
  82
  83 gboolean     atk_selection_remove_selection     (AtkSelection   *selection,
  84                                                  gint           i);
  85
  86 gboolean     atk_selection_select_all_selection (AtkSelection   *selection);
  87
  88 G_END_DECLS
  89
  90 #endif /* __ATK_SELECTION_H__ */