Some documentation enhancements for wxRichTextCtrl

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

diff --git a/docs/latex/wx/accel.tex b/docs/latex/wx/accel.tex
index 40ae0b24dd63136a007a28d70956a9260efb469a..a9f4804551edc657a08e7011a29a322d2f40ed27 100644 (file)
--- 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.
 
 <wx/accel.h>
 
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullAcceleratorTable}
+
 \wxheading{Example}
 
 {\small%
@@ -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[]}}
 
@@ -142,28 +148,27 @@ wxAcceleratorEntry objects, or 3-tuples consisting of flags, keyCode,
 and cmd values like you would construct wxAcceleratorEntry objects with.}
 
 \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.}
+Wx::AcceleratorEntry objects or references to 3-element arrays
+( flags, keyCode, cmd ), like the parameters of Wx::AcceleratorEntry::new.}
 
-\membersection{wxAcceleratorTable::\destruct{wxAcceleratorTable}}
+\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.
 
-\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}
 
@@ -171,36 +176,5 @@ counter. It is a fast operation.
 
 \wxheading{Return value}
 
-Returns reference to 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}
-
-\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}
-
-\wxheading{Return value}
-
-Returns true if the accelerator tables were unequal, false otherwise.
-
+Returns a reference to this object.