First step in background erase optimization

[wxWidgets.git] / docs / latex / wx / accessible.tex

diff --git a/docs/latex/wx/accessible.tex b/docs/latex/wx/accessible.tex
index c0935232f04c4a89a75e865d079ca96556b9dae0..323c90a76fd079b69ab8aed7bf65e86b8914d6f3 100644 (file)
--- a/docs/latex/wx/accessible.tex
+++ b/docs/latex/wx/accessible.tex
@@ -5,10 +5,10 @@
 
 \section{\class{wxAccessible}}\label{wxaccessible}
 
 
 \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
 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.
 
 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.
 
 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}
 symbol is set to 1.
 
 \wxheading{Derived from}


@@ -48,7 +48,8 @@ symbol is set to 1.
 Functions return a wxAccStatus error code, which
 may be one of the following:
 
 Functions return a wxAccStatus error code, which
 may be one of the following:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 typedef enum
 {
     wxACC\_FAIL,             // The function failed
 typedef enum
 {
     wxACC\_FAIL,             // The function failed


@@ -57,12 +58,14 @@ typedef enum
     wxACC\_NOT\_IMPLEMENTED, // The function is not implemented
     wxACC\_NOT\_SUPPORTED    // The function is not supported
 } wxAccStatus
     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:
 
 
 Directions of navigation are represented by
 the following:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 typedef enum
 {
     wxNAVDIR\_DOWN,
 typedef enum
 {
     wxNAVDIR\_DOWN,


@@ -74,12 +77,14 @@ typedef enum
     wxNAVDIR\_RIGHT,
     wxNAVDIR\_UP
 } wxNavDir
     wxNAVDIR\_RIGHT,
     wxNAVDIR\_UP
 } wxNavDir

-\end{verbatim}}
+\end{verbatim}
+}

 
 The role of a user interface element is represented
 by the following type:
 
 
 The role of a user interface element is represented
 by the following type:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 typedef enum {  
     wxROLE\_NONE,
     wxROLE\_SYSTEM\_ALERT,
 typedef enum {  
     wxROLE\_NONE,
     wxROLE\_SYSTEM\_ALERT,


@@ -144,11 +149,13 @@ typedef enum {
     wxROLE\_SYSTEM\_WHITESPACE,
     wxROLE\_SYSTEM\_WINDOW
 } wxAccRole
     wxROLE\_SYSTEM\_WHITESPACE,
     wxROLE\_SYSTEM\_WINDOW
 } wxAccRole

-\end{verbatim}}
+\end{verbatim}
+}

 
 Objects are represented by the following type:
 
 
 Objects are represented by the following type:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 typedef enum {
     wxOBJID\_WINDOW =    0x00000000,
     wxOBJID\_SYSMENU =   0xFFFFFFFF,
 typedef enum {
     wxOBJID\_WINDOW =    0x00000000,
     wxOBJID\_SYSMENU =   0xFFFFFFFF,


@@ -163,12 +170,14 @@ typedef enum {
     wxOBJID\_ALERT =     0xFFFFFFF6,
     wxOBJID\_SOUND =     0xFFFFFFF5
 } wxAccObject
     wxOBJID\_ALERT =     0xFFFFFFF6,
     wxOBJID\_SOUND =     0xFFFFFFF5
 } wxAccObject

-\end{verbatim}}
+\end{verbatim}
+}

 
 Selection actions are identified by
 this type:
 
 
 Selection actions are identified by
 this type:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 typedef enum
 {
     wxACC\_SEL\_NONE            = 0,
 typedef enum
 {
     wxACC\_SEL\_NONE            = 0,


@@ -178,11 +187,13 @@ typedef enum
     wxACC\_SEL\_ADDSELECTION    = 8,
     wxACC\_SEL\_REMOVESELECTION = 16
 } wxAccSelectionFlags
     wxACC\_SEL\_ADDSELECTION    = 8,
     wxACC\_SEL\_REMOVESELECTION = 16
 } wxAccSelectionFlags

-\end{verbatim}}
+\end{verbatim}
+}

 
 States are represented by the following:
 
 
 States are represented by the following:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 #define wxACC\_STATE\_SYSTEM\_ALERT\_HIGH       0x00000001
 #define wxACC\_STATE\_SYSTEM\_ALERT\_MEDIUM     0x00000002
 #define wxACC\_STATE\_SYSTEM\_ALERT\_LOW        0x00000004
 #define wxACC\_STATE\_SYSTEM\_ALERT\_HIGH       0x00000001
 #define wxACC\_STATE\_SYSTEM\_ALERT\_MEDIUM     0x00000002
 #define wxACC\_STATE\_SYSTEM\_ALERT\_LOW        0x00000004


