X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0497e17283d5ec84df3d1b24e74b79d1488f5637..50c538600e7586c256fe0145ac8054f045be6fbb:/docs/latex/wx/accessible.tex diff --git a/docs/latex/wx/accessible.tex b/docs/latex/wx/accessible.tex index fb426d7d01..323c90a76f 100644 --- a/docs/latex/wx/accessible.tex +++ b/docs/latex/wx/accessible.tex @@ -5,10 +5,10 @@ \section{\class{wxAccessible}}\label{wxaccessible} -The wxAccessible class allows wxWindows applications, and -wxWindows itself, to return extended information about user interface elements +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 wxWindows implements accessibility features. +main way in which wxWidgets implements accessibility features. At present, only Microsoft Active Accessibility is supported by this class. @@ -32,7 +32,7 @@ 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 wxWindows only if the wxUSE\_ACCESSIBILITY setup +This class is compiled into wxWidgets only if the wxUSE\_ACCESSIBILITY setup symbol is set to 1. \wxheading{Derived from} @@ -48,7 +48,7 @@ symbol is set to 1. Functions return a wxAccStatus error code, which may be one of the following: -{\small% +{\small \begin{verbatim} typedef enum { @@ -58,12 +58,13 @@ typedef enum wxACC\_NOT\_IMPLEMENTED, // The function is not implemented wxACC\_NOT\_SUPPORTED // The function is not supported } wxAccStatus -\end{verbatim}} +\end{verbatim} +} Directions of navigation are represented by the following: -{\small% +{\small \begin{verbatim} typedef enum { @@ -76,12 +77,13 @@ typedef enum wxNAVDIR\_RIGHT, wxNAVDIR\_UP } wxNavDir -\end{verbatim}} +\end{verbatim} +} The role of a user interface element is represented by the following type: -{\small% +{\small \begin{verbatim} typedef enum { wxROLE\_NONE, @@ -147,11 +149,12 @@ typedef enum { wxROLE\_SYSTEM\_WHITESPACE, wxROLE\_SYSTEM\_WINDOW } wxAccRole -\end{verbatim}} +\end{verbatim} +} Objects are represented by the following type: -{\small% +{\small \begin{verbatim} typedef enum { wxOBJID\_WINDOW = 0x00000000, @@ -167,12 +170,13 @@ typedef enum { wxOBJID\_ALERT = 0xFFFFFFF6, wxOBJID\_SOUND = 0xFFFFFFF5 } wxAccObject -\end{verbatim}} +\end{verbatim} +} Selection actions are identified by this type: -{\small% +{\small \begin{verbatim} typedef enum { @@ -183,11 +187,12 @@ typedef enum wxACC\_SEL\_ADDSELECTION = 8, wxACC\_SEL\_REMOVESELECTION = 16 } wxAccSelectionFlags -\end{verbatim}} +\end{verbatim} +} States are represented by the following: -{\small% +{\small \begin{verbatim} #define wxACC\_STATE\_SYSTEM\_ALERT\_HIGH 0x00000001 #define wxACC\_STATE\_SYSTEM\_ALERT\_MEDIUM 0x00000002 @@ -215,12 +220,13 @@ States are represented by the following: #define wxACC\_STATE\_SYSTEM\_SELECTED 0x00800000 #define wxACC\_STATE\_SYSTEM\_SELFVOICING 0x01000000 #define wxACC\_STATE\_SYSTEM\_UNAVAILABLE 0x02000000 -\end{verbatim}} +\end{verbatim} +} Event identifiers that can be sent via \helpref{wxAccessible::NotifyEvent}{wxaccessiblenotifyevent} are as follows: -{\small% +{\small \begin{verbatim} #define wxACC\_EVENT\_SYSTEM\_SOUND 0x0001 #define wxACC\_EVENT\_SYSTEM\_ALERT 0x0002 @@ -264,7 +270,8 @@ as follows: #define wxACC\_EVENT\_OBJECT\_HELPCHANGE 0x8010 #define wxACC\_EVENT\_OBJECT\_DEFACTIONCHANGE 0x8011 #define wxACC\_EVENT\_OBJECT\_ACCELERATORCHANGE 0x8012 -\end{verbatim}} +\end{verbatim} +} \latexignore{\rtfignore{\wxheading{Members}}}