atk-1.0/atk/atkselection.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2001 Sun Microsystems Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_SELECTION_H__
0021 #define __ATK_SELECTION_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <atk/atkobject.h>
0028
0029 G_BEGIN_DECLS
0030
0031 /*
0032  * This AtkSelection interface provides the standard mechanism for an
0033  * assistive technology to determine what the current selected children are,
0034  * as well as modify the selection set. Any object that has children that
0035  * can be selected should support the AtkSelection interface.
0036  */
0037
0038 #define ATK_TYPE_SELECTION (atk_selection_get_type ())
0039 #define ATK_IS_SELECTION(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SELECTION)
0040 #define ATK_SELECTION(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SELECTION, AtkSelection)
0041 #define ATK_SELECTION_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_SELECTION, AtkSelectionIface))
0042
0043 #ifndef _TYPEDEF_ATK_SELECTION_
0044 #define _TYPEDEF_ATK_SELECTION_
0045 typedef struct _AtkSelection AtkSelection;
0046 #endif
0047 typedef struct _AtkSelectionIface AtkSelectionIface;
0048
0049 struct _AtkSelectionIface
0050 {
0051   GTypeInterface parent;
0052
0053   gboolean (*add_selection) (AtkSelection *selection,
0054                              gint i);
0055   gboolean (*clear_selection) (AtkSelection *selection);
0056   AtkObject *(*ref_selection) (AtkSelection *selection,
0057                                gint i);
0058   gint (*get_selection_count) (AtkSelection *selection);
0059   gboolean (*is_child_selected) (AtkSelection *selection,
0060                                  gint i);
0061   gboolean (*remove_selection) (AtkSelection *selection,
0062                                 gint i);
0063   gboolean (*select_all_selection) (AtkSelection *selection);
0064
0065   /* signal handlers */
0066
0067   void (*selection_changed) (AtkSelection *selection);
0068 };
0069
0070 ATK_AVAILABLE_IN_ALL
0071 GType atk_selection_get_type (void);
0072
0073 ATK_AVAILABLE_IN_ALL
0074 gboolean atk_selection_add_selection (AtkSelection *selection,
0075                                       gint i);
0076
0077 ATK_AVAILABLE_IN_ALL
0078 gboolean atk_selection_clear_selection (AtkSelection *selection);
0079
0080 ATK_AVAILABLE_IN_ALL
0081 AtkObject *atk_selection_ref_selection (AtkSelection *selection,
0082                                         gint i);
0083
0084 ATK_AVAILABLE_IN_ALL
0085 gint atk_selection_get_selection_count (AtkSelection *selection);
0086
0087 ATK_AVAILABLE_IN_ALL
0088 gboolean atk_selection_is_child_selected (AtkSelection *selection,
0089                                           gint i);
0090
0091 ATK_AVAILABLE_IN_ALL
0092 gboolean atk_selection_remove_selection (AtkSelection *selection,
0093                                          gint i);
0094
0095 ATK_AVAILABLE_IN_ALL
0096 gboolean atk_selection_select_all_selection (AtkSelection *selection);
0097
0098 G_END_DECLS
0099
0100 #endif /* __ATK_SELECTION_H__ */