.\" This is a wxWidgets manpage page generated from the XML docs .TH wxAccessible 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxAccessible \- .SH DESCRIPTION The wxAccessible class allows wxWidgets applications, and wxWidgets itself, to return extended information about user interface elements to client applications such as screen readers. This is the main way in which wxWidgets implements accessibility features. At present, only Microsoft Active Accessibility is supported by this class. To use this class, derive from wxAccessible, implement appropriate functions, and associate an object of the class with a window using wxWindow::SetAccessible . All functions return an indication of success, failure, or not implemented using values of the wxAccStatus enum type. If you return wxACC_NOT_IMPLEMENTED from any function, the system will try to implement the appropriate functionality. However this will not work with all functions. Most functions work with an object id , which can be zero to refer to 'this' UI element, or greater than zero to refer to the nth child element. This allows you to specify elements that don't have a corresponding wxWindow or wxAccessible; for example, the sash of a splitter window. For details on the semantics of functions and types, please refer to the Microsoft Active Accessibility 1.2 documentation. This class is compiled into wxWidgets only if the wxUSE_ACCESSIBILITY setup symbol is set to 1. .SH "PARENTS" wxObject .SH "INCLUDE FILES" wx/access.h .SH MEMBERS .SS wxAccessible (wxWindow* win = NULL) Constructor, taking an optional window. The object can be associated with a window later. .SS ~wxAccessible () Destructor. .SS virtual wxAccStatus DoDefaultAction (int childId) Performs the default action for the object. childId is 0 (the action for this object) or greater than 0 (the action for a child). Return wxACC_NOT_SUPPORTED if there is no default action for this window (e.g. an edit control). .SS virtual wxAccStatus GetChild (int childIdwxAccessible** child) Gets the specified child (starting from 1). If child is NULL and the return value is wxACC_OK, this means that the child is a simple element and not an accessible object. .SS virtual wxAccStatus GetChildCount (int* childCount) Returns the number of children in childCount . .SS virtual wxAccStatus GetDefaultAction (int childIdwxString* actionName) Gets the default action for this object (0) or a child (greater than 0). Return wxACC_OK even if there is no action. actionName is the action, or the empty string if there is no action. The retrieved string describes the action that is performed on an object, not what the object does as a result. For example, a toolbar button that prints a document has a default action of "Press" rather than "Prints the current document." .SS virtual wxAccStatus GetDescription (int childIdwxString* description) Returns the description for this object or a child. .SS virtual wxAccStatus GetFocus (int* childIdwxAccessible** child) Gets the window with the keyboard focus. If childId is 0 and child is NULL, no object in this subhierarchy has the focus. If this object has the focus, child should be 'this'. .SS virtual wxAccStatus GetHelpText (int childIdwxString* helpText) Returns help text for this object or a child, similar to tooltip text. .SS virtual wxAccStatus GetKeyboardShortcut (int childIdwxString* shortcut) Returns the keyboard shortcut for this object or child. Return e.g. ALT+K. .SS virtual wxAccStatus GetLocation (wxRect& rectint elementId) Returns the rectangle for this object (id is 0) or a child element (id is greater than 0). rect is in screen coordinates. .SS virtual wxAccStatus GetName (int childIdwxString* name) Gets the name of the specified object. .SS virtual wxAccStatus GetParent (wxAccessible** parent) Returns the parent of this object, or NULL. .SS virtual wxAccStatus GetRole (int childIdwxAccRole* role) Returns a role constant describing this object. See wxAccessible for a list of these roles. .SS virtual wxAccStatus GetSelections (wxVariant* selections) Gets a variant representing the selected children of this object. Acceptable values are: a null variant (IsNull() returns TRUE) a list variant (GetType() == wxT("list")) an integer representing the selected child element, or 0 if this object is selected (GetType() == wxT("long")) a "void*" pointer to a wxAccessible child object .SS virtual wxAccStatus GetState (int childIdlong* state) Returns a state constant. See wxAccessible for a list of these states. .SS virtual wxAccStatus GetValue (int childIdwxString* strValue) Returns a localized string representing the value for the object or child. .SS wxWindow* GetWindow () Returns the window associated with this object. .SS virtual wxAccStatus HitTest (const wxPoint& ptint* childIdwxAccessible** childObject) Returns a status value and object id to indicate whether the given point was on this or a child object. Can return either a child object, or an integer representing the child element, starting from 1. pt is in screen coordinates. .SS virtual wxAccStatus Navigate (wxNavDir navDirint fromIdint* toIdwxAccessible** toObject) Navigates from fromId to toId / toObject . .SS virtual static void NotifyEvent (int eventTypewxWindow* windowwxAccObject objectTypeint objectType) Allows the application to send an event when something changes in an accessible object. .SS virtual wxAccStatus Select (int childIdwxAccSelectionFlags selectFlags) Selects the object or child. See wxAccessible for a list of the selection actions. .SS void SetWindow (wxWindow* window) Sets the window associated with this object. .SH "SEE ALSO" wxObject .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.