X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fbc899085cd5c92fee408b4d0090e39a9c846853..380a5dd80316202b472967e898feba1386ea5345:/docs/latex/wx/accel.tex?ds=inline diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex index f87438065f..a9f4804551 100644 --- a/docs/latex/wx/accel.tex +++ b/docs/latex/wx/accel.tex @@ -16,7 +16,7 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryconstr} +\membersection{wxAcceleratorEntry::wxAcceleratorEntry}\label{wxacceleratorentryctor} \func{}{wxAcceleratorEntry}{\void} @@ -85,6 +85,12 @@ initial accelerator table for a window. +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullAcceleratorTable} + \wxheading{Example} {\small% @@ -97,13 +103,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 +117,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 +125,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 +147,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.} -\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. +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}} -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} @@ -167,36 +176,5 @@ counter. It is a fast operation. \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.