Missed labels to replace number of 'topicNNN' in anchors. Consistent use of -dtor/-ctor addition in anchors.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29557 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Włodzimierz Skiba
parent
12f9921085
commit
b236c10f77
@ -43,7 +43,7 @@ wxCROSS\_CURSOR}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxCursor::wxCursor}\label{wxcursorconstr}
|
||||
\membersection{wxCursor::wxCursor}\label{wxcursorctor}
|
||||
|
||||
\func{}{wxCursor}{\void}
|
||||
|
||||
@ -225,7 +225,7 @@ wxCursor down_cursor = wxCursor(down_bits, 32, 32,
|
||||
#endif
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{wxCursor::\destruct{wxCursor}}
|
||||
\membersection{wxCursor::\destruct{wxCursor}}\label{wxcursordtor}
|
||||
|
||||
\func{}{\destruct{wxCursor}}{\void}
|
||||
|
||||
|
||||
@ -181,7 +181,7 @@ No base class
|
||||
\latexignore{\rtfignore{\wxheading{Function groups}}}
|
||||
|
||||
|
||||
\membersection{Static functions}
|
||||
\membersection{Static functions}\label{datetimestaticfunctions}
|
||||
|
||||
For convenience, all static functions are collected here. These functions
|
||||
either set or return the static variables of wxDateSpan (the country), return
|
||||
@ -216,7 +216,7 @@ supported. Future versions will support other calendars.
|
||||
\helpref{Today}{wxdatetimetoday}
|
||||
|
||||
|
||||
\membersection{Constructors, assignment operators and setters}
|
||||
\membersection{Constructors, assignment operators and setters}\label{datetimeconstructors}
|
||||
|
||||
Constructors and various {\tt Set()} methods are collected here. If you
|
||||
construct a date object from separate values for day, month and year, you
|
||||
@ -250,11 +250,11 @@ values were correct as constructors can not return an error code.
|
||||
\helpref{operator$=$(struct tm)}{wxdatetimeoperatoreqtm}\rtfsp
|
||||
|
||||
|
||||
\membersection{Accessors}
|
||||
\membersection{Accessors}\label{datetimeaccessors}
|
||||
|
||||
Here are the trivial accessors. Other functions, which might have to perform
|
||||
some more complicated calculations to find the answer are under the
|
||||
\helpref{Calendar calculations}{wxdatetimecalculations} section.
|
||||
\helpref{Calendar calculations}{datetimecalculations} section.
|
||||
|
||||
\helpref{IsValid}{wxdatetimeisvalid}\\
|
||||
\helpref{GetTicks}{wxdatetimegetticks}\\
|
||||
@ -275,7 +275,7 @@ some more complicated calculations to find the answer are under the
|
||||
\helpref{GetAsDOS}{wxdatetimegetasdos}
|
||||
|
||||
|
||||
\membersection{Date comparison}
|
||||
\membersection{Date comparison}\label{datecomparison}
|
||||
|
||||
There are several function to allow date comparison. To supplement them, a few
|
||||
global operators $>$, $<$ etc taking wxDateTime are defined.
|
||||
@ -290,7 +290,7 @@ global operators $>$, $<$ etc taking wxDateTime are defined.
|
||||
\helpref{IsEqualUpTo}{wxdatetimeisequalupto}
|
||||
|
||||
|
||||
\membersection{Date arithmetics}
|
||||
\membersection{Date arithmetics}\label{datearithmetics}
|
||||
|
||||
These functions carry out \helpref{arithmetics}{tdatearithm} on the wxDateTime
|
||||
objects. As explained in the overview, either wxTimeSpan or wxDateSpan may be
|
||||
@ -314,7 +314,7 @@ defined to be equivalent to the second forms of these functions.
|
||||
\helpref{oparator$-=$(wxDateSpan)}{wxdatetimesubtractds}
|
||||
|
||||
|
||||
\membersection{Parsing and formatting dates}
|
||||
\membersection{Parsing and formatting dates}\label{datetimeparsing}
|
||||
|
||||
These functions convert wxDateTime obejcts to and from text. The
|
||||
conversions to text are mostly trivial: you can either do it using the default
|
||||
@ -358,7 +358,7 @@ parse the strings such as {\tt "tomorrow"}, {\tt "March first"} and even
|
||||
\helpref{FormatISOTime}{wxdatetimeformatisotime}
|
||||
|
||||
|
||||
\membersection{Calendar calculations}\label{wxdatetimecalculations}
|
||||
\membersection{Calendar calculations}\label{datetimecalculations}
|
||||
|
||||
The functions in this section perform the basic calendar calculations, mostly
|
||||
related to the week days. They allow to find the given week day in the
|
||||
@ -384,7 +384,7 @@ wxDateTime -- they only work with the date part of it.
|
||||
\helpref{GetYearDay}{wxdatetimegetyearday}
|
||||
|
||||
|
||||
\membersection{Astronomical/historical functions}
|
||||
\membersection{Astronomical/historical functions}\label{astronomyhistoryfunctions}
|
||||
|
||||
Some degree of support for the date units used in astronomy and/or history is
|
||||
provided. You can construct a wxDateTime object from a
|
||||
@ -401,7 +401,7 @@ provided. You can construct a wxDateTime object from a
|
||||
\helpref{GetRataDie}{wxdatetimegetratadie}
|
||||
|
||||
|
||||
\membersection{Time zone and DST support}
|
||||
\membersection{Time zone and DST support}\label{datetimedstzone}
|
||||
|
||||
Please see the \helpref{time zone overview}{tdatetimezones} for more
|
||||
information about time zones. ormally, these functions should be rarely used.
|
||||
|
||||
@ -39,7 +39,7 @@ None
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr}
|
||||
\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamctor}
|
||||
|
||||
\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}
|
||||
|
||||
@ -57,13 +57,13 @@ mode (see \helpref{wxDataInputStream::ReadString}{wxdatainputstreamreadstring}
|
||||
documentation for detailed description). Note that you must not destroy
|
||||
{\it conv} before you destroy this wxDataInputStream instance!}
|
||||
|
||||
\membersection{wxDataInputStream::\destruct{wxDataInputStream}}
|
||||
\membersection{wxDataInputStream::\destruct{wxDataInputStream}}\label{wxdatainputstreamdtor}
|
||||
|
||||
\func{}{\destruct{wxDataInputStream}}{\void}
|
||||
|
||||
Destroys the wxDataInputStream object.
|
||||
|
||||
\membersection{wxDataInputStream::BigEndianOrdered}
|
||||
\membersection{wxDataInputStream::BigEndianOrdered}\label{wxdatainputstreambigendianordered}
|
||||
|
||||
\func{void}{BigEndianOrdered}{\param{bool}{ be\_order}}
|
||||
|
||||
@ -72,7 +72,7 @@ order, such as written by programs on a big endian architecture
|
||||
(e.g. Sparc) or written by Java-Streams (which always use
|
||||
big-endian order).
|
||||
|
||||
\membersection{wxDataInputStream::Read8}
|
||||
\membersection{wxDataInputStream::Read8}\label{wxdatainputstreamread8}
|
||||
|
||||
\func{wxUint8}{Read8}{\void}
|
||||
|
||||
@ -83,7 +83,7 @@ Reads a single byte from the stream.
|
||||
Reads bytes from the stream in a specified buffer. The amount of
|
||||
bytes to read is specified by the {\it size} variable.
|
||||
|
||||
\membersection{wxDataInputStream::Read16}
|
||||
\membersection{wxDataInputStream::Read16}\label{wxdatainputstreamread16}
|
||||
|
||||
\func{wxUint16}{Read16}{\void}
|
||||
|
||||
@ -94,7 +94,7 @@ Reads a 16 bit unsigned integer from the stream.
|
||||
Reads 16 bit unsigned integers from the stream in a specified buffer. the
|
||||
amount of 16 bit unsigned integer to read is specified by the {\it size} variable.
|
||||
|
||||
\membersection{wxDataInputStream::Read32}
|
||||
\membersection{wxDataInputStream::Read32}\label{wxdatainputstreamread32}
|
||||
|
||||
\func{wxUint32}{Read32}{\void}
|
||||
|
||||
@ -105,7 +105,7 @@ Reads a 32 bit unsigned integer from the stream.
|
||||
Reads 32 bit unsigned integers from the stream in a specified buffer. the amount of
|
||||
32 bit unsigned integer to read is specified by the {\it size} variable.
|
||||
|
||||
\membersection{wxDataInputStream::Read64}
|
||||
\membersection{wxDataInputStream::Read64}\label{wxdatainputstreamread32}
|
||||
|
||||
\func{wxUint64}{Read64}{\void}
|
||||
|
||||
@ -116,7 +116,7 @@ Reads a 64 bit unsigned integer from the stream.
|
||||
Reads 64 bit unsigned integers from the stream in a specified buffer. the amount of
|
||||
64 bit unsigned integer to read is specified by the {\it size} variable.
|
||||
|
||||
\membersection{wxDataInputStream::ReadDouble}
|
||||
\membersection{wxDataInputStream::ReadDouble}\label{wxdatainputstreamreaddouble}
|
||||
|
||||
\func{double}{ReadDouble}{\void}
|
||||
|
||||
|
||||
@ -255,7 +255,7 @@ ODBC errors.}
|
||||
|
||||
Default cursor scrolling is defined by wxODBC\_FWD\_ONLY\_CURSORS in setup.h
|
||||
when the wxWidgets library is built. This behavior can be overridden when
|
||||
an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbconstr}).
|
||||
an instance of a wxDb is created (see \helpref{wxDb constructor}{wxdbctor}).
|
||||
Default setting of this value true, as not all databases/drivers support
|
||||
both types of cursors.
|
||||
|
||||
@ -380,7 +380,7 @@ available through the ODBC driver manager on the current workstation.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDb::wxDb}\label{wxdbconstr}
|
||||
\membersection{wxDb::wxDb}\label{wxdbctor}
|
||||
|
||||
\func{}{wxDb}{\void}
|
||||
|
||||
@ -1083,7 +1083,7 @@ The default setting of whether a wxDb connection to a database allows
|
||||
forward-only or also backward scrolling cursors is defined in setup.h by the
|
||||
value of wxODBC\_FWD\_ONLY\_CURSORS. This default setting can be overridden
|
||||
when the wxDb connection is initially created (see
|
||||
\helpref{wxDb constructor}{wxdbconstr} and \helpref{wxDbGetConnection}{wxdbfunctions}).
|
||||
\helpref{wxDb constructor}{wxdbctor} and \helpref{wxDbGetConnection}{wxdbfunctions}).
|
||||
|
||||
\wxheading{Return value}
|
||||
|
||||
@ -1103,7 +1103,7 @@ versions prior to 2.4.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxDb constructor}{wxdbconstr}, \helpref{wxDbGetConnection}{wxdbfunctions}
|
||||
\helpref{wxDb constructor}{wxdbctor}, \helpref{wxDbGetConnection}{wxdbfunctions}
|
||||
|
||||
\membersection{wxDb::IsOpen}\label{wxdbisopen}
|
||||
|
||||
@ -1335,7 +1335,7 @@ When compiled in release mode (FINAL=1), this setting has no affect.
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxDb constructor}{wxdbconstr}
|
||||
\helpref{wxDb constructor}{wxdbctor}
|
||||
|
||||
\membersection{wxDb::SetSqlLogging}\label{wxdbsetsqllogging}
|
||||
|
||||
@ -1565,7 +1565,7 @@ This class is used to hold information about the columns bound to an
|
||||
instance of a wxDbTable object.
|
||||
|
||||
Each instance of this class describes one column in the wxDbTable
|
||||
object. When calling the \helpref{wxDb constructor}{wxdbconstr}, a
|
||||
object. When calling the \helpref{wxDb constructor}{wxdbctor}, a
|
||||
parameter passed in indicates the number of columns that will be defined for
|
||||
the wxDbTable object. The constructor uses this information to allocate
|
||||
adequate memory for all of the column descriptions in your wxDbTable object.
|
||||
@ -1602,7 +1602,7 @@ public.
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{database classes overview}{odbcoverview},
|
||||
\helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbconstr}
|
||||
\helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbctor}
|
||||
|
||||
\membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
|
||||
|
||||
@ -1711,7 +1711,7 @@ name, user ID, password and default directory path (used with dBase). Other
|
||||
optional fields held in this class are and file type, both for future
|
||||
functions planned to be added for creating/manipulating datasource definitions.
|
||||
|
||||
\membersection{wxDbConnectInf::wxDbConnectInf}
|
||||
\membersection{wxDbConnectInf::wxDbConnectInf}\label{wxdbconnectinfctor}
|
||||
|
||||
\func{}{wxDbConnectInf}{\void}
|
||||
|
||||
@ -3996,7 +3996,7 @@ construction, NULL terminates the list. Use Null also if using two step constru
|
||||
See the database grid example in \helpref{wxDbGridTableBase}{wxdbgridtablebase} to
|
||||
see two different ways for adding columns.
|
||||
|
||||
\membersection{wxDbGridColInfo::\destruct{wxDbGridColInfo}}
|
||||
\membersection{wxDbGridColInfo::\destruct{wxDbGridColInfo}}\label{wxdbgridcolinfodtor}
|
||||
|
||||
\func{}{\destruct{wxDbGridColInfo}}{}
|
||||
|
||||
|
||||
@ -31,14 +31,14 @@ them.
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxDC::wxDC}
|
||||
\membersection{wxDC::wxDC}\label{wxdcctor}
|
||||
|
||||
\func{}{wxDC}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
|
||||
\membersection{wxDC::\destruct{wxDC}}
|
||||
\membersection{wxDC::\destruct{wxDC}}\label{wxdcdtor}
|
||||
|
||||
\func{}{\destruct{wxDC}}{\void}
|
||||
|
||||
@ -1152,7 +1152,7 @@ No base class
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxDCClipper::wxDCClipper}
|
||||
\membersection{wxDCClipper::wxDCClipper}\label{wxdcclipperctor}
|
||||
|
||||
\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},}
|
||||
|
||||
@ -1162,7 +1162,7 @@ Constructor: sets the the clipping region for the given device context to the
|
||||
specified rectangle.
|
||||
|
||||
|
||||
\membersection{wxDCClipper::\destruct{wxDCClipper}}
|
||||
\membersection{wxDCClipper::\destruct{wxDCClipper}}\label{wxdcclipperdtor}
|
||||
|
||||
\func{}{\destruct{wxDCClipper}}{\void}
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ be a real renderer which does the drawing.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDelegateRendererNative::wxDelegateRendererNative}\label{wxdelegaterenderernativewxdelegaterenderernative}
|
||||
\membersection{wxDelegateRendererNative::wxDelegateRendererNative}\label{wxdelegaterenderernativector}
|
||||
|
||||
\func{}{wxDelegateRendererNative}{\void}
|
||||
|
||||
@ -60,7 +60,7 @@ Note that this object does \emph{not} take ownership of (i.e. won't delete)
|
||||
\arg{rendererNative}.
|
||||
|
||||
|
||||
\membersection{wxDelegateRendererNative::DrawXXX}
|
||||
\membersection{wxDelegateRendererNative::DrawXXX}\label{wxdelegaterenderernativedrawxxx}
|
||||
|
||||
\func{}{DrawXXX}{\param{}{$\ldots$}}
|
||||
|
||||
|
||||
@ -96,7 +96,7 @@ See also \helpref{Generic window styles}{windowstyles}.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDialog::wxDialog}\label{wxdialogconstr}
|
||||
\membersection{wxDialog::wxDialog}\label{wxdialogctor}
|
||||
|
||||
\func{}{wxDialog}{\void}
|
||||
|
||||
@ -135,7 +135,7 @@ individual dialog boxes.}
|
||||
|
||||
\helpref{wxDialog::Create}{wxdialogcreate}
|
||||
|
||||
\membersection{wxDialog::\destruct{wxDialog}}
|
||||
\membersection{wxDialog::\destruct{wxDialog}}\label{wxdialogdtor}
|
||||
|
||||
\func{}{\destruct{wxDialog}}{\void}
|
||||
|
||||
@ -160,7 +160,7 @@ Centres the dialog box on the display.
|
||||
\param{long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp
|
||||
\param{const wxString\& }{name = ``dialogBox"}}
|
||||
|
||||
Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogconstr}\rtfsp
|
||||
Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogctor}\rtfsp
|
||||
for details.
|
||||
|
||||
\membersection{wxDialog::EndModal}\label{wxdialogendmodal}
|
||||
|
||||
@ -17,7 +17,7 @@ None
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxDisplay::wxDisplay}\label{wxdisplayconstr}
|
||||
\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor}
|
||||
|
||||
\func{}{wxDisplay}{\param{size\_t }{index = 0}}
|
||||
|
||||
@ -29,7 +29,7 @@ Constructor, setting up a wxDisplay instance with the specified display.
|
||||
and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
|
||||
|
||||
|
||||
\membersection{wxDisplay::\destruct{wxDisplay}}
|
||||
\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor}
|
||||
|
||||
\func{void}{\destruct{wxDisplay}}{\void}
|
||||
|
||||
|
||||
@ -24,19 +24,19 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
\helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe}
|
||||
|
||||
\membersection{wxDocChildFrame::m\_childDocument}
|
||||
\membersection{wxDocChildFrame::m\_childDocument}\label{wxdocchildframemchilddocument}
|
||||
|
||||
\member{wxDocument*}{m\_childDocument}
|
||||
|
||||
The document associated with the frame.
|
||||
|
||||
\membersection{wxDocChildFrame::m\_childView}
|
||||
\membersection{wxDocChildFrame::m\_childView}\label{wxdocchildframemchildview}
|
||||
|
||||
\member{wxView*}{m\_childView}
|
||||
|
||||
The view associated with the frame.
|
||||
|
||||
\membersection{wxDocChildFrame::wxDocChildFrame}
|
||||
\membersection{wxDocChildFrame::wxDocChildFrame}\label{wxdocchildframector}
|
||||
|
||||
\func{}{wxDocChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
|
||||
\param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
@ -45,25 +45,25 @@ The view associated with the frame.
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocChildFrame::\destruct{wxDocChildFrame}}
|
||||
\membersection{wxDocChildFrame::\destruct{wxDocChildFrame}}\label{wxdocchildframedtor}
|
||||
|
||||
\func{}{\destruct{wxDocChildFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocChildFrame::GetDocument}
|
||||
\membersection{wxDocChildFrame::GetDocument}\label{wxdocchildframegetdocument}
|
||||
|
||||
\constfunc{wxDocument*}{GetDocument}{\void}
|
||||
|
||||
Returns the document associated with this frame.
|
||||
|
||||
\membersection{wxDocChildFrame::GetView}
|
||||
\membersection{wxDocChildFrame::GetView}\label{wxdocchildframegetview}
|
||||
|
||||
\constfunc{wxView*}{GetView}{\void}
|
||||
|
||||
Returns the view associated with this frame.
|
||||
|
||||
\membersection{wxDocChildFrame::OnActivate}
|
||||
\membersection{wxDocChildFrame::OnActivate}\label{wxdocchildframeonactivate}
|
||||
|
||||
\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
|
||||
|
||||
@ -71,19 +71,19 @@ Sets the currently active view to be the frame's view. You may need
|
||||
to override (but still call) this function in order to set the keyboard
|
||||
focus for your subwindow.
|
||||
|
||||
\membersection{wxDocChildFrame::OnCloseWindow}
|
||||
\membersection{wxDocChildFrame::OnCloseWindow}\label{wxdocchildframeonclosewindow}
|
||||
|
||||
\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
|
||||
|
||||
Closes and deletes the current view and document.
|
||||
|
||||
\membersection{wxDocChildFrame::SetDocument}
|
||||
\membersection{wxDocChildFrame::SetDocument}\label{wxdocchildframesetdocument}
|
||||
|
||||
\func{void}{SetDocument}{\param{wxDocument *}{doc}}
|
||||
|
||||
Sets the document for this frame.
|
||||
|
||||
\membersection{wxDocChildFrame::SetView}
|
||||
\membersection{wxDocChildFrame::SetView}\label{wxdocchildframesetview}
|
||||
|
||||
\func{void}{SetView}{\param{wxView *}{view}}
|
||||
|
||||
|
||||
@ -20,57 +20,57 @@ and \helpref{wxDocTemplate}{wxdoctemplate} classes.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocManager::m\_currentView}
|
||||
\membersection{wxDocManager::m\_currentView}\label{wxdocmanagermcreateview}
|
||||
|
||||
\member{wxView*}{m\_currentView}
|
||||
|
||||
The currently active view.
|
||||
|
||||
\membersection{wxDocManager::m\_defaultDocumentNameCounter}
|
||||
\membersection{wxDocManager::m\_defaultDocumentNameCounter}\label{wxdocmanagermdefaultdocumentnamecounter}
|
||||
|
||||
\member{int}{m\_defaultDocumentNameCounter}
|
||||
|
||||
Stores the integer to be used for the next default document name.
|
||||
|
||||
\membersection{wxDocManager::m\_fileHistory}
|
||||
\membersection{wxDocManager::m\_fileHistory}\label{wxdocmanagermfilehistory}
|
||||
|
||||
\member{wxFileHistory*}{m\_fileHistory}
|
||||
|
||||
A pointer to an instance of \helpref{wxFileHistory}{wxfilehistory},
|
||||
which manages the history of recently-visited files on the File menu.
|
||||
|
||||
\membersection{wxDocManager::m\_maxDocsOpen}
|
||||
\membersection{wxDocManager::m\_maxDocsOpen}\label{wxdocmanagermmaxdocsopen}
|
||||
|
||||
\member{int}{m\_maxDocsOpen}
|
||||
|
||||
Stores the maximum number of documents that can be opened before
|
||||
existing documents are closed. By default, this is 10,000.
|
||||
|
||||
\membersection{wxDocManager::m\_docs}
|
||||
\membersection{wxDocManager::m\_docs}\label{wxdocmanagermdocs}
|
||||
|
||||
\member{wxList}{m\_docs}
|
||||
|
||||
A list of all documents.
|
||||
|
||||
\membersection{wxDocManager::m\_flags}
|
||||
\membersection{wxDocManager::m\_flags}\label{wxdocmanagermflags}
|
||||
|
||||
\member{long}{m\_flags}
|
||||
|
||||
Stores the flags passed to the constructor.
|
||||
|
||||
\membersection{wxDocManager::m\_lastDirectory}
|
||||
\membersection{wxDocManager::m\_lastDirectory}\label{wxdocmanagermlastdirectory}
|
||||
|
||||
The directory last selected by the user when opening a file.
|
||||
|
||||
\member{wxFileHistory*}{m\_fileHistory}
|
||||
|
||||
\membersection{wxDocManager::m\_templates}
|
||||
\membersection{wxDocManager::m\_templates}\label{wxdocmanagermtemplates}
|
||||
|
||||
\member{wxList}{mnTemplates}
|
||||
|
||||
A list of all document templates.
|
||||
|
||||
\membersection{wxDocManager::wxDocManager}
|
||||
\membersection{wxDocManager::wxDocManager}\label{wxdocmanagerctor}
|
||||
|
||||
\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
|
||||
|
||||
@ -84,43 +84,43 @@ to create a default history list object. If you derive from wxDocManager, you ma
|
||||
base constructor with false, and then call Initialize in your own constructor, to allow
|
||||
your own Initialize or OnCreateFileHistory functions to be called.
|
||||
|
||||
\membersection{wxDocManager::\destruct{wxDocManager}}
|
||||
\membersection{wxDocManager::\destruct{wxDocManager}}\label{wxdocmanagerdtor}
|
||||
|
||||
\func{void}{\destruct{wxDocManager}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocManager::ActivateView}
|
||||
\membersection{wxDocManager::ActivateView}\label{wxdocmanageractivateview}
|
||||
|
||||
\func{void}{ActivateView}{\param{wxView* }{doc}, \param{bool}{ activate}, \param{bool}{ deleting}}
|
||||
|
||||
Sets the current view.
|
||||
|
||||
\membersection{wxDocManager::AddDocument}
|
||||
\membersection{wxDocManager::AddDocument}\label{wxdocmanageradddocument}
|
||||
|
||||
\func{void}{AddDocument}{\param{wxDocument *}{doc}}
|
||||
|
||||
Adds the document to the list of documents.
|
||||
|
||||
\membersection{wxDocManager::AddFileToHistory}
|
||||
\membersection{wxDocManager::AddFileToHistory}\label{wxdocmanageraddfiletohistory}
|
||||
|
||||
\func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
|
||||
|
||||
Adds a file to the file history list, if we have a pointer to an appropriate file menu.
|
||||
|
||||
\membersection{wxDocManager::AssociateTemplate}
|
||||
\membersection{wxDocManager::AssociateTemplate}\label{wxdocmanagerassociatetemplate}
|
||||
|
||||
\func{void}{AssociateTemplate}{\param{wxDocTemplate *}{temp}}
|
||||
|
||||
Adds the template to the document manager's template list.
|
||||
|
||||
\membersection{wxDocManager::CloseDocuments}
|
||||
\membersection{wxDocManager::CloseDocuments}\label{wxdocmanagerclosedocuments}
|
||||
|
||||
\func{bool}{CloseDocuments}{\param{bool }{force = true}}
|
||||
|
||||
Closes all currently opened documents.
|
||||
|
||||
\membersection{wxDocManager::CreateDocument}
|
||||
\membersection{wxDocManager::CreateDocument}\label{wxdocmanagercreatedocument}
|
||||
|
||||
\func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}}
|
||||
|
||||
@ -141,7 +141,7 @@ extension (Windows) or by popping up a template choice list (other platforms).
|
||||
If the maximum number of documents has been reached, this function
|
||||
will delete the oldest currently loaded document before creating a new one.
|
||||
|
||||
\membersection{wxDocManager::CreateView}
|
||||
\membersection{wxDocManager::CreateView}\label{wxdocmanagercreateview}
|
||||
|
||||
\func{wxView*}{CreateView}{\param{wxDocument*}{doc}, \param{long}{ flags}}
|
||||
|
||||
@ -149,7 +149,7 @@ Creates a new view for the given document. If more than one view is allowed for
|
||||
document (by virtue of multiple templates mentioning the same document type), a choice
|
||||
of view is presented to the user.
|
||||
|
||||
\membersection{wxDocManager::DisassociateTemplate}
|
||||
\membersection{wxDocManager::DisassociateTemplate}\label{wxdocmanagerdisassociatetemplate}
|
||||
|
||||
\func{void}{DisassociateTemplate}{\param{wxDocTemplate *}{temp}}
|
||||
|
||||
@ -203,32 +203,32 @@ list functionality.
|
||||
Note that you can add multiple menus using this function, to be managed by the
|
||||
file history object.
|
||||
|
||||
\membersection{wxDocManager::FindTemplateForPath}
|
||||
\membersection{wxDocManager::FindTemplateForPath}\label{wxdocmanagerfindtemplateforpath}
|
||||
|
||||
\func{wxDocTemplate *}{FindTemplateForPath}{\param{const wxString\& }{path}}
|
||||
|
||||
Given a path, try to find template that matches the extension. This is only
|
||||
an approximate method of finding a template for creating a document.
|
||||
|
||||
\membersection{wxDocManager::GetCurrentDocument}
|
||||
\membersection{wxDocManager::GetCurrentDocument}\label{wxdocmanagergetcurrentdocument}
|
||||
|
||||
\func{wxDocument *}{GetCurrentDocument}{\void}
|
||||
|
||||
Returns the document associated with the currently active view (if any).
|
||||
|
||||
\membersection{wxDocManager::GetCurrentView}
|
||||
\membersection{wxDocManager::GetCurrentView}\label{wxdocmanagergetcurrentview}
|
||||
|
||||
\func{wxView *}{GetCurrentView}{\void}
|
||||
|
||||
Returns the currently active view
|
||||
|
||||
\membersection{wxDocManager::GetDocuments}
|
||||
\membersection{wxDocManager::GetDocuments}\label{wxdocmanagergetdocuments}
|
||||
|
||||
\func{wxList\&}{GetDocuments}{\void}
|
||||
|
||||
Returns a reference to the list of documents.
|
||||
|
||||
\membersection{wxDocManager::GetFileHistory}
|
||||
\membersection{wxDocManager::GetFileHistory}\label{wxdocmanagergetfilehistory}
|
||||
|
||||
\func{wxFileHistory *}{GetFileHistory}{\void}
|
||||
|
||||
@ -240,13 +240,13 @@ Returns a pointer to file history.
|
||||
|
||||
Returns the directory last selected by the user when opening a file. Initially empty.
|
||||
|
||||
\membersection{wxDocManager::GetMaxDocsOpen}
|
||||
\membersection{wxDocManager::GetMaxDocsOpen}\label{wxdocmanagergetmaxdocsopen}
|
||||
|
||||
\func{int}{GetMaxDocsOpen}{\void}
|
||||
|
||||
Returns the number of documents that can be open simultaneously.
|
||||
|
||||
\membersection{wxDocManager::GetHistoryFilesCount}
|
||||
\membersection{wxDocManager::GetHistoryFilesCount}\label{wxdocmanagergethistoryfilescount}
|
||||
|
||||
\func{size\_t}{GetHistoryFilesCount}{\void}
|
||||
|
||||
@ -269,7 +269,7 @@ from the default.
|
||||
The bottom line: if you're not deriving from Initialize, forget it and
|
||||
construct wxDocManager with no arguments.
|
||||
|
||||
\membersection{wxDocManager::MakeDefaultName}
|
||||
\membersection{wxDocManager::MakeDefaultName}\label{wxdocmanagermakedefaultname}
|
||||
|
||||
\func{bool}{MakeDefaultName}{\param{const wxString\& }{buf}}
|
||||
|
||||
@ -280,50 +280,50 @@ the counter.
|
||||
\perlnote{In wxPerl this function must return the modified name rather
|
||||
than just modifying the argument.}
|
||||
|
||||
\membersection{wxDocManager::OnCreateFileHistory}
|
||||
\membersection{wxDocManager::OnCreateFileHistory}\label{wxdocmanageroncreatefilehistory}
|
||||
|
||||
\func{wxFileHistory *}{OnCreateFileHistory}{\void}
|
||||
|
||||
A hook to allow a derived class to create a different type of file history. Called
|
||||
from \helpref{Initialize}{wxdocmanagerinitialize}.
|
||||
|
||||
\membersection{wxDocManager::OnFileClose}
|
||||
\membersection{wxDocManager::OnFileClose}\label{wxdocmanageronfileclose}
|
||||
|
||||
\func{void}{OnFileClose}{\void}
|
||||
|
||||
Closes and deletes the currently active document.
|
||||
|
||||
\membersection{wxDocManager::OnFileCloseAll}
|
||||
\membersection{wxDocManager::OnFileCloseAll}\label{wxdocmanageronfilecloseall}
|
||||
|
||||
\func{void}{OnFileCloseAll}{\void}
|
||||
|
||||
Closes and deletes all the currently opened documents.
|
||||
|
||||
\membersection{wxDocManager::OnFileNew}
|
||||
\membersection{wxDocManager::OnFileNew}\label{wxdocmanageronfilenew}
|
||||
|
||||
\func{void}{OnFileNew}{\void}
|
||||
|
||||
Creates a document from a list of templates (if more than one template).
|
||||
|
||||
\membersection{wxDocManager::OnFileOpen}
|
||||
\membersection{wxDocManager::OnFileOpen}\label{wxdocmanageronfileopen}
|
||||
|
||||
\func{void}{OnFileOpen}{\void}
|
||||
|
||||
Creates a new document and reads in the selected file.
|
||||
|
||||
\membersection{wxDocManager::OnFileSave}
|
||||
\membersection{wxDocManager::OnFileSave}\label{wxdocmanageronfilesave}
|
||||
|
||||
\func{void}{OnFileSave}{\void}
|
||||
|
||||
Saves the current document by calling wxDocument::Save for the current document.
|
||||
|
||||
\membersection{wxDocManager::OnFileSaveAs}
|
||||
\membersection{wxDocManager::OnFileSaveAs}\label{wxdocmanageronfilesaveas}
|
||||
|
||||
\func{void}{OnFileSaveAs}{\void}
|
||||
|
||||
Calls wxDocument::SaveAs for the current document.
|
||||
|
||||
\membersection{wxDocManager::OnMenuCommand}
|
||||
\membersection{wxDocManager::OnMenuCommand}\label{wxdocmanageronmenucommand}
|
||||
|
||||
\func{void}{OnMenuCommand}{\param{int}{ cmd}}
|
||||
|
||||
@ -341,13 +341,13 @@ with the following predefined menu item identifiers:
|
||||
|
||||
Unrecognized commands are routed to the currently active wxView's OnMenuCommand.
|
||||
|
||||
\membersection{wxDocManager::RemoveDocument}
|
||||
\membersection{wxDocManager::RemoveDocument}\label{wxdocmanagerremovedocument}
|
||||
|
||||
\func{void}{RemoveDocument}{\param{wxDocument *}{doc}}
|
||||
|
||||
Removes the document from the list of documents.
|
||||
|
||||
\membersection{wxDocManager::SelectDocumentPath}
|
||||
\membersection{wxDocManager::SelectDocumentPath}\label{wxdocmanagerselectdocumentpath}
|
||||
|
||||
\func{wxDocTemplate *}{SelectDocumentPath}{\param{wxDocTemplate **}{templates},
|
||||
\param{int}{ noTemplates}, \param{const wxString\& }{path}, \param{const wxString\& }{bufSize},
|
||||
@ -367,7 +367,7 @@ two values, eg:\par
|
||||
(doctemplate, path) = My::DocManager->SelectDocumentPath( ... );
|
||||
}
|
||||
|
||||
\membersection{wxDocManager::SelectDocumentType}
|
||||
\membersection{wxDocManager::SelectDocumentType}\label{wxdocmanagerselectdocumenttype}
|
||||
|
||||
\func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates},
|
||||
\param{int}{ noTemplates}, \param{bool}{ sort=false}}
|
||||
@ -386,7 +386,7 @@ Default is false.}
|
||||
|
||||
\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
|
||||
|
||||
\membersection{wxDocManager::SelectViewType}
|
||||
\membersection{wxDocManager::SelectViewType}\label{wxdocmanagerselectviewtype}
|
||||
|
||||
\func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates},
|
||||
\param{int}{ noTemplates}, \param{bool}{ sort=false}}
|
||||
@ -413,7 +413,7 @@ Default is false.}
|
||||
|
||||
Sets the directory to be displayed to the user when opening a file. Initially this is empty.
|
||||
|
||||
\membersection{wxDocManager::SetMaxDocsOpen}
|
||||
\membersection{wxDocManager::SetMaxDocsOpen}\label{wxdocmanagersetmaxdocsopen}
|
||||
|
||||
\func{void}{SetMaxDocsOpen}{\param{int}{ n}}
|
||||
|
||||
|
||||
@ -25,19 +25,19 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
|
||||
|
||||
\membersection{wxDocMDIChildFrame::m\_childDocument}
|
||||
\membersection{wxDocMDIChildFrame::m\_childDocument}\label{wxdocmdichildframemchilddocument}
|
||||
|
||||
\member{wxDocument*}{m\_childDocument}
|
||||
|
||||
The document associated with the frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::m\_childView}
|
||||
\membersection{wxDocMDIChildFrame::m\_childView}\label{wxdocmdichildframemchildview}
|
||||
|
||||
\member{wxView*}{m\_childView}
|
||||
|
||||
The view associated with the frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}
|
||||
\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}\label{wxdocmdichildframector}
|
||||
|
||||
\func{}{wxDocMDIChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
|
||||
\param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
@ -46,25 +46,25 @@ The view associated with the frame.
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}
|
||||
\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}\label{wxdocmdichildframedtor}
|
||||
|
||||
\func{}{\destruct{wxDocMDIChildFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::GetDocument}
|
||||
\membersection{wxDocMDIChildFrame::GetDocument}\label{wxdocmdichildframegetdocument}
|
||||
|
||||
\constfunc{wxDocument*}{GetDocument}{\void}
|
||||
|
||||
Returns the document associated with this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::GetView}
|
||||
\membersection{wxDocMDIChildFrame::GetView}\label{wxdocmdichildframegetview}
|
||||
|
||||
\constfunc{wxView*}{GetView}{\void}
|
||||
|
||||
Returns the view associated with this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::OnActivate}
|
||||
\membersection{wxDocMDIChildFrame::OnActivate}\label{wxdocmdichildframeonactivate}
|
||||
|
||||
\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
|
||||
|
||||
@ -72,19 +72,19 @@ Sets the currently active view to be the frame's view. You may need
|
||||
to override (but still call) this function in order to set the keyboard
|
||||
focus for your subwindow.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::OnCloseWindow}
|
||||
\membersection{wxDocMDIChildFrame::OnCloseWindow}\label{wxdocmdichildframeonclosewindow}
|
||||
|
||||
\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
|
||||
|
||||
Closes and deletes the current view and document.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::SetDocument}
|
||||
\membersection{wxDocMDIChildFrame::SetDocument}\label{wxdocmdichildframesetdocument}
|
||||
|
||||
\func{void}{SetDocument}{\param{wxDocument *}{doc}}
|
||||
|
||||
Sets the document for this frame.
|
||||
|
||||
\membersection{wxDocMDIChildFrame::SetView}
|
||||
\membersection{wxDocMDIChildFrame::SetView}\label{wxdocmdichildframesetview}
|
||||
|
||||
\func{void}{SetView}{\param{wxView *}{view}}
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocMDIParentFrame::wxDocMDIParentFrame}
|
||||
\membersection{wxDocMDIParentFrame::wxDocMDIParentFrame}\label{wxdocmdiparentframector}
|
||||
|
||||
\func{}{wxDocParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id},
|
||||
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
@ -35,13 +35,13 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocMDIParentFrame::\destruct{wxDocMDIParentFrame}}
|
||||
\membersection{wxDocMDIParentFrame::\destruct{wxDocMDIParentFrame}}\label{wxdocmdiparentframedtor}
|
||||
|
||||
\func{}{\destruct{wxDocMDIParentFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocMDIParentFrame::OnCloseWindow}
|
||||
\membersection{wxDocMDIParentFrame::OnCloseWindow}\label{wxdocmdiparentframeonclosewindow}
|
||||
|
||||
\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocParentFrame::wxDocParentFrame}
|
||||
\membersection{wxDocParentFrame::wxDocParentFrame}\label{wxdocparentframector}
|
||||
|
||||
\func{}{wxDocParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id},
|
||||
\param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
|
||||
@ -34,13 +34,13 @@ See the example application in {\tt samples/docview}.
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDocParentFrame::\destruct{wxDocParentFrame}}
|
||||
\membersection{wxDocParentFrame::\destruct{wxDocParentFrame}}\label{wxdocparentframedtor}
|
||||
|
||||
\func{}{\destruct{wxDocParentFrame}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocParentFrame::OnCloseWindow}
|
||||
\membersection{wxDocParentFrame::OnCloseWindow}\label{wxdocparentframeonclosewindow}
|
||||
|
||||
\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
|
||||
|
||||
|
||||
@ -17,67 +17,67 @@ document class and a view class.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocTemplate::m\_defaultExt}
|
||||
\membersection{wxDocTemplate::m\_defaultExt}\label{wxdoctemplatemdefaultext}
|
||||
|
||||
\member{wxString}{m\_defaultExt}
|
||||
|
||||
The default extension for files of this type.
|
||||
|
||||
\membersection{wxDocTemplate::m\_description}
|
||||
\membersection{wxDocTemplate::m\_description}\label{wxdoctemplatemdescription}
|
||||
|
||||
\member{wxString}{m\_description}
|
||||
|
||||
A short description of this template.
|
||||
|
||||
\membersection{wxDocTemplate::m\_directory}
|
||||
\membersection{wxDocTemplate::m\_directory}\label{wxdoctemplatemdirectory}
|
||||
|
||||
\member{wxString}{m\_directory}
|
||||
|
||||
The default directory for files of this type.
|
||||
|
||||
\membersection{wxDocTemplate::m\_docClassInfo}
|
||||
\membersection{wxDocTemplate::m\_docClassInfo}\label{wxdoctemplatemdocclassinfo}
|
||||
|
||||
\member{wxClassInfo* }{m\_docClassInfo}
|
||||
|
||||
Run-time class information that allows document instances to be constructed dynamically.
|
||||
|
||||
\membersection{wxDocTemplate::m\_docTypeName}
|
||||
\membersection{wxDocTemplate::m\_docTypeName}\label{wxdoctemplatemdoctypename}
|
||||
|
||||
\member{wxString}{m\_docTypeName}
|
||||
|
||||
The named type of the document associated with this template.
|
||||
|
||||
\membersection{wxDocTemplate::m\_documentManager}
|
||||
\membersection{wxDocTemplate::m\_documentManager}\label{wxdoctemplatedocumentmanager}
|
||||
|
||||
\member{wxDocTemplate*}{m\_documentManager}
|
||||
|
||||
A pointer to the document manager for which this template was created.
|
||||
|
||||
\membersection{wxDocTemplate::m\_fileFilter}
|
||||
\membersection{wxDocTemplate::m\_fileFilter}\label{wxdoctemplatemfilefilter}
|
||||
|
||||
\member{wxString}{m\_fileFilter}
|
||||
|
||||
The file filter (such as {\tt *.txt}) to be used in file selector dialogs.
|
||||
|
||||
\membersection{wxDocTemplate::m\_flags}
|
||||
\membersection{wxDocTemplate::m\_flags}\label{wxdoctemplatemflags}
|
||||
|
||||
\member{long}{m\_flags}
|
||||
|
||||
The flags passed to the constructor.
|
||||
|
||||
\membersection{wxDocTemplate::m\_viewClassInfo}
|
||||
\membersection{wxDocTemplate::m\_viewClassInfo}\label{wxdoctemplatemviewclassinfo}
|
||||
|
||||
\member{wxClassInfo*}{m\_viewClassInfo}
|
||||
|
||||
Run-time class information that allows view instances to be constructed dynamically.
|
||||
|
||||
\membersection{wxDocTemplate::m\_viewTypeName}
|
||||
\membersection{wxDocTemplate::m\_viewTypeName}\label{wxdoctemplatemviewtypename}
|
||||
|
||||
\member{wxString}{m\_viewTypeName}
|
||||
|
||||
The named type of the view associated with this template.
|
||||
|
||||
\membersection{wxDocTemplate::wxDocTemplate}
|
||||
\membersection{wxDocTemplate::wxDocTemplate}\label{wxdoctemplatector}
|
||||
|
||||
\func{}{wxDocTemplate}{\param{wxDocManager* }{manager}, \param{const wxString\& }{descr}, \param{const wxString\& }{filter},
|
||||
\param{const wxString\& }{dir}, \param{const wxString\& }{ext}, \param{const wxString\& }{docTypeName},
|
||||
@ -140,13 +140,13 @@ ext, docTypeName, viewTypeName )}}{
|
||||
{\tt Wx::DocTemplate::CreateView()} must be overridden}
|
||||
\end{twocollist}}}
|
||||
|
||||
\membersection{wxDocTemplate::\destruct{wxDocTemplate}}
|
||||
\membersection{wxDocTemplate::\destruct{wxDocTemplate}}\label{wxdoctemplatedtor}
|
||||
|
||||
\func{void}{\destruct{wxDocTemplate}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxDocTemplate::CreateDocument}
|
||||
\membersection{wxDocTemplate::CreateDocument}\label{wxdoctemplatecreatedocument}
|
||||
|
||||
\func{wxDocument *}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags = 0}}
|
||||
|
||||
@ -157,7 +157,7 @@ function to return an appropriate document instance.
|
||||
This function calls wxDocTemplate::InitDocument which in turns
|
||||
calls wxDocument::OnCreate.
|
||||
|
||||
\membersection{wxDocTemplate::CreateView}
|
||||
\membersection{wxDocTemplate::CreateView}\label{wxdoctemplatecreateview}
|
||||
|
||||
\func{wxView *}{CreateView}{\param{wxDocument *}{doc}, \param{long}{ flags = 0}}
|
||||
|
||||
@ -165,99 +165,99 @@ Creates a new instance of the associated view class. If you have not supplied
|
||||
a wxClassInfo parameter to the template constructor, you will need to override this
|
||||
function to return an appropriate view instance.
|
||||
|
||||
\membersection{wxDocTemplate::GetDefaultExtension}
|
||||
\membersection{wxDocTemplate::GetDefaultExtension}\label{wxdoctemplategetdefaultextension}
|
||||
|
||||
\func{wxString}{GetDefaultExtension}{\void}
|
||||
|
||||
Returns the default file extension for the document data, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetDescription}
|
||||
\membersection{wxDocTemplate::GetDescription}\label{wxdoctemplategetdescription}
|
||||
|
||||
\func{wxString}{GetDescription}{\void}
|
||||
|
||||
Returns the text description of this template, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetDirectory}
|
||||
\membersection{wxDocTemplate::GetDirectory}\label{wxdoctemplategetdirectory}
|
||||
|
||||
\func{wxString}{GetDirectory}{\void}
|
||||
|
||||
Returns the default directory, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetDocumentManager}
|
||||
\membersection{wxDocTemplate::GetDocumentManager}\label{wxdoctemplategetdocumentmanager}
|
||||
|
||||
\func{wxDocManager *}{GetDocumentManager}{\void}
|
||||
|
||||
Returns a pointer to the document manager instance for which this template was created.
|
||||
|
||||
\membersection{wxDocTemplate::GetDocumentName}
|
||||
\membersection{wxDocTemplate::GetDocumentName}\label{wxdoctemplategetdocumentname}
|
||||
|
||||
\func{wxString}{GetDocumentName}{\void}
|
||||
|
||||
Returns the document type name, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetFileFilter}
|
||||
\membersection{wxDocTemplate::GetFileFilter}\label{wxdoctemplategetfilefilter}
|
||||
|
||||
\func{wxString}{GetFileFilter}{\void}
|
||||
|
||||
Returns the file filter, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetFlags}
|
||||
\membersection{wxDocTemplate::GetFlags}\label{wxdoctemplategetflags}
|
||||
|
||||
\func{long}{GetFlags}{\void}
|
||||
|
||||
Returns the flags, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::GetViewName}
|
||||
\membersection{wxDocTemplate::GetViewName}\label{wxdoctemplategetviewname}
|
||||
|
||||
\func{wxString}{GetViewName}{\void}
|
||||
|
||||
Returns the view type name, as passed to the document template constructor.
|
||||
|
||||
\membersection{wxDocTemplate::InitDocument}
|
||||
\membersection{wxDocTemplate::InitDocument}\label{wxdoctemplateinitdocument}
|
||||
|
||||
\func{bool}{InitDocument}{\param{wxDocument* }{doc}, \param{const wxString\& }{path}, \param{long}{ flags = 0}}
|
||||
|
||||
Initialises the document, calling wxDocument::OnCreate. This is called from
|
||||
wxDocTemplate::CreateDocument.
|
||||
|
||||
\membersection{wxDocTemplate::IsVisible}
|
||||
\membersection{wxDocTemplate::IsVisible}\label{wxdoctemplateisvisible}
|
||||
|
||||
\func{bool}{IsVisible}{\void}
|
||||
|
||||
Returns true if the document template can be shown in user dialogs, false otherwise.
|
||||
|
||||
\membersection{wxDocTemplate::SetDefaultExtension}
|
||||
\membersection{wxDocTemplate::SetDefaultExtension}\label{wxdoctemplatesetdefaultextension}
|
||||
|
||||
\func{void}{SetDefaultExtension}{\param{const wxString\& }{ext}}
|
||||
|
||||
Sets the default file extension.
|
||||
|
||||
\membersection{wxDocTemplate::SetDescription}
|
||||
\membersection{wxDocTemplate::SetDescription}\label{wxdoctemplatesetdescription}
|
||||
|
||||
\func{void}{SetDescription}{\param{const wxString\& }{descr}}
|
||||
|
||||
Sets the template description.
|
||||
|
||||
\membersection{wxDocTemplate::SetDirectory}
|
||||
\membersection{wxDocTemplate::SetDirectory}\label{wxdoctemplatesetdirectory}
|
||||
|
||||
\func{void}{SetDirectory}{\param{const wxString\& }{dir}}
|
||||
|
||||
Sets the default directory.
|
||||
|
||||
\membersection{wxDocTemplate::SetDocumentManager}
|
||||
\membersection{wxDocTemplate::SetDocumentManager}\label{wxdoctemplatesetdocumentmanager}
|
||||
|
||||
\func{void}{SetDocumentManager}{\param{wxDocManager *}{manager}}
|
||||
|
||||
Sets the pointer to the document manager instance for which this template was created.
|
||||
Should not be called by the application.
|
||||
|
||||
\membersection{wxDocTemplate::SetFileFilter}
|
||||
\membersection{wxDocTemplate::SetFileFilter}\label{wxdoctemplatesetfilefilter}
|
||||
|
||||
\func{void}{SetFileFilter}{\param{const wxString\& }{filter}}
|
||||
|
||||
Sets the file filter.
|
||||
|
||||
\membersection{wxDocTemplate::SetFlags}
|
||||
\membersection{wxDocTemplate::SetFlags}\label{wxdoctemplatesetflags}
|
||||
|
||||
\func{void}{SetFlags}{\param{long }{flags}}
|
||||
|
||||
|
||||
@ -21,31 +21,31 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDocument::m\_commandProcessor}
|
||||
\membersection{wxDocument::m\_commandProcessor}\label{wxdocumentmcommandprocessor}
|
||||
|
||||
\member{wxCommandProcessor*}{m\_commandProcessor}
|
||||
|
||||
A pointer to the command processor associated with this document.
|
||||
|
||||
\membersection{wxDocument::m\_documentFile}
|
||||
\membersection{wxDocument::m\_documentFile}\label{wxdocumentmdocumentfile}
|
||||
|
||||
\member{wxString}{m\_documentFile}
|
||||
|
||||
Filename associated with this document (``" if none).
|
||||
|
||||
\membersection{wxDocument::m\_documentModified}
|
||||
\membersection{wxDocument::m\_documentModified}\label{wxdocumentmdocumentmodified}
|
||||
|
||||
\member{bool}{m\_documentModified}
|
||||
|
||||
true if the document has been modified, false otherwise.
|
||||
|
||||
\membersection{wxDocument::m\_documentTemplate}
|
||||
\membersection{wxDocument::m\_documentTemplate}\label{wxdocumentmdocumenttemplate}
|
||||
|
||||
\member{wxDocTemplate *}{m\_documentTemplate}
|
||||
|
||||
A pointer to the template from which this document was created.
|
||||
|
||||
\membersection{wxDocument::m\_documentTitle}
|
||||
\membersection{wxDocument::m\_documentTitle}\label{wxdocumentmdocumenttitle}
|
||||
|
||||
\member{wxString}{m\_documentTitle}
|
||||
|
||||
@ -63,39 +63,39 @@ created that use the same document type, this variable is used in wxDocManager::
|
||||
to collate a list of alternative view types that can be used on this kind of
|
||||
document. Do not change the value of this variable.
|
||||
|
||||
\membersection{wxDocument::m\_documentViews}
|
||||
\membersection{wxDocument::m\_documentViews}\label{wxdocumentmdocumentviews}
|
||||
|
||||
\member{wxList}{m\_documentViews}
|
||||
|
||||
List of wxView instances associated with this document.
|
||||
|
||||
\membersection{wxDocument::wxDocument}
|
||||
\membersection{wxDocument::wxDocument}\label{wxdocumentctor}
|
||||
|
||||
\func{}{wxDocument}{\void}
|
||||
|
||||
Constructor. Define your own default constructor to initialize application-specific
|
||||
data.
|
||||
|
||||
\membersection{wxDocument::\destruct{wxDocument}}
|
||||
\membersection{wxDocument::\destruct{wxDocument}}\label{wxdocumentdtor}
|
||||
|
||||
\func{}{\destruct{wxDocument}}{\void}
|
||||
|
||||
Destructor. Removes itself from the document manager.
|
||||
|
||||
\membersection{wxDocument::AddView}
|
||||
\membersection{wxDocument::AddView}\label{wxdocumentaddview}
|
||||
|
||||
\func{virtual bool}{AddView}{\param{wxView *}{view}}
|
||||
|
||||
If the view is not already in the list of views, adds the view and calls OnChangedViewList.
|
||||
|
||||
\membersection{wxDocument::Close}
|
||||
\membersection{wxDocument::Close}\label{wxdocumentclose}
|
||||
|
||||
\func{virtual bool}{Close}{\void}
|
||||
|
||||
Closes the document, by calling OnSaveModified and then (if this returned true) OnCloseDocument.
|
||||
This does not normally delete the document object: use DeleteAllViews to do this implicitly.
|
||||
|
||||
\membersection{wxDocument::DeleteAllViews}
|
||||
\membersection{wxDocument::DeleteAllViews}\label{wxdocumentdeleteviews}
|
||||
|
||||
\func{virtual bool}{DeleteAllViews}{\void}
|
||||
|
||||
@ -104,7 +104,7 @@ delete the document itself, because the wxView destructor calls RemoveView. This
|
||||
in turns calls wxDocument::OnChangedViewList, whose default implemention is to
|
||||
save and delete the document if no views exist.
|
||||
|
||||
\membersection{wxDocument::GetCommandProcessor}
|
||||
\membersection{wxDocument::GetCommandProcessor}\label{wxdocumentgetcommandprocessor}
|
||||
|
||||
\constfunc{wxCommandProcessor*}{GetCommandProcessor}{\void}
|
||||
|
||||
@ -112,32 +112,32 @@ Returns a pointer to the command processor associated with this document.
|
||||
|
||||
See \helpref{wxCommandProcessor}{wxcommandprocessor}.
|
||||
|
||||
\membersection{wxDocument::GetDocumentTemplate}
|
||||
\membersection{wxDocument::GetDocumentTemplate}\label{wxdocumentgetdocumenttemplate}
|
||||
|
||||
\constfunc{wxDocTemplate*}{GetDocumentTemplate}{\void}
|
||||
|
||||
Gets a pointer to the template that created the document.
|
||||
|
||||
\membersection{wxDocument::GetDocumentManager}
|
||||
\membersection{wxDocument::GetDocumentManager}\label{wxdocumentgetdocumentmanager}
|
||||
|
||||
\constfunc{wxDocManager*}{GetDocumentManager}{\void}
|
||||
|
||||
Gets a pointer to the associated document manager.
|
||||
|
||||
\membersection{wxDocument::GetDocumentName}
|
||||
\membersection{wxDocument::GetDocumentName}\label{wxdocumentgetdocumentname}
|
||||
|
||||
\constfunc{wxString}{GetDocumentName}{\void}
|
||||
|
||||
Gets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
|
||||
|
||||
\membersection{wxDocument::GetDocumentWindow}
|
||||
\membersection{wxDocument::GetDocumentWindow}\label{wxdocumentgetdocumentwindow}
|
||||
|
||||
\constfunc{wxWindow*}{GetDocumentWindow}{\void}
|
||||
|
||||
Intended to return a suitable window for using as a parent for document-related
|
||||
dialog boxes. By default, uses the frame associated with the first view.
|
||||
|
||||
\membersection{wxDocument::GetFilename}
|
||||
\membersection{wxDocument::GetFilename}\label{wxdocumentgetfilename}
|
||||
|
||||
\constfunc{wxString}{GetFilename}{\void}
|
||||
|
||||
@ -153,7 +153,7 @@ in many cases a document will only have a single view.
|
||||
|
||||
See also: \helpref{GetViews}{wxdocumentgetviews}
|
||||
|
||||
\membersection{wxDocument::GetPrintableName}
|
||||
\membersection{wxDocument::GetPrintableName}\label{wxdocumentgetprintablename}
|
||||
|
||||
\constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}}
|
||||
|
||||
@ -164,7 +164,7 @@ filename, the string {\bf unnamed}.
|
||||
\perlnote{In wxPerl this function must return the modified name rather
|
||||
than just modifying the argument.}
|
||||
|
||||
\membersection{wxDocument::GetTitle}
|
||||
\membersection{wxDocument::GetTitle}\label{wxdocumentgettitle}
|
||||
|
||||
\constfunc{wxString}{GetTitle}{\void}
|
||||
|
||||
@ -190,7 +190,7 @@ record of being modified (for example if using wxTextWindow to view and edit the
|
||||
|
||||
See also \helpref{Modify}{wxdocumentmodify}.
|
||||
|
||||
\membersection{wxDocument::LoadObject}
|
||||
\membersection{wxDocument::LoadObject}\label{wxdocumentloadobject}
|
||||
|
||||
\func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
|
||||
|
||||
@ -213,7 +213,7 @@ record of being modified (for example if using wxTextWindow to view and edit the
|
||||
|
||||
See also \helpref{IsModified}{wxdocumentismodified}.
|
||||
|
||||
\membersection{wxDocument::OnChangedViewList}
|
||||
\membersection{wxDocument::OnChangedViewList}\label{wxdocumentonchangedviewlist}
|
||||
|
||||
\func{virtual void}{OnChangedViewList}{\void}
|
||||
|
||||
@ -221,7 +221,7 @@ Called when a view is added to or deleted from this document. The default
|
||||
implementation saves and deletes the document if no views exist (the last
|
||||
one has just been removed).
|
||||
|
||||
\membersection{wxDocument::OnCloseDocument}
|
||||
\membersection{wxDocument::OnCloseDocument}\label{wxdocumentonclosedocument}
|
||||
|
||||
\func{virtual bool}{OnCloseDocument}{\void}
|
||||
|
||||
@ -229,7 +229,7 @@ The default implementation calls DeleteContents (an empty implementation)
|
||||
sets the modified flag to false. Override this to
|
||||
supply additional behaviour when the document is closed with Close.
|
||||
|
||||
\membersection{wxDocument::OnCreate}
|
||||
\membersection{wxDocument::OnCreate}\label{wxdocumentoncreate}
|
||||
|
||||
\func{virtual bool}{OnCreate}{\param{const wxString\& }{path}, \param{long}{ flags}}
|
||||
|
||||
@ -238,7 +238,7 @@ to initialize itself. The default implementation uses the
|
||||
template associated with the document to create an initial view.
|
||||
If this function returns false, the document is deleted.
|
||||
|
||||
\membersection{wxDocument::OnCreateCommandProcessor}
|
||||
\membersection{wxDocument::OnCreateCommandProcessor}\label{wxdocumentoncreatecommandprocessor}
|
||||
|
||||
\func{virtual wxCommandProcessor*}{OnCreateCommandProcessor}{\void}
|
||||
|
||||
@ -248,14 +248,14 @@ an instance of wxCommandProcessor.
|
||||
|
||||
See \helpref{wxCommandProcessor}{wxcommandprocessor}.
|
||||
|
||||
\membersection{wxDocument::OnNewDocument}
|
||||
\membersection{wxDocument::OnNewDocument}\label{wxdocumentonnewdocument}
|
||||
|
||||
\func{virtual bool}{OnNewDocument}{\void}
|
||||
|
||||
The default implementation calls OnSaveModified and DeleteContents, makes a default title for the
|
||||
document, and notifies the views that the filename (in fact, the title) has changed.
|
||||
|
||||
\membersection{wxDocument::OnOpenDocument}
|
||||
\membersection{wxDocument::OnOpenDocument}\label{wxdocumentonopendocument}
|
||||
|
||||
\func{virtual bool}{OnOpenDocument}{\param{const wxString\& }{filename}}
|
||||
|
||||
@ -265,7 +265,7 @@ unmodified; otherwise, an error message box is displayed. The document's
|
||||
views are notified that the filename has changed, to give windows an opportunity
|
||||
to update their titles. All of the document's views are then updated.
|
||||
|
||||
\membersection{wxDocument::OnSaveDocument}
|
||||
\membersection{wxDocument::OnSaveDocument}\label{wxdocumentonsavedocument}
|
||||
|
||||
\func{virtual bool}{OnSaveDocument}{\param{const wxString\& }{filename}}
|
||||
|
||||
@ -273,7 +273,7 @@ Constructs an output file stream for the given filename (which must not be empty
|
||||
and calls SaveObject. If SaveObject returns true, the document is set to
|
||||
unmodified; otherwise, an error message box is displayed.
|
||||
|
||||
\membersection{wxDocument::OnSaveModified}
|
||||
\membersection{wxDocument::OnSaveModified}\label{wxdocumentonsavemodified}
|
||||
|
||||
\func{virtual bool}{OnSaveModified}{\void}
|
||||
|
||||
@ -282,26 +282,26 @@ be changed. If the user replies Yes, the Save function is called. If No, the
|
||||
document is marked as unmodified and the function succeeds. If Cancel, the
|
||||
function fails.
|
||||
|
||||
\membersection{wxDocument::RemoveView}
|
||||
\membersection{wxDocument::RemoveView}\label{wxdocumentremoveview}
|
||||
|
||||
\func{virtual bool}{RemoveView}{\param{wxView* }{view}}
|
||||
|
||||
Removes the view from the document's list of views, and calls OnChangedViewList.
|
||||
|
||||
\membersection{wxDocument::Save}
|
||||
\membersection{wxDocument::Save}\label{wxdocumentsave}
|
||||
|
||||
\func{virtual bool}{Save}{\void}
|
||||
|
||||
Saves the document by calling OnSaveDocument if there is an associated filename,
|
||||
or SaveAs if there is no filename.
|
||||
|
||||
\membersection{wxDocument::SaveAs}
|
||||
\membersection{wxDocument::SaveAs}\label{wxdocumentsaveas}
|
||||
|
||||
\func{virtual bool}{SaveAs}{\void}
|
||||
|
||||
Prompts the user for a file to save to, and then calls OnSaveDocument.
|
||||
|
||||
\membersection{wxDocument::SaveObject}
|
||||
\membersection{wxDocument::SaveObject}\label{wxdocumentsaveobject}
|
||||
|
||||
\func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
|
||||
|
||||
@ -314,7 +314,7 @@ automatically when the document contents need to be saved.
|
||||
Note that only one of these forms exists, depending on how wxWidgets
|
||||
was configured.
|
||||
|
||||
\membersection{wxDocument::SetCommandProcessor}
|
||||
\membersection{wxDocument::SetCommandProcessor}\label{wxdocumentsetcommandprocessor}
|
||||
|
||||
\func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
|
||||
|
||||
@ -324,20 +324,20 @@ instead.
|
||||
|
||||
See \helpref{wxCommandProcessor}{wxcommandprocessor}.
|
||||
|
||||
\membersection{wxDocument::SetDocumentName}
|
||||
\membersection{wxDocument::SetDocumentName}\label{wxdocumentsetdocumentname}
|
||||
|
||||
\func{void}{SetDocumentName}{\param{const wxString\& }{name}}
|
||||
|
||||
Sets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
|
||||
|
||||
\membersection{wxDocument::SetDocumentTemplate}
|
||||
\membersection{wxDocument::SetDocumentTemplate}\label{wxdocumentsetdocumenttemplate}
|
||||
|
||||
\func{void}{SetDocumentTemplate}{\param{wxDocTemplate* }{templ}}
|
||||
|
||||
Sets the pointer to the template that created the document. Should only be called by the
|
||||
framework.
|
||||
|
||||
\membersection{wxDocument::SetFilename}
|
||||
\membersection{wxDocument::SetFilename}\label{wxdocumentsetfilename}
|
||||
|
||||
\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = false}}
|
||||
|
||||
@ -345,7 +345,7 @@ Sets the filename for this document. Usually called by the framework.
|
||||
|
||||
If {\it notifyViews} is true, wxView::OnChangeFilename is called for all views.
|
||||
|
||||
\membersection{wxDocument::SetTitle}
|
||||
\membersection{wxDocument::SetTitle}\label{wxdocumentsettitle}
|
||||
|
||||
\func{void}{SetTitle}{\param{const wxString\& }{title}}
|
||||
|
||||
|
||||
@ -34,26 +34,26 @@ function that takes a wxDropFilesEvent argument.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxDropFilesEvent::wxDropFilesEvent}
|
||||
\membersection{wxDropFilesEvent::wxDropFilesEvent}\label{wxdropfileseventctor}
|
||||
|
||||
\func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
|
||||
\param{wxString* }{files = NULL}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxDropFilesEvent::m\_files}
|
||||
\membersection{wxDropFilesEvent::m\_files}\label{wxdropfileseventmfiles}
|
||||
|
||||
\member{wxString*}{m\_files}
|
||||
|
||||
An array of filenames.
|
||||
|
||||
\membersection{wxDropFilesEvent::m\_noFiles}
|
||||
\membersection{wxDropFilesEvent::m\_noFiles}\label{wxdropfileseventmnofiles}
|
||||
|
||||
\member{int}{m\_noFiles}
|
||||
|
||||
The number of files dropped.
|
||||
|
||||
\membersection{wxDropFilesEvent::m\_pos}
|
||||
\membersection{wxDropFilesEvent::m\_pos}\label{wxdropfileseventmpos}
|
||||
|
||||
\member{wxPoint}{m\_pos}
|
||||
|
||||
|
||||
@ -43,13 +43,13 @@ the event handler.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxEraseEvent::wxEraseEvent}
|
||||
\membersection{wxEraseEvent::wxEraseEvent}\label{wxeraseeventctor}
|
||||
|
||||
\func{}{wxEraseEvent}{\param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxEraseEvent::m\_dc}
|
||||
\membersection{wxEraseEvent::m\_dc}\label{wxeraseeventmdc}
|
||||
|
||||
\member{wxDC*}{m\_dc}
|
||||
|
||||
|
||||
@ -24,32 +24,32 @@ For more information about events, see the \helpref{Event handling overview}{eve
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxEvent::wxEvent}
|
||||
\membersection{wxEvent::wxEvent}\label{wxeventctor}
|
||||
|
||||
\func{}{wxEvent}{\param{int }{id = 0}, \param{wxEventType }{eventType = {\tt wxEVT\_NULL}}}
|
||||
|
||||
Constructor. Should not need to be used directly by an application.
|
||||
|
||||
\membersection{wxEvent::m\_eventObject}
|
||||
\membersection{wxEvent::m\_eventObject}\label{wxeventmeventobject}
|
||||
|
||||
\member{wxObject*}{m\_eventObject}
|
||||
|
||||
The object (usually a window) that the event was generated from,
|
||||
or should be sent to.
|
||||
|
||||
\membersection{wxEvent::m\_eventType}
|
||||
\membersection{wxEvent::m\_eventType}\label{wxeventmeventtype}
|
||||
|
||||
\member{WXTYPE}{m\_eventType}
|
||||
|
||||
The type of the event, such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
|
||||
|
||||
\membersection{wxEvent::m\_id}
|
||||
\membersection{wxEvent::m\_id}\label{wxeventmid}
|
||||
|
||||
\member{int}{m\_id}
|
||||
|
||||
Identifier for the window.
|
||||
|
||||
\membersection{wxEvent::m\_propagationLevel}
|
||||
\membersection{wxEvent::m\_propagationLevel}\label{wxeventmpropagationlevel}
|
||||
|
||||
\member{int}{m\_propagationLevel}
|
||||
|
||||
@ -68,13 +68,13 @@ Any positive number means that the event should be propagated but no more than
|
||||
the given number of times. E.g. the propagation level may be set to $1$ to
|
||||
propagate the event to its parent only, but not to its grandparent.
|
||||
|
||||
\membersection{wxEvent::m\_skipped}
|
||||
\membersection{wxEvent::m\_skipped}\label{wxeventmskipped}
|
||||
|
||||
\member{bool}{m\_skipped}
|
||||
|
||||
Set to true by {\bf Skip} if this event should be skipped.
|
||||
|
||||
\membersection{wxEvent::m\_timeStamp}
|
||||
\membersection{wxEvent::m\_timeStamp}\label{wxeventmtimestamp}
|
||||
|
||||
\member{long}{m\_timeStamp}
|
||||
|
||||
@ -101,33 +101,33 @@ a new event (call it MyEvent) and then define the Clone function like this:
|
||||
wxEvent *Clone(void) const { return new MyEvent(*this); }
|
||||
\end{verbatim}
|
||||
|
||||
\membersection{wxEvent::GetEventObject}
|
||||
\membersection{wxEvent::GetEventObject}\label{wxeventgeteventobject}
|
||||
|
||||
\func{wxObject*}{GetEventObject}{\void}
|
||||
|
||||
Returns the object associated with the
|
||||
event, if any.
|
||||
|
||||
\membersection{wxEvent::GetEventType}
|
||||
\membersection{wxEvent::GetEventType}\label{wxeventgeteventtype}
|
||||
|
||||
\func{WXTYPE}{GetEventType}{\void}
|
||||
|
||||
Returns the identifier of the given event type,
|
||||
such as wxEVENT\_TYPE\_BUTTON\_COMMAND.
|
||||
|
||||
\membersection{wxEvent::GetId}
|
||||
\membersection{wxEvent::GetId}\label{wxeventgetid}
|
||||
|
||||
\constfunc{int}{GetId}{\void}
|
||||
|
||||
Returns the identifier associated with this event, such as a button command id.
|
||||
|
||||
\membersection{wxEvent::GetSkipped}
|
||||
\membersection{wxEvent::GetSkipped}\label{wxeventgetskipped}
|
||||
|
||||
\constfunc{bool}{GetSkipped}{\void}
|
||||
|
||||
Returns true if the event handler should be skipped, false otherwise.
|
||||
|
||||
\membersection{wxEvent::GetTimestamp}
|
||||
\membersection{wxEvent::GetTimestamp}\label{wxeventgettimestamp}
|
||||
|
||||
\func{long}{GetTimestamp}{\void}
|
||||
|
||||
@ -150,25 +150,25 @@ Sets the propagation level to the given value (for example returned from an
|
||||
earlier call to \helpref{StopPropagation}{wxeventstoppropagation}).
|
||||
|
||||
|
||||
\membersection{wxEvent::SetEventObject}
|
||||
\membersection{wxEvent::SetEventObject}\label{wxeventseteventobject}
|
||||
|
||||
\func{void}{SetEventObject}{\param{wxObject* }{object}}
|
||||
|
||||
Sets the originating object.
|
||||
|
||||
\membersection{wxEvent::SetEventType}
|
||||
\membersection{wxEvent::SetEventType}\label{wxeventseteventtype}
|
||||
|
||||
\func{void}{SetEventType}{\param{WXTYPE }{typ}}
|
||||
|
||||
Sets the event type.
|
||||
|
||||
\membersection{wxEvent::SetId}
|
||||
\membersection{wxEvent::SetId}\label{wxeventsetid}
|
||||
|
||||
\func{void}{SetId}{\param{int}{ id}}
|
||||
|
||||
Sets the identifier associated with this event, such as a button command id.
|
||||
|
||||
\membersection{wxEvent::SetTimestamp}
|
||||
\membersection{wxEvent::SetTimestamp}\label{wxeventsettimestamp}
|
||||
|
||||
\func{void}{SetTimestamp}{\param{long }{timeStamp}}
|
||||
|
||||
|
||||
@ -24,13 +24,13 @@ will be identical to the "this" pointer for the wxEvtHandler portion.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxEvtHandler::wxEvtHandler}
|
||||
\membersection{wxEvtHandler::wxEvtHandler}\label{wxevthandlerctor}
|
||||
|
||||
\func{}{wxEvtHandler}{\void}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxEvtHandler::\destruct{wxEvtHandler}}
|
||||
\membersection{wxEvtHandler::\destruct{wxEvtHandler}}\label{wxevthandlerdtor}
|
||||
|
||||
\func{}{\destruct{wxEvtHandler}}{\void}
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ None.
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxFFile::wxFFile}\label{wxffileconstr}
|
||||
\membersection{wxFFile::wxFFile}\label{wxffilector}
|
||||
|
||||
\func{}{wxFFile}{\void}
|
||||
|
||||
@ -64,7 +64,7 @@ for the text files.}
|
||||
\docparam{fp}{An existing file descriptor, such as stderr.}
|
||||
|
||||
|
||||
\membersection{wxFFile::\destruct{wxFFile}}
|
||||
\membersection{wxFFile::\destruct{wxFFile}}\label{wxffiledtor}
|
||||
|
||||
\func{}{\destruct{wxFFile}}{\void}
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ can seek beyond the end of the stream (file) and will thus not return
|
||||
% ----------
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFFileInputStream::wxFFileInputStream}
|
||||
\membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
|
||||
|
||||
\func{}{wxFFileInputStream}{\param{const wxString\&}{ ifileName}}
|
||||
|
||||
@ -50,13 +50,13 @@ Initializes a file stream in read-only mode using the file I/O object {\it file}
|
||||
|
||||
Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
|
||||
|
||||
\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}
|
||||
\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}\label{wxffileinputstreamdtor}
|
||||
|
||||
\func{}{\destruct{wxFFileInputStream}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxFFileInputStream::Ok}
|
||||
\membersection{wxFFileInputStream::Ok}\label{wxffileinputstreamok}
|
||||
|
||||
\constfunc{bool}{Ok}{\void}
|
||||
|
||||
@ -100,7 +100,7 @@ can seek beyond the end of the stream (file) and will thus not return
|
||||
% ----------
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFFileOutputStream::wxFFileOutputStream}
|
||||
\membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
|
||||
|
||||
\func{}{wxFFileOutputStream}{\param{const wxString\&}{ ofileName}}
|
||||
|
||||
@ -115,13 +115,13 @@ Initializes a file stream in write-only mode using the file I/O object {\it file
|
||||
|
||||
Initializes a file stream in write-only mode using the file descriptor {\it fp}.
|
||||
|
||||
\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}
|
||||
\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
|
||||
|
||||
\func{}{\destruct{wxFFileOutputStream}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxFFileOutputStream::Ok}
|
||||
\membersection{wxFFileOutputStream::Ok}\label{wxffileoutputstreamok}
|
||||
|
||||
\constfunc{bool}{Ok}{\void}
|
||||
|
||||
@ -146,7 +146,7 @@ Returns true if the stream is initialized and ready.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFFileStream::wxFFileStream}
|
||||
\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
|
||||
|
||||
\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
|
||||
|
||||
|
||||
@ -86,7 +86,7 @@ mode constants used with \helpref{Seek()}{wxfileseek}:
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFile::wxFile}\label{wxfileconstr}
|
||||
\membersection{wxFile::wxFile}\label{wxfilector}
|
||||
|
||||
\func{}{wxFile}{\void}
|
||||
|
||||
@ -111,7 +111,7 @@ Associates the file with the given file descriptor, which has already been opene
|
||||
|
||||
\docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)}
|
||||
|
||||
\membersection{wxFile::\destruct{wxFile}}
|
||||
\membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor}
|
||||
|
||||
\func{}{\destruct{wxFile}}{\void}
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ is displayed as ``*.bmp'', and both
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogconstr}
|
||||
\membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogctor}
|
||||
|
||||
\func{}{wxFileDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a file"},\rtfsp
|
||||
\param{const wxString\& }{defaultDir = ""}, \param{const wxString\& }{defaultFile = ``"},\rtfsp
|
||||
@ -91,7 +91,7 @@ functionality must be implemented in the program itself now (manually remember
|
||||
the last path used and pass it to the dialog the next time it is called) or
|
||||
by using this flag.
|
||||
|
||||
\membersection{wxFileDialog::\destruct{wxFileDialog}}
|
||||
\membersection{wxFileDialog::\destruct{wxFileDialog}}\label{wxfiledialogdtor}
|
||||
|
||||
\func{}{\destruct{wxFileDialog}}{\void}
|
||||
|
||||
@ -196,7 +196,7 @@ Sets the path (the combined directory and filename that will be returned when th
|
||||
|
||||
\func{void}{SetStyle}{\param{long }{style}}
|
||||
|
||||
Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogconstr} for details.
|
||||
Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogctor} for details.
|
||||
|
||||
\membersection{wxFileDialog::SetWildcard}\label{wxfiledialogsetwildcard}
|
||||
|
||||
|
||||
@ -21,32 +21,32 @@ as well as the MDI parent frame.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFileHistory::m\_fileHistory}
|
||||
\membersection{wxFileHistory::m\_fileHistory}\label{wxfilehistorymfilehistory}
|
||||
|
||||
\member{char**}{m\_fileHistory}
|
||||
|
||||
A character array of strings corresponding to the most recently opened
|
||||
files.
|
||||
|
||||
\membersection{wxFileHistory::m\_fileHistoryN}
|
||||
\membersection{wxFileHistory::m\_fileHistoryN}\label{wxfilehistorymfilehistoryn}
|
||||
|
||||
\member{size\_t}{m\_fileHistoryN}
|
||||
|
||||
The number of files stored in the history array.
|
||||
|
||||
\membersection{wxFileHistory::m\_fileMaxFiles}
|
||||
\membersection{wxFileHistory::m\_fileMaxFiles}\label{wxfilehistorymfilemaxfiles}
|
||||
|
||||
\member{size\_t}{m\_fileMaxFiles}
|
||||
|
||||
The maximum number of files to be stored and displayed on the menu.
|
||||
|
||||
\membersection{wxFileHistory::m\_fileMenu}
|
||||
\membersection{wxFileHistory::m\_fileMenu}\label{wxfilehistorymfilemenu}
|
||||
|
||||
\member{wxMenu*}{m\_fileMenu}
|
||||
|
||||
The file menu used to display the file history list (if enabled).
|
||||
|
||||
\membersection{wxFileHistory::wxFileHistory}
|
||||
\membersection{wxFileHistory::wxFileHistory}\label{wxfilehistoryctor}
|
||||
|
||||
\func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}
|
||||
|
||||
@ -58,13 +58,13 @@ history menu item. Since menu items can't share the same ID you should change
|
||||
idBase (To one of your own defined IDs) when using more than one wxFileHistory
|
||||
in your application.
|
||||
|
||||
\membersection{wxFileHistory::\destruct{wxFileHistory}}
|
||||
\membersection{wxFileHistory::\destruct{wxFileHistory}}\label{wxfilehistorydtor}
|
||||
|
||||
\func{}{\destruct{wxFileHistory}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxFileHistory::AddFileToHistory}
|
||||
\membersection{wxFileHistory::AddFileToHistory}\label{wxfilehistoryaddfiletohistory}
|
||||
|
||||
\func{void}{AddFileToHistory}{\param{const wxString\& }{filename}}
|
||||
|
||||
@ -86,19 +86,19 @@ Appends the files in the history list, to the given menu only.
|
||||
|
||||
Returns the file at this index (zero-based).
|
||||
|
||||
\membersection{wxFileHistory::GetMaxFiles}
|
||||
\membersection{wxFileHistory::GetMaxFiles}\label{wxfilehistorygetmaxfiles}
|
||||
|
||||
\constfunc{size\_t}{GetMaxFiles}{\void}
|
||||
|
||||
Returns the maximum number of files that can be stored.
|
||||
|
||||
\membersection{wxFileHistory::GetNoHistoryFiles}
|
||||
\membersection{wxFileHistory::GetNoHistoryFiles}\label{wxfilehistorygetnohistoryfiles}
|
||||
|
||||
\constfunc{size\_t}{GetNoHistoryFiles}{\void}
|
||||
|
||||
Returns the number of files currently stored in the file history.
|
||||
|
||||
\membersection{wxFileHistory::Load}
|
||||
\membersection{wxFileHistory::Load}\label{wxfilehistoryload}
|
||||
|
||||
\func{void}{Load}{\param{wxConfigBase\& }{config}}
|
||||
|
||||
@ -108,13 +108,13 @@ Loads the file history from the given config object. This function should be cal
|
||||
|
||||
\helpref{wxConfig}{wxconfigbase}
|
||||
|
||||
\membersection{wxFileHistory::RemoveMenu}
|
||||
\membersection{wxFileHistory::RemoveMenu}\label{wxfilehistoryremovemenu}
|
||||
|
||||
\func{void}{RemoveMenu}{\param{wxMenu* }{menu}}
|
||||
|
||||
Removes this menu from the list of those managed by this object.
|
||||
|
||||
\membersection{wxFileHistory::Save}
|
||||
\membersection{wxFileHistory::Save}\label{wxfilehistorysave}
|
||||
|
||||
\func{void}{Save}{\param{wxConfigBase\& }{config}}
|
||||
|
||||
@ -125,7 +125,7 @@ explicitly by the application.
|
||||
|
||||
\helpref{wxConfig}{wxconfigbase}
|
||||
|
||||
\membersection{wxFileHistory::UseMenu}
|
||||
\membersection{wxFileHistory::UseMenu}\label{wxfilehistoryusemenu}
|
||||
|
||||
\func{void}{UseMenu}{\param{wxMenu* }{menu}}
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ can seek beyond the end of the stream (file) and will thus not return
|
||||
% ----------
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFileInputStream::wxFileInputStream}
|
||||
\membersection{wxFileInputStream::wxFileInputStream}\label{wxfileinputstreamctor}
|
||||
|
||||
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
|
||||
|
||||
@ -47,13 +47,13 @@ Initializes a file stream in read-only mode using the file I/O object {\it file}
|
||||
|
||||
Initializes a file stream in read-only mode using the specified file descriptor.
|
||||
|
||||
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
|
||||
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}\label{wxfileinputstreamdtor}
|
||||
|
||||
\func{}{\destruct{wxFileInputStream}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxFileInputStream::Ok}
|
||||
\membersection{wxFileInputStream::Ok}\label{wxfileinputstreamok}
|
||||
|
||||
\constfunc{bool}{Ok}{\void}
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ can seek beyond the end of the stream (file) and will thus not return
|
||||
% ----------
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFileOutputStream::wxFileOutputStream}
|
||||
\membersection{wxFileOutputStream::wxFileOutputStream}\label{wxfileoutputstreamctor}
|
||||
|
||||
\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
|
||||
|
||||
@ -51,13 +51,13 @@ Initializes a file stream in write-only mode using the file I/O object {\it file
|
||||
|
||||
Initializes a file stream in write-only mode using the file descriptor {\it fd}.
|
||||
|
||||
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
|
||||
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}\label{wxfileoutputstreamdtor}
|
||||
|
||||
\func{}{\destruct{wxFileOutputStream}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxFileOutputStream::Ok}
|
||||
\membersection{wxFileOutputStream::Ok}\label{wxfileoutputstreamok}
|
||||
|
||||
\constfunc{bool}{Ok}{\void}
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFileStream::wxFileStream}
|
||||
\membersection{wxFileStream::wxFileStream}\label{wxfilestreamctor}
|
||||
|
||||
\func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ differs and it is documented below.
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
\membersection{wxFilterInputStream::wxFilterInputStream}
|
||||
\membersection{wxFilterInputStream::wxFilterInputStream}\label{wxfilterinputstreamctor}
|
||||
|
||||
\func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ differs and it is documented below.
|
||||
% -----------
|
||||
% ctor & dtor
|
||||
% -----------
|
||||
\membersection{wxFilterOutputStream::wxFilterOutputStream}
|
||||
\membersection{wxFilterOutputStream::wxFilterOutputStream}\label{wxfilteroutputstreamctor}
|
||||
|
||||
\func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ function that takes a wxFocusEvent argument.
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxFocusEvent::wxFocusEvent}
|
||||
\membersection{wxFocusEvent::wxFocusEvent}\label{wxfocuseventctor}
|
||||
|
||||
\func{}{wxFocusEvent}{\param{WXTYPE }{eventType = 0}, \param{int }{id = 0}}
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ You can retrieve the current system font settings with \helpref{wxSystemSettings
|
||||
\wxheading{Constants}
|
||||
|
||||
The possible values for the \arg{family} parameter of \helpref{wxFont
|
||||
constructor}{wxfontconstr} are (the old names are for compatibility only):
|
||||
constructor}{wxfontctor} are (the old names are for compatibility only):
|
||||
|
||||
\begin{verbatim}
|
||||
enum wxFontFamily
|
||||
@ -146,7 +146,7 @@ wxSWISS\_FONT}
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{wxFont::wxFont}\label{wxfontconstr}
|
||||
\membersection{wxFont::wxFont}\label{wxfontctor}
|
||||
|
||||
\func{}{wxFont}{\void}
|
||||
|
||||
@ -218,7 +218,7 @@ See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdraw
|
||||
and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.
|
||||
|
||||
|
||||
\membersection{wxFont::\destruct{wxFont}}
|
||||
\membersection{wxFont::\destruct{wxFont}}\label{wxfontdtor}
|
||||
|
||||
\func{}{\destruct{wxFont}}{\void}
|
||||
|
||||
@ -271,7 +271,7 @@ typeface information.
|
||||
|
||||
\constfunc{int}{GetFamily}{\void}
|
||||
|
||||
Gets the font family. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
|
||||
Gets the font family. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
|
||||
family identifiers.
|
||||
|
||||
\wxheading{See also}
|
||||
@ -306,7 +306,7 @@ Gets the point size.
|
||||
|
||||
\constfunc{int}{GetStyle}{\void}
|
||||
|
||||
Gets the font style. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
|
||||
Gets the font style. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
|
||||
styles.
|
||||
|
||||
\wxheading{See also}
|
||||
@ -329,7 +329,7 @@ Returns true if the font is underlined, false otherwise.
|
||||
|
||||
\constfunc{int}{GetWeight}{\void}
|
||||
|
||||
Gets the font weight. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
|
||||
Gets the font weight. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
|
||||
weight identifiers.
|
||||
|
||||
\wxheading{See also}
|
||||
@ -356,7 +356,7 @@ weight identifiers.
|
||||
\param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
|
||||
|
||||
These functions take the same parameters as \helpref{wxFont
|
||||
constructor}{wxfontconstr} and return a new font object allocated on the heap.
|
||||
constructor}{wxfontctor} and return a new font object allocated on the heap.
|
||||
|
||||
Using \texttt{New()} is currently the only way to directly create a font with
|
||||
the given size in pixels on platforms other than wxMSW.
|
||||
|
||||
@ -40,7 +40,7 @@ Used by wxWidgets to add a font to the list, called in the font constructor.
|
||||
\func{wxFont *}{FindOrCreateFont}{\param{int}{ point\_size}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, \param{bool}{ underline = false},
|
||||
\param{const wxString\& }{facename = NULL}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}{}}
|
||||
|
||||
Finds a font of the given specification, or creates one and adds it to the list. See the \helpref{wxFont constructor}{wxfontconstr} for
|
||||
Finds a font of the given specification, or creates one and adds it to the list. See the \helpref{wxFont constructor}{wxfontctor} for
|
||||
details of the arguments.
|
||||
|
||||
\membersection{wxFontList::RemoveFont}\label{wxfontlistremovefont}
|
||||
|
||||
@ -270,7 +270,7 @@ only forward scrolling cursors, or forward and backward scrolling cursors
|
||||
(see the section in "WHERE TO START" on cursors for more information on
|
||||
cursors). This default can be overridden by passing a second parameter to
|
||||
either the \helpref{wxDbGetConnection}{wxdbfunctions} or
|
||||
\helpref{wxDb constructor}{wxdbconstr}. The default is 1.}
|
||||
\helpref{wxDb constructor}{wxdbctor}. The default is 1.}
|
||||
\twocolitem{wxODBC\_BACKWARD\_COMPATABILITY}{Between v2.0 and 2.2, massive
|
||||
renaming efforts were done to the ODBC classes to get naming conventions
|
||||
similar to those used throughout wxWidgets, as well as to preface all wxODBC
|
||||
|
||||
Loading…
Reference in New Issue
Block a user