Added 'Include files' section to class references
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -6,7 +6,13 @@ The functions defined in wxWindows are described here.
|
||||
|
||||
\section{File functions}\label{filefunctions}
|
||||
|
||||
See also \helpref{wxPathList}{wxpathlist}.
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\wxheading{See also}
|
||||
|
||||
\helpref{wxPathList}{wxpathlist}
|
||||
|
||||
\membersection{::wxDirExists}
|
||||
|
||||
@@ -332,6 +338,10 @@ if (s)
|
||||
Remember that the returned pointer is temporary and should be copied
|
||||
if other wxWindows calls will be made before the value is to be used.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/filedlg.h>
|
||||
|
||||
\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
|
||||
|
||||
\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
|
||||
@@ -345,6 +355,10 @@ or press Cancel to return NULL.
|
||||
If {\it centre} is TRUE, the message text (which may include new line characters)
|
||||
is centred; if FALSE, the message is left-justified.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/textdlg.h>
|
||||
|
||||
\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
|
||||
|
||||
\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
|
||||
@@ -367,6 +381,10 @@ If Cancel is pressed, -1 is returned.
|
||||
If {\it centre} is TRUE, the message text (which may include new line characters)
|
||||
is centred; if FALSE, the message is left-justified.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/choicdlg.h>
|
||||
|
||||
\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
|
||||
|
||||
\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
|
||||
@@ -382,6 +400,10 @@ Cancel to return NULL.
|
||||
If {\it centre} is TRUE, the message text (which may include new line characters)
|
||||
is centred; if FALSE, the message is left-justified.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/choicdlg.h>
|
||||
|
||||
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
|
||||
|
||||
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
|
||||
@@ -391,6 +413,10 @@ is centred; if FALSE, the message is left-justified.
|
||||
As {\bf wxGetSingleChoice} but returns the index representing the selected string.
|
||||
If the user pressed cancel, -1 is returned.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/choicdlg.h>
|
||||
|
||||
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
|
||||
|
||||
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
|
||||
@@ -400,6 +426,10 @@ If the user pressed cancel, -1 is returned.
|
||||
As {\bf wxGetSingleChoice} but takes an array of client data pointers
|
||||
corresponding to the strings, and returns one of these pointers.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/choicdlg.h>
|
||||
|
||||
\membersection{::wxMessageBox}\label{wxmessagebox}
|
||||
|
||||
\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
|
||||
@@ -442,10 +472,18 @@ is specified in the style, in which case a generic function is used.
|
||||
This is because the native MessageBox function cannot centre text.
|
||||
The symbols are not shown when the generic function is used.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/msgdlg.h>
|
||||
|
||||
\section{GDI functions}\label{gdifunctions}
|
||||
|
||||
The following are relevant to the GDI (Graphics Device Interface).
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/gdicmn.h>
|
||||
|
||||
\membersection{::wxColourDisplay}
|
||||
|
||||
\func{bool}{wxColourDisplay}{\void}
|
||||
@@ -498,6 +536,10 @@ See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowset
|
||||
The following functions are used to control PostScript printing. Under
|
||||
Windows, PostScript output can only be sent to a file.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/dcps.h>
|
||||
|
||||
\membersection{::wxGetPrinterCommand}
|
||||
|
||||
\func{wxString}{wxGetPrinterCommand}{\void}
|
||||
@@ -600,6 +642,10 @@ Sets the translation (from the top left corner) for PostScript output. The defau
|
||||
|
||||
These clipboard functions are implemented for Windows only.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/clipbrd.h>
|
||||
|
||||
\membersection{::wxClipboardOpen}
|
||||
|
||||
\func{bool}{wxClipboardOpen}{\void}
|
||||
@@ -697,19 +743,27 @@ The clipboard must have previously been opened for this call to succeed.
|
||||
|
||||
\section{Miscellaneous functions}\label{miscellany}
|
||||
|
||||
\membersection{::NewId}
|
||||
\membersection{::wxNewId}
|
||||
|
||||
\func{long}{NewId}{\void}
|
||||
\func{long}{wxNewId}{\void}
|
||||
|
||||
Generates an integer identifier unique to this run of the program.
|
||||
|
||||
\membersection{::RegisterId}
|
||||
\wxheading{Include files}
|
||||
|
||||
\func{void}{RegisterId}{\param{long}{ id}}
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxRegisterId}
|
||||
|
||||
\func{void}{wxRegisterId}{\param{long}{ id}}
|
||||
|
||||
Ensures that ids subsequently generated by {\bf NewId} do not clash with
|
||||
the given {\bf id}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
|
||||
|
||||
\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
|
||||
@@ -721,20 +775,19 @@ ensures that only the outer calls take effect.
|
||||
|
||||
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxBell}
|
||||
|
||||
\func{void}{wxBell}{\void}
|
||||
|
||||
Ring the system bell.
|
||||
|
||||
\membersection{::wxCleanUp}\label{wxcleanup}
|
||||
\wxheading{Include files}
|
||||
|
||||
\func{void}{wxCleanUp}{\void}
|
||||
|
||||
Normally, wxWindows will call this cleanup function for you. However, if
|
||||
you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
|
||||
manually, then you should also call wxCleanUp before terminating wxWindows,
|
||||
if wxWindows does not get a chance to do it.
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
|
||||
|
||||
@@ -752,6 +805,10 @@ called by the application.
|
||||
|
||||
See also helpref{wxDDEInitialize}{wxddeinitialize}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/dde.h>
|
||||
|
||||
\membersection{::wxDDEInitialize}\label{wxddeinitialize}
|
||||
|
||||
\func{void}{wxDDEInitialize}{\void}
|
||||
@@ -764,6 +821,10 @@ by wxWindows if necessary.
|
||||
See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
|
||||
\helpref{wxDDECleanUp}{wxddecleanup}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/dde.h>
|
||||
|
||||
\membersection{::wxDebugMsg}\label{wxdebugmsg}
|
||||
|
||||
\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
|
||||
@@ -787,18 +848,26 @@ instead.
|
||||
|
||||
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxDisplaySize}
|
||||
|
||||
\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
|
||||
|
||||
Gets the physical size of the display in pixels.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/gdicmn.h>
|
||||
|
||||
\membersection{::wxEntry}\label{wxentry}
|
||||
|
||||
This initializes wxWindows in a platform-dependent way. Use this if you
|
||||
are not using the default wxWindows entry code (e.g. main or WinMain). For example,
|
||||
you can initialize wxWindows from an Microsoft Foundation Classes application using
|
||||
this function. See also \helpref{wxCleanUp}{wxcleanup}.
|
||||
this function.
|
||||
|
||||
\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
|
||||
\param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
|
||||
@@ -816,6 +885,26 @@ wxWindows initialization under Windows (for applications constructed as a DLL).
|
||||
|
||||
wxWindows initialization under Unix.
|
||||
|
||||
\wxheading{Remarks}
|
||||
|
||||
To clean up wxWindows, call wxApp::OnExit followed by the static function
|
||||
wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
|
||||
|
||||
\begin{verbatim}
|
||||
int CTheApp::ExitInstance()
|
||||
{
|
||||
// OnExit isn't called by CleanUp so must be called explicitly.
|
||||
wxTheApp->OnExit();
|
||||
wxApp::CleanUp();
|
||||
|
||||
return CWinApp::ExitInstance();
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/app.h>
|
||||
|
||||
\membersection{::wxError}\label{wxerror}
|
||||
|
||||
\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
|
||||
@@ -824,6 +913,10 @@ Displays {\it msg} and continues. This writes to standard error under
|
||||
Unix, and pops up a message box under Windows. Used for internal
|
||||
wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
|
||||
|
||||
\func{void}{wxEndBusyCursor}{\void}
|
||||
@@ -833,6 +926,10 @@ Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
|
||||
|
||||
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxExecute}\label{wxexecute}
|
||||
|
||||
\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
|
||||
@@ -859,6 +956,10 @@ the process finishes.
|
||||
|
||||
See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxExit}\label{wxexit}
|
||||
|
||||
\func{void}{wxExit}{\void}
|
||||
@@ -868,6 +969,10 @@ Should only be used in an emergency: normally the top-level frame
|
||||
should be deleted (after deleting all other frames) to terminate the
|
||||
application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/app.h>
|
||||
|
||||
\membersection{::wxFatalError}\label{wxfatalerror}
|
||||
|
||||
\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
|
||||
@@ -876,12 +981,20 @@ Displays {\it msg} and exits. This writes to standard error under Unix,
|
||||
and pops up a message box under Windows. Used for fatal internal
|
||||
wxWindows errors. See also \helpref{wxError}{wxerror}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxFindMenuItemId}
|
||||
|
||||
\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
|
||||
|
||||
Find a menu item identifier associated with the given frame's menu bar.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxFindWindowByLabel}
|
||||
|
||||
\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
|
||||
@@ -891,6 +1004,10 @@ or panel item label. If {\it parent} is NULL, the search will start from all top
|
||||
frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
|
||||
The search is recursive in both cases.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
|
||||
|
||||
\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
|
||||
@@ -902,24 +1019,40 @@ The search is recursive in both cases.
|
||||
|
||||
If no such named window is found, {\bf wxFindWindowByLabel} is called.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
|
||||
|
||||
\func{wxWindow *}{wxGetActiveWindow}{\void}
|
||||
|
||||
Gets the currently active window (Windows only).
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/windows.h>
|
||||
|
||||
\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
|
||||
|
||||
\func{wxString}{wxGetDisplayName}{\void}
|
||||
|
||||
Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetHomeDir}
|
||||
|
||||
\func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
|
||||
|
||||
Fills the buffer with a string representing the user's home directory (Unix only).
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetHostName}
|
||||
|
||||
\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
|
||||
@@ -929,6 +1062,10 @@ buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
|
||||
successful. Under Unix, this will return a machine name. Under Windows,
|
||||
this returns ``windows''.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
|
||||
|
||||
\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
|
||||
@@ -940,6 +1077,10 @@ by this call.
|
||||
|
||||
See also \helpref{wxTimer}{wxtimer}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/timer.h>
|
||||
|
||||
\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
|
||||
|
||||
\func{long}{wxGetFreeMemory}{\void}
|
||||
@@ -948,12 +1089,20 @@ Returns the amount of free memory in Kbytes under environments which
|
||||
support it, and -1 if not supported. Currently, returns a positive value
|
||||
under Windows, and -1 under Unix.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetMousePosition}
|
||||
|
||||
\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
|
||||
|
||||
Returns the mouse position in screen coordinates.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetOsVersion}
|
||||
|
||||
\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
|
||||
@@ -973,6 +1122,10 @@ Gets operating system version information.
|
||||
\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
|
||||
\end{twocollist}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetResource}\label{wxgetresource}
|
||||
|
||||
\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
|
||||
@@ -1003,6 +1156,10 @@ the overloading of the function for different types.
|
||||
|
||||
See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetUserId}
|
||||
|
||||
\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
|
||||
@@ -1011,6 +1168,10 @@ Copies the user's login identity (such as ``jacs'') into the buffer {\it
|
||||
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
|
||||
Under Windows, this returns ``user''.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxGetUserName}
|
||||
|
||||
\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
|
||||
@@ -1019,6 +1180,10 @@ Copies the user's name (such as ``Julian Smart'') into the buffer {\it
|
||||
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
|
||||
Under Windows, this returns ``unknown''.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxKill}\label{wxkill}
|
||||
|
||||
\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
|
||||
@@ -1029,12 +1194,9 @@ Returns 0 on success, -1 on failure.
|
||||
Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
|
||||
It does not raise a signal in the receiving process.
|
||||
|
||||
\membersection{::wxInitClipboard}\label{wxinitclipboard}
|
||||
\wxheading{Include files}
|
||||
|
||||
\func{void}{wxInitClipboard}{\void}
|
||||
|
||||
Initializes the generic clipboard system by creating an instance of
|
||||
the class \helpref{wxClipboard}{wxclipboard}.
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxIsBusy}\label{wxisbusy}
|
||||
|
||||
@@ -1045,6 +1207,10 @@ Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\r
|
||||
|
||||
See also \helpref{wxBusyCursor}{wxbusycursor}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxLoadUserResource}\label{wxloaduserresource}
|
||||
|
||||
\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
|
||||
@@ -1066,23 +1232,35 @@ using \helpref{wxResourceParseString}{wxresourceparsestring}.
|
||||
|
||||
This function is available under Windows only.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxNow}\label{wxnow}
|
||||
|
||||
\func{wxString}{wxNow}{\void}
|
||||
|
||||
Returns a string representing the current date and time.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxPostDelete}\label{wxpostdelete}
|
||||
|
||||
\func{void}{wxPostDelete}{\param{wxObject *}{object}}
|
||||
|
||||
Under X, tells the system to delete the specified object when
|
||||
Tells the system to delete the specified object when
|
||||
all other events have been processed. In some environments, it is
|
||||
necessary to use this instead of deleting a frame directly with the
|
||||
delete operator, because X will still send events to the window.
|
||||
delete operator, because some GUIs will still send events to a deleted window.
|
||||
|
||||
Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
|
||||
|
||||
\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
|
||||
@@ -1094,6 +1272,10 @@ displays to be used.
|
||||
|
||||
See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxShell}\label{wxshell}
|
||||
|
||||
\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
|
||||
@@ -1103,12 +1285,20 @@ specified, then just the shell is spawned.
|
||||
|
||||
See also \helpref{wxExecute}{wxexecute}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxSleep}\label{wxsleep}
|
||||
|
||||
\func{void}{wxSleep}{\param{int}{ secs}}
|
||||
|
||||
Sleeps for the specified number of seconds.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxStripMenuCodes}
|
||||
|
||||
\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
|
||||
@@ -1121,6 +1311,10 @@ in {\it out} (or returns the new string, in the first form).
|
||||
Menu codes include \& (mark the next character with an underline
|
||||
as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxStartTimer}\label{wxstarttimer}
|
||||
|
||||
\func{void}{wxStartTimer}{\void}
|
||||
@@ -1129,18 +1323,30 @@ Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get th
|
||||
|
||||
See also \helpref{wxTimer}{wxtimer}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/timer.h>
|
||||
|
||||
\membersection{::wxToLower}\label{wxtolower}
|
||||
|
||||
\func{char}{wxToLower}{\param{char }{ch}}
|
||||
|
||||
Converts the character to lower case. This is implemented as a macro for efficiency.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxToUpper}\label{wxtoupper}
|
||||
|
||||
\func{char}{wxToUpper}{\param{char }{ch}}
|
||||
|
||||
Converts the character to upper case. This is implemented as a macro for efficiency.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxTrace}\label{wxtrace}
|
||||
|
||||
\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
|
||||
@@ -1150,6 +1356,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
|
||||
|
||||
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/memory.h>
|
||||
|
||||
\membersection{::wxTraceLevel}\label{wxtracelevel}
|
||||
|
||||
\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
|
||||
@@ -1162,6 +1372,10 @@ this value.
|
||||
|
||||
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/memory.h>
|
||||
|
||||
\membersection{::wxWriteResource}\label{wxwriteresource}
|
||||
|
||||
\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
|
||||
@@ -1189,6 +1403,10 @@ file under Unix, although the WIN.INI file is fair game under Windows.
|
||||
|
||||
See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\membersection{::wxYield}
|
||||
|
||||
\func{bool}{wxYield}{\void}
|
||||
@@ -1203,6 +1421,10 @@ user to perform actions which are not compatible with the current task.
|
||||
Disabling menu items or whole menus during processing can avoid unwanted
|
||||
reentrance of code.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/utils.h>
|
||||
|
||||
\section{Macros}\label{macros}
|
||||
|
||||
These macros are defined in wxWindows.
|
||||
@@ -1213,6 +1435,10 @@ These macros are defined in wxWindows.
|
||||
|
||||
Returns a pointer to the wxClassInfo object associated with this class.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{WXDEBUG\_NEW}\label{debugnew}
|
||||
|
||||
\func{}{WXDEBUG\_NEW}{arg}
|
||||
@@ -1226,6 +1452,10 @@ with filename and line number arguments. The definition is:
|
||||
|
||||
In non-debug mode, this is defined as the normal new operator.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{DECLARE\_ABSTRACT\_CLASS}
|
||||
|
||||
\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
|
||||
@@ -1248,6 +1478,10 @@ class wxCommand: public wxObject
|
||||
};
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{DECLARE\_APP}\label{declareapp}
|
||||
|
||||
\func{}{DECLARE\_APP}{className}
|
||||
@@ -1261,6 +1495,10 @@ Example:
|
||||
DECLARE_APP(MyApp)
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/app.h>
|
||||
|
||||
\membersection{DECLARE\_CLASS}
|
||||
|
||||
\func{}{DECLARE\_CLASS}{className}
|
||||
@@ -1269,6 +1507,10 @@ Used inside a class declaration to declare that the class should be
|
||||
made known to the class hierarchy, but objects of this class cannot be created
|
||||
dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{DECLARE\_DYNAMIC\_CLASS}
|
||||
|
||||
\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
|
||||
@@ -1290,6 +1532,10 @@ class wxFrame: public wxWindow
|
||||
};
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
|
||||
|
||||
\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
|
||||
@@ -1308,6 +1554,10 @@ wxCommand::wxCommand(void)
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
|
||||
|
||||
\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
|
||||
@@ -1315,6 +1565,10 @@ wxCommand::wxCommand(void)
|
||||
Used in a C++ implementation file to complete the declaration of
|
||||
a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_APP}\label{implementapp}
|
||||
|
||||
\func{}{IMPLEMENT\_APP}{className}
|
||||
@@ -1336,6 +1590,10 @@ New form:
|
||||
|
||||
See also \helpref{DECLARE\_APP}{declareapp}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/app.h>
|
||||
|
||||
\membersection{IMPLEMENT\_CLASS}
|
||||
|
||||
\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
|
||||
@@ -1343,6 +1601,10 @@ See also \helpref{DECLARE\_APP}{declareapp}.
|
||||
Used in a C++ implementation file to complete the declaration of
|
||||
a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_CLASS2}
|
||||
|
||||
\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
|
||||
@@ -1351,6 +1613,10 @@ Used in a C++ implementation file to complete the declaration of a
|
||||
class that has run-time type information and two base classes. The
|
||||
same as IMPLEMENT\_ABSTRACT\_CLASS2.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
|
||||
|
||||
\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
|
||||
@@ -1370,6 +1636,10 @@ wxFrame::wxFrame(void)
|
||||
}
|
||||
\end{verbatim}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
|
||||
|
||||
\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
|
||||
@@ -1379,6 +1649,10 @@ a class that has run-time type information, and whose instances
|
||||
can be created dynamically. Use this for classes derived from two
|
||||
base classes.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/object.h>
|
||||
|
||||
\membersection{WXTRACE}\label{trace}
|
||||
|
||||
\func{}{WXTRACE}{formatString, ...}
|
||||
@@ -1388,6 +1662,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
|
||||
|
||||
This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/memory.h>
|
||||
|
||||
\membersection{WXTRACELEVEL}\label{tracelevel}
|
||||
|
||||
\func{}{WXTRACELEVEL}{level, formatString, ...}
|
||||
@@ -1400,6 +1678,10 @@ this value.
|
||||
|
||||
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/memory.h>
|
||||
|
||||
\section{wxWindows resource functions}\label{resourcefuncs}
|
||||
|
||||
\overview{wxWindows resource system}{resourceformats}
|
||||
@@ -1416,6 +1698,8 @@ as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminol
|
||||
See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
|
||||
loading from resource data.
|
||||
|
||||
{\bf Warning:} this needs updating for wxWindows 2.
|
||||
|
||||
\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
|
||||
|
||||
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
|
||||
@@ -1600,6 +1884,10 @@ Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
|
||||
These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
|
||||
further information.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/log.h>
|
||||
|
||||
\membersection{::wxLogError}\label{wxlogerror}
|
||||
|
||||
\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
|
||||
@@ -1693,6 +1981,10 @@ Useful macros and functins for error checking and defensive programming. ASSERTs
|
||||
compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
|
||||
builds.
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/debug.h>
|
||||
|
||||
\membersection{::wxOnAssert}\label{wxonassert}
|
||||
|
||||
\func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
|
||||
|
Reference in New Issue
Block a user