@@ -209,12 +220,14 @@ States are represented by the following:
 #define wxACC\_STATE\_SYSTEM\_SELECTED         0x00800000
 #define wxACC\_STATE\_SYSTEM\_SELFVOICING      0x01000000
 #define wxACC\_STATE\_SYSTEM\_UNAVAILABLE      0x02000000
 #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:
 
 
 Event identifiers that can be sent via \helpref{wxAccessible::NotifyEvent}{wxaccessiblenotifyevent} are
 as follows:
 

-{\small \begin{verbatim}
+{\small 
+\begin{verbatim}

 #define wxACC\_EVENT\_SYSTEM\_SOUND              0x0001
 #define wxACC\_EVENT\_SYSTEM\_ALERT              0x0002
 #define wxACC\_EVENT\_SYSTEM\_FOREGROUND         0x0003
 #define wxACC\_EVENT\_SYSTEM\_SOUND              0x0001
 #define wxACC\_EVENT\_SYSTEM\_ALERT              0x0002
 #define wxACC\_EVENT\_SYSTEM\_FOREGROUND         0x0003


@@ -257,7 +270,8 @@ as follows:
 #define wxACC\_EVENT\_OBJECT\_HELPCHANGE             0x8010
 #define wxACC\_EVENT\_OBJECT\_DEFACTIONCHANGE        0x8011
 #define wxACC\_EVENT\_OBJECT\_ACCELERATORCHANGE      0x8012
 #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}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -291,9 +305,9 @@ this means that the child is a simple element and not an accessible object.
 
 \membersection{wxAccessible::GetChildCount}\label{wxaccessiblegetchildcount}
 
 
 \membersection{wxAccessible::GetChildCount}\label{wxaccessiblegetchildcount}
 

-\func{virtual wxAccStatus}{GetChildCount}{\param{int* }{childId}}
+\func{virtual wxAccStatus}{GetChildCount}{\param{int* }{childCount}}

 
 

-Returns the number of children in {\it childId}.
+Returns the number of children in {\it childCount}.

 
 \membersection{wxAccessible::GetDefaultAction}\label{wxaccessiblegetdefaultaction}
 
 
 \membersection{wxAccessible::GetDefaultAction}\label{wxaccessiblegetdefaultaction}
 


@@ -336,6 +350,7 @@ Return e.g. ALT+K.
 \func{virtual wxAccStatus}{GetLocation}{\param{wxRect\& }{rect}, \param{int }{elementId}}
 
 Returns the rectangle for this object (id is 0) or a child element (id is greater than 0).
 \func{virtual wxAccStatus}{GetLocation}{\param{wxRect\& }{rect}, \param{int }{elementId}}
 
 Returns the rectangle for this object (id is 0) or a child element (id is greater than 0).

+{\it rect} is in screen coordinates.

 
 \membersection{wxAccessible::GetName}\label{wxaccessiblegetname}
 
 
 \membersection{wxAccessible::GetName}\label{wxaccessiblegetname}
 


@@ -401,15 +416,17 @@ Returns a status value and object id to indicate whether the given point was on
 a child object. Can return either a child object, or an integer
 representing the child element, starting from 1.
 
 a child object. Can return either a child object, or an integer
 representing the child element, starting from 1.
 

+{\it pt} is in screen coordinates.
+

 \membersection{wxAccessible::Navigate}\label{wxaccessiblenavigate}
 
 \func{virtual wxAccStatus}{Navigate}{\param{wxNavDir }{navDir}, \param{int }{fromId}, \param{int* }{toId}, \param{wxAccessible** }{toObject}}
 
 Navigates from {\it fromId} to {\it toId}/{\it toObject}.
 
 \membersection{wxAccessible::Navigate}\label{wxaccessiblenavigate}
 
 \func{virtual wxAccStatus}{Navigate}{\param{wxNavDir }{navDir}, \param{int }{fromId}, \param{int* }{toId}, \param{wxAccessible** }{toObject}}
 
 Navigates from {\it fromId} to {\it toId}/{\it toObject}.
 

-\membersection{wxAccessible::Notify}\label{wxaccessiblenotify}
+\membersection{wxAccessible::NotifyEvent}\label{wxaccessiblenotifyevent}

 
 

-\func{virtual static void}{Notify}{\param{int}{ eventType}, \param{wxWindow* }{window}, \param{wxAccObjectt }{objectType}, \param{int }{objectType}}
+\func{virtual static void}{NotifyEvent}{\param{int}{ eventType}, \param{wxWindow* }{window}, \param{wxAccObjectt }{objectType}, \param{int }{objectType}}

 
 Allows the application to send an event when something changes in an accessible object.
 
 
 Allows the application to send an event when something changes in an accessible object.