]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/accel.tex
Clarify docs about wxSizer::SetSizeHints().
[wxWidgets.git] / docs / latex / wx / accel.tex
index e753a8b75b63650578cc3a372bdd59f72cca0eed..304dbb343913c9dbca6f3f3bba8349ceb115944d 100644 (file)
@@ -16,7 +16,7 @@ None
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryconstr}
+\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryctor}
 
 \func{}{wxAcceleratorEntry}{\void}
 
@@ -97,13 +97,13 @@ initial accelerator table for a window.
   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
-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}
 
@@ -111,7 +111,7 @@ accept CTRL-Enter as meaning `OK' (but not in GTK at present).
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortableconstr}
+\membersection{wxAcceleratorTable::wxAcceleratorTable}\label{wxacceleratortablector}
 
 \func{}{wxAcceleratorTable}{\void}
 
@@ -119,7 +119,7 @@ Default constructor.
 
 \func{}{wxAcceleratorTable}{\param{const wxAcceleratorTable\& }{bitmap}}
 
-Copy constructor.
+Copy constructor, uses \helpref{reference counting}{trefcount}.
 
 \func{}{wxAcceleratorTable}{\param{int}{ n}, \param{wxAcceleratorEntry}{ entries[]}}
 
@@ -141,25 +141,27 @@ 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.}
 
-\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.
 
-\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}}
 
-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}
 
@@ -169,7 +171,7 @@ counter. It is a fast operation.
 
 Returns reference to this object.
 
-\membersection{wxAcceleratorTable::operator $==$}
+\membersection{wxAcceleratorTable::operator $==$}\label{wxacceleratortableequal}
 
 \func{bool}{operator $==$}{\param{const wxAcceleratorTable\& }{accel}}
 
@@ -182,9 +184,9 @@ equal (a fast test).
 
 \wxheading{Return value}
 
-Returns TRUE if the accelerator tables were effectively equal, FALSE otherwise.
+Returns true if the accelerator tables were effectively equal, false otherwise.
 
-\membersection{wxAcceleratorTable::operator $!=$}
+\membersection{wxAcceleratorTable::operator $!=$}\label{wxacceleratortablenotequal}
 
 \func{bool}{operator $!=$}{\param{const wxAcceleratorTable\& }{accel}}
 
@@ -197,6 +199,6 @@ unequal (a fast test).
 
 \wxheading{Return value}
 
-Returns TRUE if the accelerator tables were unequal, FALSE otherwise.
+Returns true if the accelerator tables were unequal, false otherwise.