summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Cameron <bcameron@src.gnome.org>2001-05-28 15:35:18 +0000
committerBrian Cameron <bcameron@src.gnome.org>2001-05-28 15:35:18 +0000
commit0eb2df058c94d10592f66a344552d75e3b3b2417 (patch)
tree24bafa0e148194ba5af4184b59edee3f6d8c5c90
parent78d10a74dc40bbb8addb4fe43f8303189835f355 (diff)
downloadatk-0eb2df058c94d10592f66a344552d75e3b3b2417.tar.gz
Updated the atk docs for several files, particularly for enumerations.
-rw-r--r--ChangeLog1
-rwxr-xr-xatk/atkaction.h14
-rwxr-xr-xatk/atkcomponent.h43
-rwxr-xr-xatk/atkhypertext.h11
-rwxr-xr-xatk/atkimage.h26
-rwxr-xr-xatk/atkobject.h211
-rwxr-xr-xatk/atkrelation.h14
-rwxr-xr-xatk/atkselection.h26
-rwxr-xr-xatk/atkstate.h85
-rwxr-xr-xatk/atktable.h72
-rwxr-xr-xatk/atktext.h13
-rwxr-xr-xatk/atkvalue.h12
12 files changed, 145 insertions, 383 deletions
diff --git a/ChangeLog b/ChangeLog
index 2468ace..0b2b736 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -3,6 +3,7 @@
* atk/atktext.c
Now properly set the initialized flag when setting up signals.
+ Updated the atk-docs in several files
2001-05-24 Padraig O'Briain <padraig.obriain@sun.com>
diff --git a/atk/atkaction.h b/atk/atkaction.h
index 3651c4c..d14b736 100755
--- a/atk/atkaction.h
+++ b/atk/atkaction.h
@@ -50,25 +50,11 @@ struct _AtkActionIface
{
GTypeInterface parent;
- /*
- * Perform the specified action on the object
- */
gboolean (*do_action) (AtkAction *action,
gint i);
- /*
- * Returns the number of accessible actions available on the object.
- * If there are more than one, the first one is considered the
- * "default" action of the object.
- */
gint (*get_n_actions) (AtkAction *action);
- /*
- * Returns a description of the specified action of the object
- */
G_CONST_RETURN gchar* (*get_description) (AtkAction *action,
gint i);
- /*
- * Returns a keybinding associated with this action, if one exists.
- */
G_CONST_RETURN gchar* (*get_keybinding) (AtkAction *action,
gint i);
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h
index 5e1b63f..4baa734 100755
--- a/atk/atkcomponent.h
+++ b/atk/atkcomponent.h
@@ -51,83 +51,40 @@ struct _AtkComponentIface
{
GTypeInterface parent;
- /*
- * Add the specified handler to the set of functions to be called
- * when this object receives focus (in or out) events.
- */
guint (* add_focus_handler) (AtkComponent *component,
AtkFocusHandler handler);
- /*
- * Checks whether the specified point is within the extent of the object,
- * the points x and y coordinates are defined to be relative to the
- * coordinate system of the object.
- */
gboolean (* contains) (AtkComponent *component,
gint x,
gint y);
- /*
- * Gets the accessible child, if one exists, contained at the local
- * coordinate point specified by x and y.
- */
AtkObject* (* get_accessible_at_point) (AtkComponent *component,
gint x,
gint y);
- /*
- * Gets the rectangle which gives the extent of the object.
- */
void (* get_extents) (AtkComponent *component,
gint *x,
gint *y,
gint *width,
gint *height);
- /*
- * Gets the position of the object relative to the parent in the form of
- * a point specifying the object's top-left corner in the screen's
- * coordinate space.
- */
void (* get_position) (AtkComponent *component,
gint *x,
gint *y);
- /*
- * Returns the position of the object on the screen
- */
void (* get_position_on_screen) (AtkComponent *component,
gint *root_x,
gint *root_y);
- /*
- * Returns the size of the object
- */
void (* get_size) (AtkComponent *component,
gint *width,
gint *height);
- /*
- * Grabs focus for this object
- */
void (* grab_focus) (AtkComponent *component);
- /*
- * Remove the handler specified by the handler_id from the list of
- * functions to be executed when this object receives focus (in or out)
- */
void (* remove_focus_handler) (AtkComponent *component,
guint handler_id);
- /*
- * Sets the extents of the object
- */
void (* set_extents) (AtkComponent *component,
gint x,
gint y,
gint width,
gint height);
- /*
- * Set the position of the object
- */
void (* set_position) (AtkComponent *component,
gint x,
gint y);
- /*
- * Set the size of the object
- */
void (* set_size) (AtkComponent *component,
gint width,
gint height);
diff --git a/atk/atkhypertext.h b/atk/atkhypertext.h
index 1c7d7c7..0b80264 100755
--- a/atk/atkhypertext.h
+++ b/atk/atkhypertext.h
@@ -53,20 +53,9 @@ struct _AtkHypertextIface
{
GTypeInterface parent;
- /*
- * Returns the nth link of this hypertext document
- */
AtkHyperLink*(* get_link) (AtkHypertext *hypertext,
gint link_index);
- /*
- * Returns the number of links within this hypertext document.
- */
gint (* get_n_links) (AtkHypertext *hypertext);
- /*
- * Returns the index into the array of hyperlinks that is associated
- * this character index, or -1 if there is no hyperlink associated with
- * this index.
- */
gint (* get_link_index) (AtkHypertext *hypertext,
gint char_index);
diff --git a/atk/atkimage.h b/atk/atkimage.h
index caa959e..d3fc0d2 100755
--- a/atk/atkimage.h
+++ b/atk/atkimage.h
@@ -43,6 +43,17 @@ typedef struct _AtkImage AtkImage;
#endif
typedef struct _AtkImageIface AtkImageIface;
+/**
+ *AtkImageType:
+ *@ATK_IMAGE_EMPTY:
+ *@ATK_IMAGE_PIXMAP:
+ *@ATK_IMAGE_IMAGE:
+ *@ATK_IMAGE_PIXBUF:
+ *@ATK_IMAGE_STOCK:
+ *@ATK_IMAGE_ICON_SET:
+ *
+ *The representation being used to store the image data
+ **/
typedef enum
{
ATK_IMAGE_EMPTY,
@@ -57,25 +68,10 @@ struct _AtkImageIface
{
GTypeInterface parent;
- /*
- * Gets the type of representation being used to store image data
- */
AtkImageType (*get_storage_type) (AtkImage *image);
- /*
- * Gets the description of the image
- */
G_CONST_RETURN gchar* ( *get_image_description) (AtkImage *image);
- /*
- * Gets the height of the image
- */
gint ( *get_image_height) (AtkImage *image);
- /*
- * Gets the width of the image
- */
gint ( *get_image_width) (AtkImage *image);
- /*
- * Sets the description of the image
- */
gboolean ( *set_image_description) (AtkImage *image,
const gchar *description);
diff --git a/atk/atkobject.h b/atk/atkobject.h
index 76b5f5f..5ed83ea 100755
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -35,211 +35,148 @@ extern "C" {
* of the following interfaces:
*/
+/**
+ *AtkRole:
+ *@ATK_ROLE_INVALID: Invalid role
+ *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
+ *@ATK_ROLE_ALERT: An object which is an alert to the user
+ *@ATK_ROLE_ANIMATION: An object which is an animated image
+ *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
+ *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
+ *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
+ *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
+ *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
+ *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
+ *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
+ *@ATK_ROLE_COMBO_BOX: A list of choices the user can select from
+ *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
+ *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
+ *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
+ *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
+ *@ATK_ROLE_DIALOG: A top level window with title bar and a border
+ *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
+ *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
+ *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
+ *@ATK_ROLE_FILLER: A object that fills up space in a user interface
+ *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
+ *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
+ *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
+ *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
+ *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
+ *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
+ *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
+ *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
+ *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
+ *@ATK_ROLE_LIST: An object that presents a list of objects to the user and allows the user to select one or more of them
+ *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
+ *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
+ *@ATK_ROLE_MENU_BAR: An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from
+ *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
+ *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
+ *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
+ *@ATK_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object
+ *@ATK_ROLE_PANEL: A generic container that is often used to group objects
+ *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
+ *@ATK_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
+ *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
+ *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
+ *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked
+ *@ATK_ROLE_RADIO_MENU_ITEM: A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
+ *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
+ *@ATK_ROLE_ROW_HEADER: The header for a row of data
+ *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
+ *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
+ *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
+ *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
+ *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
+ *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
+ *@ATK_ROLE_STATUS_BAR: An object which reports messages of minor importance to the user
+ *@ATK_ROLE_TABLE: An object used to rpesent information in terms of rows and columns
+ *@ATK_ROLE_TABLE_CELL: A cell in a table
+ *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
+ *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
+ *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
+ *@ATK_ROLE_TEXT: An object that presents text to the user
+ *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state
+ *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
+ *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
+ *@ATK_ROLE_TREE: An object used to repsent hierarchical information to the user
+ *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
+ *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
+ *@ATK_ROLE_WINDOW: A top level window with no title or border
+ *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of enumeration
+ *
+ *Describes the role of an object
+ **/
typedef enum
{
ATK_ROLE_INVALID,
- /* A label which represents an accelerator */
ATK_ROLE_ACCEL_LABEL,
- /* An object is used to alert the user about something */
ATK_ROLE_ALERT,
- /* An object which is an animated image */
ATK_ROLE_ANIMATION,
- /* An arrow in one of the four cardinal directoions */
ATK_ROLE_ARROW,
- /* An object that displays a calendar and allows the user to select a date */
ATK_ROLE_CALENDAR,
- /* An object that can be drawn into and is used to trap events */
ATK_ROLE_CANVAS,
- /*
- * A choice that can be checked or unchecked and provides a separate
- * indicator for the current state.
- */
ATK_ROLE_CHECK_BOX,
- /* A menu item with a check box */
ATK_ROLE_CHECK_MENU_ITEM,
- /* A specialized dialog that lets the user choose a color. */
ATK_ROLE_COLOR_CHOOSER,
- /* The header for a column of data */
ATK_ROLE_COLUMN_HEADER,
- /* A list of choices the user can select from */
ATK_ROLE_COMBO_BOX,
- /* An object whose purpose is to allow a user to edit a date */
ATK_ROLE_DATE_EDITOR,
- /* An inconifed internal frame within a DESKTOP_PANE */
ATK_ROLE_DESKTOP_ICON,
- /*
- * A pane that supports internal frames and iconified versions of those
- * internal frames.
- */
ATK_ROLE_DESKTOP_FRAME,
- /* An object whose purpose is to allow a user to set a value */
ATK_ROLE_DIAL,
- /* A top level window with title bar and a border */
ATK_ROLE_DIALOG,
- /*
- * A pane that allows the user to navigate through and select the contents
- * of a directory
- */
ATK_ROLE_DIRECTORY_PANE,
- /*
- * A specialized dialog that displays the files in the directory and lets
- * the user select a file, browse a different directory, or specify a
- * filename.
- */
- /* An object used for drawing custom user interface elements */
ATK_ROLE_DRAWING_AREA,
- /* A specialized dialog that lets the user choose a file. */
ATK_ROLE_FILE_CHOOSER,
- /* A object that fills up space in a user interface */
ATK_ROLE_FILLER,
- /* A specialized dialog that lets the user choose a font. */
ATK_ROLE_FONT_CHOOSER,
- /* A top level window with a title bar, border, menubar, etc. */
ATK_ROLE_FRAME,
- /* A pane that is guaranteed to be painted on top of all panes beneath it */
ATK_ROLE_GLASS_PANE,
- /*
- * A document container for HTML, whose children
- * represent the document content.
- */
ATK_ROLE_HTML_CONTAINER,
- /* A small fixed size picture, typically used to decorate components */
ATK_ROLE_ICON,
- /* An object whose primary purpose is to display an image */
ATK_ROLE_IMAGE,
- /* A frame-like object that is clipped by a desktop pane. */
ATK_ROLE_INTERNAL_FRAME,
- /* An object used to present an icon or short string in an interface */
ATK_ROLE_LABEL,
- /*
- * A specialized pane that allows its children to be drawn in layers,
- * providing a form of stacking order.
- */
ATK_ROLE_LAYERED_PANE,
- /*
- * An object that presents a list of objects to the user and allows the
- * user to select one or more of them.
- */
ATK_ROLE_LIST,
- /* An object that represents an element of a list. */
ATK_ROLE_LIST_ITEM,
- /*
- * An object usually found inside a menu bar that contains a list of
- * actions the user can choose from.
- */
ATK_ROLE_MENU,
- /*
- * An object usually drawn at the top of the primary dialog box of an
- * application that contains a list of menus the user can choose from.
- */
ATK_ROLE_MENU_BAR,
- /*
- * An object usually contained in a menu that presents an action the
- * user can choose.
- */
ATK_ROLE_MENU_ITEM,
- /* A specialized pane whose primary use is inside a DIALOG */
ATK_ROLE_OPTION_PANE,
- /* An object that is a child of a page tab list */
ATK_ROLE_PAGE_TAB,
- /*
- * An object that presents a series of panels (or page tabs), one at a time,
- * through some mechanism provided by the object.
- */
ATK_ROLE_PAGE_TAB_LIST,
- /* A generic container that is often used to group objects. */
ATK_ROLE_PANEL,
- /*
- * A text object uses for passwords, or other places where the text
- * content is not shown visibly to the user.
- */
ATK_ROLE_PASSWORD_TEXT,
- /*
- * A temporary window that is usually used to offer the user a list of
- * choices, and then hides when the user selects one of those choices.
- */
ATK_ROLE_POPUP_MENU,
- /* An object used to indicate how much of a task has been completed. */
ATK_ROLE_PROGRESS_BAR,
- /*
- * An object the user can manipulate to tell the application to do
- * something.
- */
ATK_ROLE_PUSH_BUTTON,
- /*
- * A specialized check box that will cause other radio buttons in the
- * same group to become uncghecked when this one is checked.
- */
ATK_ROLE_RADIO_BUTTON,
- /*
- * A check menu item which belongs to a group. At each instant exactly
- * one of the radio menu items from a group is selected
- */
ATK_ROLE_RADIO_MENU_ITEM,
- /*
- * A specialized pane that has a glass pane and a layered pane as its
- * children.
- */
ATK_ROLE_ROOT_PANE,
- /* The header for a row of data */
ATK_ROLE_ROW_HEADER,
- /*
- * An object usually used to allow a user to incrementally view a large
- * amount of data.
- */
ATK_ROLE_SCROLL_BAR,
- /*
- * An object that allows a user to incrementally view a large amount
- * of information.
- */
ATK_ROLE_SCROLL_PANE,
- /*
- * An object usually contained in a menu to provide a visible and
- * logical separation of the contents in a menu.
- */
ATK_ROLE_SEPARATOR,
- /* An object that allows the user to select from a bounded range */
ATK_ROLE_SLIDER,
- /* A specialized panel that presents two other panels at the same time. */
ATK_ROLE_SPLIT_PANE,
- /* An object used to get an integer or floating point number from the user */
ATK_ROLE_SPIN_BUTTON,
- /* An object which reports messages of minor importance to the user */
- ATK_ROLE_STATUSBAR,
- /* An object used to represent information in terms of rows and columns. */
+ ATK_ROLE_STATUS_BAR,
ATK_ROLE_TABLE,
ATK_ROLE_TABLE_CELL,
ATK_ROLE_TABLE_COLUMN_HEADER,
ATK_ROLE_TABLE_ROW_HEADER,
- /* A menu item used to tear off and reattach its menu */
ATK_ROLE_TEAR_OFF_MENU_ITEM,
- /* An object that presents text to the user */
ATK_ROLE_TEXT,
- /*
- * A specialized push button that can be checked or unchecked, but does
- * not procide a separate indicator for the current state.
- */
ATK_ROLE_TOGGLE_BUTTON,
- /*
- * A bar or palette usually composed of push buttons or toggle buttons
- */
ATK_ROLE_TOOL_BAR,
- /*
- * An object that provides information about another object
- */
ATK_ROLE_TOOL_TIP,
- /* An object used to repsent hierarchical information to the user. */
ATK_ROLE_TREE,
- /*
- * The object contains some Accessible information, but its role is
- * not known.
- */
ATK_ROLE_UNKNOWN,
- /* An object usually used in a scroll pane. */
ATK_ROLE_VIEWPORT,
- /* A top level window with no title or border */
ATK_ROLE_WINDOW,
- /* not a valid role, used for finding end of enumeration. */
ATK_ROLE_LAST_DEFINED
} AtkRole;
diff --git a/atk/atkrelation.h b/atk/atkrelation.h
index ef24c44..0d7f473 100755
--- a/atk/atkrelation.h
+++ b/atk/atkrelation.h
@@ -25,11 +25,21 @@ extern "C" {
#endif /* __cplusplus */
#include <glib-object.h>
-
+/**
+ *AtkRelationType:
+ *@ATK_RELATION_NULL:
+ *@ATK_RELATION_CONTROLLED_BY:
+ *@ATK_RELATION_CONTROLLER_FOR:
+ *@ATK_RELATION_LABEL_FOR:
+ *@ATK_RELATION_LABELLED_BY:
+ *@ATK_RELATION_MEMBER_OF:
+ *@ATK_RELATION_LAST_DEFINED:
+ *
+ *The possible types of an #AtkRelation
+ **/
typedef enum
{
ATK_RELATION_NULL = 0,
-
ATK_RELATION_CONTROLLED_BY,
ATK_RELATION_CONTROLLER_FOR,
ATK_RELATION_LABEL_FOR,
diff --git a/atk/atkselection.h b/atk/atkselection.h
index d4bf73f..e210576 100755
--- a/atk/atkselection.h
+++ b/atk/atkselection.h
@@ -48,43 +48,17 @@ struct _AtkSelectionIface
{
GTypeInterface parent;
- /*
- * Adds the specified accessible child of the object to the
- * object's selection.
- */
void (* add_selection) (AtkSelection *selection,
gint i);
- /*
- * Clears the selection in the object so that no children in the object
- * are selected.
- */
void (* clear_selection) (AtkSelection *selection);
- /*
- * Returns a reference to the accessible object representing the specified
- * selected * child of the object.
- */
AtkObject* (* ref_selection) (AtkSelection *selection,
gint i);
- /*
- * Returns the number of accessible children currently selected.
- */
gint (* get_selection_count) (AtkSelection *selection);
- /*
- * Determines if the current child of this object is selected
- */
gboolean (* is_child_selected) (AtkSelection *selection,
gint i);
- /*
- * Removes the specified child of the object from the object's selection.
- */
void (* remove_selection) (AtkSelection *selection,
gint i);
- /*
- * Causes every child of the object to be selected if the object
- * supports multiple selections.
- */
void (* select_all_selection) (AtkSelection *selection);
-
};
GType atk_selection_get_type ();
diff --git a/atk/atkstate.h b/atk/atkstate.h
index 7f98b32..8f66012 100755
--- a/atk/atkstate.h
+++ b/atk/atkstate.h
@@ -26,86 +26,69 @@ extern "C" {
#include <glib-object.h>
+/**
+ *AtkStateType:
+ *@ATK_STATE_INVALID: Indicates an invalid state
+ *@ATK_STATE_ACTIVE: Indicates a window is currently the active window
+ *@ATK_STATE_ARMED: Indicates that the object is armed
+ *@ATK_STATE_BUSY: Indicates the current object is busy
+ *@ATK_STATE_CHECKED: Indicates this object is currently checked
+ *@ATK_STATE_COLLAPSED: Indicates this object is collapsed
+ *@ATK_STATE_DEFUNCT: Indicates the user interface object corresponding to this object no longer exists
+ *@ATK_STATE_EDITABLE: Indicates the user can change the contents of this object
+ *@ATK_STATE_EXPANDABLE: Indicates this object allows progressive disclosure of its children
+ *@ATK_STATE_EXPANDED: Indicates this object its expanded
+ *@ATK_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
+ *@ATK_STATE_FOCUSED: Indicates this object currently has the keyboard focus
+ *@ATK_STATE_HORIZONTAL: Indicates the orientation of this object is horizontal
+ *@ATK_STATE_ICONIFIED: Indicates this object is minimized and is represented only by an icon
+ *@ATK_STATE_MODAL: Indicates something must be done with this object before the user can interact with an object in a different window
+ *@ATK_STATE_MULTI_LINE: Indicates this (text) object can contain multiple lines of text
+ *@ATK_STATE_MULTISELECTABLE: Indicates this object allows more than one of its children to be selected at the same time
+ *@ATK_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region
+ *@ATK_STATE_PRESSED: Indicates this object is currently pressed
+ *@ATK_STATE_RESIZABLE: Indicates the size of this object is not fixed
+ *@ATK_STATE_SELECTABLE: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
+ *@ATK_STATE_SELECTED: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
+ *@ATK_STATE_SENSITIVE: Indicates this object is sensitive
+ *@ATK_STATE_SHOWING: Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
+ *@ATK_STATE_SINGLE_LINE: Indicates this (text) object can contain only a single line of text
+ *@ATK_STATE_TRANSIENT: Indicates this object is transient
+ *@ATK_STATE_VERTICAL: Indicates the orientation of this object is vertical
+ *@ATK_STATE_VISIBLE: Indicates this object is visible
+ *@ATK_STATE_LAST_DEFINED: Not a valid role, used for finding end of enumeration
+ *
+ *The possible types of states of an object
+ **/
typedef enum
{
ATK_STATE_INVALID,
- /* Indicates a window is currently the active window */
ATK_STATE_ACTIVE,
- /* Indicates that the object is armed */
ATK_STATE_ARMED,
- /* Indicates the current object is busy */
ATK_STATE_BUSY,
- /* Indicates this object is currently checked */
ATK_STATE_CHECKED,
- /* Indicates this object is collapsed */
ATK_STATE_COLLAPSED,
- /*
- * Indicates the user interface object corresponding to this object
- * no longer exists.
- */
ATK_STATE_DEFUNCT,
- /* Indicates the user can change the contents of this object */
ATK_STATE_EDITABLE,
- /* Indicates this object allows progressive disclosure of its children */
ATK_STATE_EXPANDABLE,
- /* Indicates this object its expanded */
ATK_STATE_EXPANDED,
- /*
- * Indicates this object can accept keyboard focus, which means all
- * events resulting from typing on the keyboard will normally be passed
- * to it when it has focus
- */
ATK_STATE_FOCUSABLE,
- /* Indicates this object currently has the keyboard focus */
ATK_STATE_FOCUSED,
- /* Indicates the orientation of this object is horizontal */
ATK_STATE_HORIZONTAL,
- /* Indicates this object is minimized and is represented only by an icon */
ATK_STATE_ICONIFIED,
- /*
- * Indicates something must be done with this object before the user can
- * interact with an object in a different window.
- */
ATK_STATE_MODAL,
- /* Indicates this (text) object can contain multiple lines of text */
ATK_STATE_MULTI_LINE,
- /*
- * Indicates this object allows more than one of its children to be
- * selected at the same time
- */
ATK_STATE_MULTISELECTABLE,
- /* Indicates this object paints every pixel within its rectangular region. */
ATK_STATE_OPAQUE,
- /* Indicates this object is currently pressed */
ATK_STATE_PRESSED,
- /* Indicates the size of this object is not fixed */
ATK_STATE_RESIZABLE,
- /*
- * Indicates this object is the child of an object that allows its
- * children to be selected and that this child is one of those children
- * that can be selected.
- */
ATK_STATE_SELECTABLE,
- /*
- * Indicates this object is the child of an object that allows its
- * children to be selected and that this child is one of those children
- * that has been selected.
- */
ATK_STATE_SELECTED,
- /* Indicates this object is sensitive */
ATK_STATE_SENSITIVE,
- /*
- * Indicates this object, the object's parent, the object's parent's
- * parent, and so on, are all visible
- */
ATK_STATE_SHOWING,
- /* Indicates this (text) object can contain only a single line of text */
ATK_STATE_SINGLE_LINE,
- /* Indicates this object is transient */
ATK_STATE_TRANSIENT,
- /* Indicates the orientation of this object is vertical */
ATK_STATE_VERTICAL,
- /* Indicates this object is visible */
ATK_STATE_VISIBLE,
ATK_STATE_LAST_DEFINED
} AtkStateType;
diff --git a/atk/atktable.h b/atk/atktable.h
index d229dc3..b4d86a5 100755
--- a/atk/atktable.h
+++ b/atk/atktable.h
@@ -47,10 +47,6 @@ struct _AtkTableIface
{
GTypeInterface parent;
- /*
- * Returns a reference to the accessible object at a specified row
- * and column in the table.
- */
AtkObject* (* ref_at) (AtkTable *table,
gint row,
gint column);
@@ -61,113 +57,45 @@ struct _AtkTableIface
gint index);
gint (* get_column_at_index) (AtkTable *table,
gint index);
- /*
- * Returns the caption for the table.
- */
AtkObject* (* get_caption) (AtkTable *table);
- /*
- * Returns the number of columns in the table.
- */
gint (* get_n_columns) (AtkTable *table);
- /*
- * Returns the description text of the specified column in the table
- */
AtkObject* (* get_column_description) (AtkTable *table,
gint column);
- /*
- * Returns the number of columns occupied by the accessible object
- * at a specified row and column in the table.
- */
gint (* get_column_extent_at) (AtkTable *table,
gint row,
gint column);
- /*
- * Returns the column headers of an accessible table.
- */
AtkTable* (* get_column_header) (AtkTable *table);
- /*
- * Returns the number of rows in the table.
- */
gint (* get_n_rows) (AtkTable *table);
- /*
- * Returns the description text of the specified row in the table
- */
AtkObject* (* get_row_description) (AtkTable *table,
gint row);
- /*
- * Returns the number of rows occupied by the accessible object
- * at a specified row and column in the table.
- */
gint (* get_row_extent_at) (AtkTable *table,
gint row,
gint column);
- /*
- * Returns the row headers of an accessible table.
- */
AtkTable* (* get_row_header) (AtkTable *table);
- /*
- * Returns the summary description of the table.
- */
AtkObject* (* get_summary) (AtkTable *table);
- /*
- * Returns the selected columns of the table.
- */
gint* (* get_selected_columns) (AtkTable *table);
- /*
- * Returns the selected rows of the table.
- */
gint* (* get_selected_rows) (AtkTable *table);
- /*
- * Returns a boolean value indicating whether the specified column
- * is selected
- */
gboolean (* is_column_selected) (AtkTable *table,
gint column);
- /*
- * Returns a boolean value indicating whether the specified row
- * is selected
- */
gboolean (* is_row_selected) (AtkTable *table,
gint row);
- /*
- * Returns a boolean value indicating whether the acessible object
- * at the specified row and column is selected
- */
gboolean (* is_selected) (AtkTable *table,
gint row,
gint column);
- /*
- * Sets the caption for the table.
- */
void (* set_caption) (AtkTable *table,
AtkObject *accessible);
- /*
- * Sets the description text for the specified column of the table.
- */
void (* set_column_description) (AtkTable *table,
gint column,
AtkObject *accessible);
- /*
- * Sets the column headers
- */
void (* set_column_header) (AtkTable *table,
gint column,
AtkTable *header);
- /*
- * Sets the description text for the specified row of the table.
- */
void (* set_row_description) (AtkTable *table,
gint row,
AtkObject *accessible);
- /*
- * Sets the row headers
- */
void (* set_row_header) (AtkTable *table,
gint row,
AtkTable *header);
- /*
- * Sets the summary description of the table
- */
void (* set_summary) (AtkTable *table,
AtkObject *accessible);
};
diff --git a/atk/atktext.h b/atk/atktext.h
index 92be3a3..edd3801 100755
--- a/atk/atktext.h
+++ b/atk/atktext.h
@@ -40,6 +40,19 @@ typedef struct _AtkText AtkText;
#endif
typedef struct _AtkTextIface AtkTextIface;
+/**
+ *AtkTextBoundary:
+ *@ATK_TEXT_BOUNDARY_CHAR:
+ *@ATK_TEXT_BOUNDARY_CURSOR_POS:
+ *@ATK_TEXT_BOUNDARY_WORD_START:
+ *@ATK_TEXT_BOUNDARY_WORD_END:
+ *@ATK_TEXT_BOUNDARY_SENTENCE_START:
+ *@ATK_TEXT_BOUNDARY_SENTENCE_END:
+ *@ATK_TEXT_BOUNDARY_LINE_START:
+ *@ATK_TEXT_BOUNDARY_LINE_END:
+ *
+ *Text boundary types used for specifying boundaries for regions of text
+ **/
typedef enum {
ATK_TEXT_BOUNDARY_CHAR,
ATK_TEXT_BOUNDARY_CURSOR_POS,
diff --git a/atk/atkvalue.h b/atk/atkvalue.h
index ba77973..42f9a28 100755
--- a/atk/atkvalue.h
+++ b/atk/atkvalue.h
@@ -49,24 +49,12 @@ struct _AtkValueIface
{
GTypeInterface parent;
- /*
- * Gets the value of this object
- */
void (* get_current_value) (AtkValue *obj,
GValue *value);
- /*
- * Gets the maximum value of this object
- */
void (* get_maximum_value) (AtkValue *obj,
GValue *value);
- /*
- * Gets the minimum value of this object
- */
void (* get_minimum_value) (AtkValue *obj,
GValue *value);
- /*
- * Sets the value of this object
- */
gboolean (* set_current_value) (AtkValue *obj,
GValue *value);