michael@0: /* ATK -  Accessibility Toolkit
michael@0:  * Copyright 2001 Sun Microsystems Inc.
michael@0:  *
michael@0:  * This library is free software; you can redistribute it and/or
michael@0:  * modify it under the terms of the GNU Library General Public
michael@0:  * License as published by the Free Software Foundation; either
michael@0:  * version 2 of the License, or (at your option) any later version.
michael@0:  *
michael@0:  * This library is distributed in the hope that it will be useful,
michael@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
michael@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
michael@0:  * Library General Public License for more details.
michael@0:  *
michael@0:  * You should have received a copy of the GNU Library General Public
michael@0:  * License along with this library; if not, write to the
michael@0:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
michael@0:  * Boston, MA 02111-1307, USA.
michael@0:  */
michael@0: 
michael@0: #ifndef __ATK_SELECTION_H__
michael@0: #define __ATK_SELECTION_H__
michael@0: 
michael@0: #include <atk/atkobject.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: /*
michael@0:  * This AtkSelection interface provides the standard mechanism for an 
michael@0:  * assistive technology to determine what the current selected children are, 
michael@0:  * as well as modify the selection set. Any object that has children that 
michael@0:  * can be selected should support the AtkSelection interface.
michael@0:  */
michael@0: 
michael@0: #define ATK_TYPE_SELECTION                        (atk_selection_get_type ())
michael@0: #define ATK_IS_SELECTION(obj)                     G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_SELECTION)
michael@0: #define ATK_SELECTION(obj)                        G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_SELECTION, AtkSelection)
michael@0: #define ATK_SELECTION_GET_IFACE(obj)              (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_SELECTION, AtkSelectionIface))
michael@0: 
michael@0: #ifndef _TYPEDEF_ATK_SELECTION_
michael@0: #define _TYPEDEF_ATK_SELECTION_
michael@0: typedef struct _AtkSelection AtkSelection;
michael@0: #endif
michael@0: typedef struct _AtkSelectionIface AtkSelectionIface;
michael@0: 
michael@0: struct _AtkSelectionIface
michael@0: {
michael@0:   GTypeInterface parent;
michael@0: 
michael@0:   gboolean     (* add_selection)        (AtkSelection   *selection,
michael@0:                                          gint           i);
michael@0:   gboolean     (* clear_selection)      (AtkSelection   *selection);
michael@0:   AtkObject*   (* ref_selection)        (AtkSelection   *selection,
michael@0:                                          gint           i);
michael@0:   gint         (* get_selection_count)  (AtkSelection   *selection);
michael@0:   gboolean     (* is_child_selected)    (AtkSelection   *selection,
michael@0:                                          gint           i);
michael@0:   gboolean     (* remove_selection)     (AtkSelection   *selection,
michael@0:                                          gint           i);
michael@0:   gboolean     (* select_all_selection) (AtkSelection   *selection);
michael@0: 
michael@0:   /* signal handlers */
michael@0:   
michael@0:   void         (*selection_changed)     (AtkSelection   *selection);
michael@0: 
michael@0:   AtkFunction  pad1;
michael@0:   AtkFunction  pad2;
michael@0: };
michael@0: 
michael@0: GType atk_selection_get_type (void);
michael@0: 
michael@0: gboolean     atk_selection_add_selection        (AtkSelection   *selection,
michael@0:                                                  gint           i);
michael@0: 
michael@0: gboolean     atk_selection_clear_selection      (AtkSelection   *selection);
michael@0: 
michael@0: AtkObject*   atk_selection_ref_selection        (AtkSelection   *selection,
michael@0:                                                  gint           i);
michael@0: 
michael@0: gint         atk_selection_get_selection_count  (AtkSelection   *selection);
michael@0: 
michael@0: gboolean     atk_selection_is_child_selected    (AtkSelection   *selection,
michael@0:                                                  gint           i);
michael@0: 
michael@0: gboolean     atk_selection_remove_selection     (AtkSelection   *selection,
michael@0:                                                  gint           i);
michael@0: 
michael@0: gboolean     atk_selection_select_all_selection (AtkSelection   *selection);
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: 
michael@0: #endif /* __ATK_SELECTION_H__ */