more minor doc corrections (patch 1144628)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32259 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -35,14 +35,14 @@ a reference to your application object) to be visible to other files.
|
||||
|
||||
\membersection{wxApp::wxApp}\label{wxappctor}
|
||||
|
||||
\func{void}{wxApp}{\void}
|
||||
\func{}{wxApp}{\void}
|
||||
|
||||
Constructor. Called implicitly with a definition of a wxApp object.
|
||||
|
||||
|
||||
\membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}
|
||||
|
||||
\func{void}{\destruct{wxApp}}{\void}
|
||||
\func{}{\destruct{wxApp}}{\void}
|
||||
|
||||
Destructor. Will be called implicitly on program exit if the wxApp
|
||||
object is created on the stack.
|
||||
|
@@ -195,7 +195,7 @@ could break the order of items and, for example, subsequent calls to
|
||||
|
||||
\membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
|
||||
|
||||
\func{}{IsEmpty}{}
|
||||
\func{bool}{IsEmpty}{}
|
||||
|
||||
Returns true if the array is empty, false otherwise. This function returns the
|
||||
same result as {\it GetCount() == 0} but is probably easier to read.
|
||||
@@ -213,7 +213,7 @@ version.
|
||||
|
||||
\membersection{wxArrayString::Last}\label{wxarraystringlast}
|
||||
|
||||
\func{}{Last}{}
|
||||
\func{wxString&}{Last}{}
|
||||
|
||||
Returns the last element of the array. Attempt to access the last element of
|
||||
an empty array will result in assert failure in debug build, however no checks
|
||||
|
@@ -119,7 +119,7 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE.
|
||||
|
||||
\membersection{wxBrush::\destruct{wxBrush}}\label{wxbrushdtor}
|
||||
|
||||
\func{void}{\destruct{wxBrush}}{\void}
|
||||
\func{}{\destruct{wxBrush}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
|
@@ -53,7 +53,7 @@ None
|
||||
|
||||
\membersection{wxBusyInfo::wxBusyInfo}\label{wxbusyinfoctor}
|
||||
|
||||
\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}, \param{wxParent }{*parent = NULL}}
|
||||
\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}, \param{wxWindow* }{parent = NULL}}
|
||||
|
||||
Constructs a busy info window as child of {\it parent} and displays {\it msg}
|
||||
in it.
|
||||
|
@@ -113,9 +113,6 @@ enum wxCalendarHitTestResult
|
||||
|
||||
Default constructor, use \helpref{Create}{wxcalendarctrlcreate} after it.
|
||||
|
||||
|
||||
\membersection{wxCalendarCtrl::wxCalendarCtrl}\label{wxcalendarctrlwxcalendarctrl}
|
||||
|
||||
\func{}{wxCalendarCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxDateTime\& }{date = wxDefaultDateTime}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxCAL\_SHOW\_HOLIDAYS}, \param{const wxString\& }{name = wxCalendarNameStr}}
|
||||
|
||||
Does the same as \helpref{Create}{wxcalendarctrlcreate} method.
|
||||
@@ -333,6 +330,10 @@ enum wxCalendarDateBorder
|
||||
|
||||
\helpref{wxCalendarCtrl}{wxcalendarctrl}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/calctrl.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
|
@@ -70,7 +70,7 @@ No base class
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<clntdata.h>
|
||||
<wx/clntdata.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
@@ -62,6 +62,10 @@ None
|
||||
\helpref{DnD sample}{samplednd},
|
||||
\helpref{wxDataObject}{wxdataobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/dataobj.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformatdef}
|
||||
|
@@ -17,6 +17,10 @@ See also \helpref{wxDataInputStream}{wxdatainputstream}.
|
||||
|
||||
None
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/datstrm.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamctor}
|
||||
|
@@ -1605,6 +1605,12 @@ public.
|
||||
\helpref{database classes overview}{odbcoverview},
|
||||
\helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbctor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/db.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
|
||||
|
||||
Simply initializes all member variables to a cleared state. Called by
|
||||
@@ -1643,6 +1649,12 @@ Only one function is provided with this class currently.
|
||||
See the \helpref{database classes overview}{odbcoverview} for
|
||||
an introduction to using the ODBC classes.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/db.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDbColFor::Format}\label{wxdbcolforformat}
|
||||
|
||||
\func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType},
|
||||
@@ -1699,6 +1711,12 @@ it is non-NULL.
|
||||
See the \helpref{database classes overview}{odbcoverview} for
|
||||
an introduction to using the ODBC classes.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/db.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
|
||||
|
||||
Simply initializes all member variables to a cleared state. Called by
|
||||
@@ -2010,6 +2028,12 @@ it is non-NULL.
|
||||
See the \helpref{database classes overview}{odbcoverview} for
|
||||
an introduction to using the ODBC classes.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/db.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
|
||||
|
||||
Simply initializes all member variables to a cleared state. Called by
|
||||
@@ -3973,6 +3997,12 @@ Eventually, accessor functions will be added for this class
|
||||
See the \helpref{database classes overview}{odbcoverview} for
|
||||
an introduction to using the ODBC classes.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/db.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
|
||||
|
||||
Simply initializes all member variables to a cleared state. Called by
|
||||
|
@@ -203,7 +203,7 @@ is always safe to call. The default value is {\tt www.yahoo.com:80}.
|
||||
|
||||
\membersection{wxDialUpManager::SetConnectCommand}\label{wxdialupmanagersetconnectcommand}
|
||||
|
||||
\func{}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
|
||||
\func{void}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
|
||||
|
||||
This method is for Unix only.
|
||||
|
||||
|
@@ -72,7 +72,7 @@ A list of all document templates.
|
||||
|
||||
\membersection{wxDocManager::wxDocManager}\label{wxdocmanagerctor}
|
||||
|
||||
\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
|
||||
\func{}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
|
||||
|
||||
Constructor. Create a document manager instance dynamically near the start of your application
|
||||
before doing any document or view operations.
|
||||
|
@@ -29,6 +29,7 @@ serves this purpose.
|
||||
|
||||
\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer}
|
||||
|
||||
|
@@ -13,7 +13,9 @@ class may be returned by wxGridTable::GetAttr().
|
||||
|
||||
No base class
|
||||
|
||||
\wxheading{Data structures}
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
@@ -19,6 +19,10 @@ The editor for boolean data.
|
||||
\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
|
||||
\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
@@ -86,6 +90,10 @@ wxGridCellWorker
|
||||
\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
|
||||
\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
|
||||
@@ -200,10 +208,12 @@ The editor for floating point numbers data.
|
||||
\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
|
||||
\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
|
||||
|
||||
\func{}{wxGridCellFloatEditor}{\param{int }{width = -1}, \param{int }{precision = -1}}
|
||||
@@ -237,10 +247,12 @@ The editor for numeric integer data.
|
||||
\helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
|
||||
\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
|
||||
|
||||
\func{}{wxGridCellNumberEditor}{\param{int }{min = -1}, \param{int }{max = -1}}
|
||||
@@ -287,6 +299,10 @@ The editor for string/text data.
|
||||
\helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
|
||||
\helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
|
@@ -18,6 +18,10 @@ The ...\_CMD\_... variants also take a window identifier.
|
||||
\twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
|
||||
\end{twocollist}%
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}
|
||||
@@ -169,6 +173,10 @@ The ...\_CMD\_... variants also take a window identifier.
|
||||
\twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
|
||||
\end{twocollist}%
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridRangeSelectEvent::wxGridRangeSelectEvent}\label{wxgridrangeselecteventconstr}
|
||||
|
@@ -14,6 +14,10 @@ for string cells.
|
||||
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
|
||||
\helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}
|
||||
@@ -40,6 +44,10 @@ This class may be used to format floating point data in a cell.
|
||||
\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
|
||||
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellFloatRenderer::wxGridCellFloatRenderer}\label{wxgridcellfloatrendererconstr}
|
||||
@@ -97,6 +105,10 @@ This class may be used to format integer data in a cell.
|
||||
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
|
||||
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}
|
||||
@@ -124,6 +136,10 @@ wxGridCellWorker
|
||||
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
|
||||
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellRenderer::Draw}\label{wxgridcellrendererdraw}
|
||||
@@ -164,6 +180,10 @@ for string cells.
|
||||
\helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
|
||||
\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}
|
||||
|
@@ -6,7 +6,9 @@ Grid table classes.
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Data structures}
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/grid.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
@@ -13,6 +13,8 @@ descriptions of the member functions.
|
||||
|
||||
<wx/dcps.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxPostScriptDC::wxPostScriptDC}\label{wxpostscriptdcctor}
|
||||
|
||||
\func{}{wxPostScriptDC}{\param{const wxPrintData\&}{ printData}}
|
||||
|
@@ -114,6 +114,10 @@ size_t count = reEmail.ReplaceAll(text, wxT("HIDDEN@\\2\\3"));
|
||||
printf("text now contains %u hidden addresses", count);
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/regex.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxRegEx::wxRegEx}\label{wxregexwxregex}
|
||||
|
@@ -1,8 +1,3 @@
|
||||
%
|
||||
% automatically generated by HelpGen from
|
||||
% /home/vasek/tooltip.h at 24/May/00 16:57:08
|
||||
%
|
||||
|
||||
\section{\class{wxToolTip}}\label{wxtooltip}
|
||||
|
||||
This class holds information about a tooltip associated with a window
|
||||
@@ -16,6 +11,9 @@ alter tooltips behaviour.
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/tooltip.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
@@ -207,6 +207,10 @@ You can also simulate the C++ cout class:
|
||||
The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
|
||||
and Unix in their native formats (concerning the line ending).
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/txtstrm.h>
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user