documentation for window ids allocation and wxIdManager (patch 1870570)

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

diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex
index f87438065fa338171087a3ad7a73ac36d40abc35..aa210ce7b098fd4de3e59540f1b5346ff66136bc 100644 (file)
--- a/docs/latex/wx/accel.tex
+++ b/docs/latex/wx/accel.tex
@@ -10,13 +10,17 @@ None
 
 <wx/accel.h>
 
 
 <wx/accel.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryconstr}
+\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryctor}

 
 \func{}{wxAcceleratorEntry}{\void}
 
 
 \func{}{wxAcceleratorEntry}{\void}
 


@@ -71,7 +75,7 @@ which modifier key is held down.}
 \section{\class{wxAcceleratorTable}}\label{wxacceleratortable}
 
 An accelerator table allows the application to specify a table of keyboard shortcuts for
 \section{\class{wxAcceleratorTable}}\label{wxacceleratortable}
 
 An accelerator table allows the application to specify a table of keyboard shortcuts for

-menus or other commands. On Windows, menu or button commands are supported; on GTK,
+menus or other commands. On Windows and Mac OS X, menu or button commands are supported; on GTK,

 only menu commands are supported.
 
 The object {\bf wxNullAcceleratorTable} is defined to be a table with no data, and is the
 only menu commands are supported.
 
 The object {\bf wxNullAcceleratorTable} is defined to be a table with no data, and is the


@@ -85,6 +89,16 @@ initial accelerator table for a window.
 
 <wx/accel.h>
 
 
 <wx/accel.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullAcceleratorTable}
+

 \wxheading{Example}
 
 {\small%
 \wxheading{Example}
 
 {\small%


@@ -97,13 +111,13 @@ initial accelerator table for a window.
   wxAcceleratorTable accel(4, entries);
   frame->SetAcceleratorTable(accel);
 \end{verbatim}
   wxAcceleratorTable accel(4, entries);
   frame->SetAcceleratorTable(accel);
 \end{verbatim}

-}
+}%

 
 \wxheading{Remarks}
 
 An accelerator takes precedence over normal processing and can be a convenient way to program some event handling.
 For example, you can use an accelerator table to enable a dialog with a multi-line text control to
 
 \wxheading{Remarks}
 
 An accelerator takes precedence over normal processing and can be a convenient way to program some event handling.
 For example, you can use an accelerator table to enable a dialog with a multi-line text control to

-accept CTRL-Enter as meaning 'OK' (but not in GTK at present).
+accept CTRL-Enter as meaning `OK' (but not in GTK+ at present).

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -111,7 +125,7 @@ accept CTRL-Enter as meaning 'OK' (but not in GTK at present).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortableconstr}
+\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortablector}

 
 \func{}{wxAcceleratorTable}{\void}
 
 
 \func{}{wxAcceleratorTable}{\void}
 


@@ -119,7 +133,7 @@ Default constructor.
 
 \func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}}
 
 
 \func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}}
 

-Copy constructor.
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 \func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}}
 
 
 \func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}}
 


@@ -141,25 +155,28 @@ Loads the accelerator table from a Windows resource (Windows only).
 wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
 and cmd values like you would construct wxAcceleratorEntry objects with.}
 
 wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
 and cmd values like you would construct wxAcceleratorEntry objects with.}
 

-\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}
+\perlnote{The wxPerl constructor accepts a list of either
+Wx::AcceleratorEntry objects or references to 3-element arrays
+( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.}
+
+\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}\label{wxacceleratortabledtor}

 
 \func{}{\destruct{wxAcceleratorTable}}{\void}
 
 Destroys the wxAcceleratorTable object.
 
 \func{}{\destruct{wxAcceleratorTable}}{\void}
 
 Destroys the wxAcceleratorTable object.

+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.

 
 

-\membersection{wxAcceleratorTable::Ok}\label{wxacceleratortableok}
+\membersection{wxAcceleratorTable::IsOk}\label{wxacceleratortableisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 

-Returns TRUE if the accelerator table is valid.
+Returns true if the accelerator table is valid.

 
 

-\membersection{wxAcceleratorTable::operator $=$}
+\membersection{wxAcceleratorTable::operator $=$}\label{wxacceleratortableassign}

 
 \func{wxAcceleratorTable\& }{operator $=$}{\param{const wxAcceleratorTable\& }{accel}}
 
 
 \func{wxAcceleratorTable\& }{operator $=$}{\param{const wxAcceleratorTable\& }{accel}}
 

-Assignment operator. This operator does not copy any data, but instead
-passes a pointer to the data in {\it accel} and increments a reference
-counter. It is a fast operation.
+Assignment operator, using \helpref{reference counting}{trefcount}.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -167,36 +184,5 @@ counter. It is a fast operation.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns 'this' object.
-
-\membersection{wxAcceleratorTable::operator $==$}
-
-\func{bool}{operator $==$}{\param{const wxAcceleratorTable\& }{accel}}
-
-Equality operator. This operator tests whether the internal data pointers are
-equal (a fast test).
-
-\wxheading{Parameters}
-
-\docparam{accel}{Accelerator table to compare with 'this'}
-
-\wxheading{Return value}
-
-Returns TRUE if the accelerator tables were effectively equal, FALSE otherwise.
-
-\membersection{wxAcceleratorTable::operator $!=$}
-
-\func{bool}{operator $!=$}{\param{const wxAcceleratorTable\& }{accel}}
-
-Inequality operator. This operator tests whether the internal data pointers are
-unequal (a fast test).
-
-\wxheading{Parameters}
-
-\docparam{accel}{Accelerator table to compare with 'this'}
-
-\wxheading{Return value}
-
-Returns TRUE if the accelerator tables were unequal, FALSE otherwise.
-
+Returns a reference to this object.