AtkState

["Padraig O'Briain" <Padraig Obriain Sun COM>]

> 
>  * I think the way AtkState currently works with the extensible
>    enum and:
> 
>    typedef guint64 AtkStateMask
>    #define ATK_STATE(state_enum)   ((AtkStateMask)(1 << 
((guint64)(state_enum)%64)))
> 
>    Is going to cause fits for language bindings. It probably
>    would be better to simply have functions to get/set a
>    list/array of AtkState for the AtkObject.
> 

I propose to change 

AtkState                atk_object_get_state                      (AtkObject *ac
cessible);

to

AtkStateSet             atk_object_get_state_set                  (AtkObject *ac
cessible);

and define the AtkStateSet interface as in the attached file.

Hopefully, this interface will work for language bindings.

Padraig

/* ATK -  Accessibility Toolkit
 * Copyright 2001 Sun Microsystems Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __ATK_STATE_SET_H__
#define __ATK_STATE_SET_H__

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <glib-object.h>
#include <atk/atkobject.h>

#define ATK_TYPE_STATE_SET                        (atk_state_set_get_type ())
#define ATK_STATE_SET(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_STATE_SET, AtkStateSet))
#define ATK_STATE_SET_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_STATE_SET, AtkStateSetClass))
#define ATK_IS_STATE_SET(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_STATE_SET))
#define ATK_IS_STATE_SET_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_STATE_SET))
#define ATK_STATE_SET_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_STATE_SET, AtkStateSetClass))

typedef struct _AtkStateSetClass       AtkStateSetClass;


struct _AtkStateSet
{
  GObject parent;

};

struct _AtkStateSetClass
{
  GObjectClass parent;
};

GType atk_state_set_get_type (void);

/*
 * Create an empty state set.
 */
AtkStateSet*    atk_state_set_new               (void);
/*
 * Checks whether a state set is empty.
 */
gboolean        atk_state_set_is_empty          (AtkStateSet  *set);
/*
 *  Add a new state for the specified type to the current state set if 
 *  it is not already present
 * 
 */
gboolean        atk_state_set_add_state         (AtkStateSet  *set,
                                                 AtkStateType type);
/*
 *  Add all the states for all the specified types to the current state set
 * 
 */
void            atk_state_set_add_states        (AtkStateSet  *set,
                                                 AtkStateType *types,
                                                 gint         n_types);
/*
 * Remove all states from the state set.
 */
void            atk_state_set_clear_states      (AtkStateSet  *set);
/*
 * Checks whether the state for the specified type is in the specified set.
 */
void            atk_state_set_contains_state    (AtkStateSet  *set,
                                                 AtkStateType type);
/*
 *  Removes a state for the specified type the current state set.
 * 
 */
gboolean        atk_state_set_remove_state      (AtkStateSet  *set,
                                                 AtkStateType type);
/*
 * Constructs the intersection of two state sets, returning NULL if the
 * intersection is empty.
 */
AtkStateSet*    atk_state_set_and_sets          (AtkStateSet  *set,
                                                 AtkStateSet  *compare_set);
/*
 * Constructs the union of two state sets.
 */
AtkStateSet*    atk_state_set_or_sets           (AtkStateSet  *set,
                                                 AtkStateSet  *compare_set);

/*
 * Constructs the xor of two sets, returning NULL if it empty.
 * The sets returned by this operation contains the state in exactly one
 * of the sets.
 */ 
AtkStateSet*    atk_state_set_xor_sets          (AtkStateSet  *set,
                                                 AtkStateSet  *compare_set);
/*
 * Determines whether states for all the specified types are in the state set.
 */
gboolean        atk_state_set_contains_states   (AtkStateSet  *set,
                                                 AtkStateType *types,
                                                 gint         n_types);
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __ATK_STATE_SET_H__ */