X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f29fe16932ede752589ef9ed34a757342387932f..ab9717339232a7a728dea666c59b73fd6ac78dd3:/docs/latex/wx/function.tex?ds=sidebyside diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index c5c7746ff5..5d8a4e82b6 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1,15 +1,25 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: function.tex +%% Purpose: Functions and macros +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \chapter{Functions}\label{functions} \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage} -The functions and macros defined in wxWindows are described here: you can +The functions and macros defined in wxWidgets are described here: you can either look up a function using the alphabetical listing of them or find it in the corresponding topic. -\section{Alphabetical functions and macros list} +\section{Alphabetical functions and macros list}\label{functionsalphabetically} \helpref{CLASSINFO}{classinfo}\\ -\helpref{copystring}{copystring}\\ \helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\ \helpref{DECLARE\_APP}{declareapp}\\ \helpref{DECLARE\_CLASS}{declareclass}\\ @@ -21,24 +31,27 @@ the corresponding topic. \helpref{IMPLEMENT\_CLASS}{implementclass}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\ -\helpref{ngettext}{ngettext}\\ -\helpref{wxCONCAT}{wxconcat}\\ -\helpref{WXDEBUG\_NEW}{debugnew}\\ -\helpref{WXTRACELEVEL}{tracelevel}\\ -\helpref{WXTRACE}{trace}\\ +\helpref{wxAboutBox}{wxaboutbox}\\ +\helpref{wxASSERT}{wxassert}\\ \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\ \helpref{wxASSERT\_MSG}{wxassertmsg}\\ -\helpref{wxASSERT}{wxassert}\\ -\helpref{wxBITMAP}{wxbitmapmacro}\\ +\helpref{wxAtomicDec}{wxatomicdec}\\ +\helpref{wxAtomicInc}{wxatomicinc}\\ +\helpref{wxBase64Decode}{wxbase64decode}\\ +\helpref{wxBase64Encode}{wxbase64encode}\\ \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\ \helpref{wxBell}{wxbell}\\ +\helpref{wxBITMAP}{wxbitmapmacro}\\ +\helpref{wxCHANGE\_UMASK}{wxchangeumask}\\ \helpref{wxCHECK}{wxcheck}\\ \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\ \helpref{wxCHECK2}{wxcheck2}\\ \helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}\\ \helpref{wxCHECK\_MSG}{wxcheckmsg}\\ \helpref{wxCHECK\_RET}{wxcheckret}\\ +\helpref{wxCHECK\_SUNCC\_VERSION}{wxchecksunccversion}\\ \helpref{wxCHECK\_VERSION}{wxcheckversion}\\ +\helpref{wxCHECK\_VERSION\_FULL}{wxcheckversionfull}\\ \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\ \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\ \helpref{wxClipboardOpen}{functionwxclipboardopen}\\ @@ -46,6 +59,7 @@ the corresponding topic. \helpref{wxColourDisplay}{wxcolourdisplay}\\ \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\ \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}\\ +\helpref{wxCONCAT}{wxconcat}\\ \helpref{wxConcatFiles}{wxconcatfiles}\\ \helpref{wxConstCast}{wxconstcast}\\ \helpref{wxCopyFile}{wxcopyfile}\\ @@ -59,6 +73,9 @@ the corresponding topic. \helpref{wxDDEInitialize}{wxddeinitialize}\\ \helpref{wxDROP\_ICON}{wxdropicon}\\ \helpref{wxDebugMsg}{wxdebugmsg}\\ +\helpref{WXDEBUG\_NEW}{debugnew}\\ +\helpref{wxDEPRECATED}{wxdeprecated}\\ +\helpref{wxDEPRECATED\_BUT\_USED\_INTERNALLY}{wxdeprecatedbutusedinternally}\\ \helpref{wxDirExists}{functionwxdirexists}\\ \helpref{wxDirSelector}{wxdirselector}\\ \helpref{wxDisplayDepth}{wxdisplaydepth}\\ @@ -73,6 +90,8 @@ the corresponding topic. \helpref{wxEndBusyCursor}{wxendbusycursor}\\ \helpref{wxENTER\_CRIT\_SECT}{wxentercritsect}\\ \helpref{wxEntry}{wxentry}\\ +\helpref{wxEntryStart}{wxentrystart}\\ +\helpref{wxEntryCleanup}{wxentrycleanup}\\ \helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\ \helpref{wxError}{wxerror}\\ \helpref{wxExecute}{wxexecute}\\ @@ -93,32 +112,38 @@ the corresponding topic. \helpref{wxFindWindowByLabel}{wxfindwindowbylabel}\\ \helpref{wxFindWindowByName}{wxfindwindowbyname}\\ \helpref{wxFinite}{wxfinite}\\ +\helpref{wxGenericAboutBox}{wxgenericaboutbox}\\ \helpref{wxGetActiveWindow}{wxgetactivewindow}\\ \helpref{wxGetApp}{wxgetapp}\\ +\helpref{wxGetBatteryState}{wxgetbatterystate}\\ \helpref{wxGetClipboardData}{wxgetclipboarddata}\\ \helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\ \helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\ \helpref{wxGetCwd}{wxgetcwd}\\ \helpref{wxGetDiskSpace}{wxgetdiskspace}\\ \helpref{wxGetDisplayName}{wxgetdisplayname}\\ -\helpref{wxGetElapsedTime}{wxgetelapsedtime}\\ +\helpref{wxGetDisplaySize}{wxdisplaysize}\\ +\helpref{wxGetDisplaySizeMM}{wxdisplaysizemm}\\ \helpref{wxGetEmailAddress}{wxgetemailaddress}\\ \helpref{wxGetEnv}{wxgetenv}\\ +\helpref{wxGetFileKind}{wxgetfilekind}\\ \helpref{wxGetFontFromUser}{wxgetfontfromuser}\\ \helpref{wxGetFreeMemory}{wxgetfreememory}\\ \helpref{wxGetFullHostName}{wxgetfullhostname}\\ \helpref{wxGetHomeDir}{wxgethomedir}\\ \helpref{wxGetHostName}{wxgethostname}\\ +\helpref{wxGetKeyState}{wxgetkeystate}\\ \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\ \helpref{wxGetLocalTime}{wxgetlocaltime}\\ \helpref{wxGetMousePosition}{wxgetmouseposition}\\ +\helpref{wxGetMouseState}{wxgetmousestate}\\ \helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\ -\helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\ \helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\ \helpref{wxGetOSDirectory}{wxgetosdirectory}\\ \helpref{wxGetOsDescription}{wxgetosdescription}\\ \helpref{wxGetOsVersion}{wxgetosversion}\\ \helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\ +\helpref{wxGetPowerType}{wxgetpowertype}\\ \helpref{wxGetPrinterCommand}{wxgetprintercommand}\\ \helpref{wxGetPrinterFile}{wxgetprinterfile}\\ \helpref{wxGetPrinterMode}{wxgetprintermode}\\ @@ -128,7 +153,6 @@ the corresponding topic. \helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\ \helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\ \helpref{wxGetProcessId}{wxgetprocessid}\\ -\helpref{wxGetResource}{wxgetresource}\\ \helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\ \helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\ \helpref{wxGetSingleChoice}{wxgetsinglechoice}\\ @@ -156,8 +180,12 @@ the corresponding topic. \helpref{wxIsEmpty}{wxisempty}\\ \helpref{wxIsMainThread}{wxismainthread}\\ \helpref{wxIsNaN}{wxisnan}\\ +\helpref{wxIsPlatformLittleEndian}{wxisplatformlittleendian}\\ +\helpref{wxIsPlatform64Bit}{wxisplatform64bit}\\ \helpref{wxIsWild}{wxiswild}\\ +\helpref{wxJoin}{wxjoin}\\ \helpref{wxKill}{wxkill}\\ +\helpref{wxLaunchDefaultBrowser}{wxlaunchdefaultbrowser}\\ \helpref{wxLEAVE\_CRIT\_SECT}{wxleavecritsect}\\ \helpref{wxLoadUserResource}{wxloaduserresource}\\ \helpref{wxLogDebug}{wxlogdebug}\\ @@ -174,14 +202,20 @@ the corresponding topic. \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\ \helpref{wxMatchWild}{wxmatchwild}\\ \helpref{wxMessageBox}{wxmessagebox}\\ +\helpref{wxMilliSleep}{wxmillisleep}\\ +\helpref{wxMicroSleep}{wxmicrosleep}\\ \helpref{wxMkdir}{wxmkdir}\\ \helpref{wxMutexGuiEnter}{wxmutexguienter}\\ \helpref{wxMutexGuiLeave}{wxmutexguileave}\\ \helpref{wxNewId}{wxnewid}\\ \helpref{wxNow}{wxnow}\\ \helpref{wxOnAssert}{wxonassert}\\ +\helpref{wxON\_BLOCK\_EXIT}{wxonblockexit}\\ +\helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj}\\ \helpref{wxOpenClipboard}{wxopenclipboard}\\ +\helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\ \helpref{wxPathOnly}{wxpathonly}\\ +\helpref{wxPLURAL}{wxplural}\\ \helpref{wxPostDelete}{wxpostdelete}\\ \helpref{wxPostEvent}{wxpostevent}\\ \helpref{wxRegisterClipboardFormat}{wxregisterclipboardformat}\\ @@ -209,20 +243,26 @@ the corresponding topic. \helpref{wxShutdown}{wxshutdown}\\ \helpref{wxSleep}{wxsleep}\\ \helpref{wxSnprintf}{wxsnprintf}\\ +\helpref{wxSplit}{wxsplit}\\ \helpref{wxSplitPath}{wxsplitfunction}\\ -\helpref{wxStartTimer}{wxstarttimer}\\ \helpref{wxStaticCast}{wxstaticcast}\\ \helpref{wxStrcmp}{wxstrcmp}\\ \helpref{wxStricmp}{wxstricmp}\\ \helpref{wxStringEq}{wxstringeq}\\ \helpref{wxStringMatch}{wxstringmatch}\\ +\helpref{wxStringTokenize}{wxstringtokenize}\\ \helpref{wxStripMenuCodes}{wxstripmenucodes}\\ \helpref{wxStrlen}{wxstrlen}\\ +\helpref{wxSTRINGIZE}{wxstringize}\\ +\helpref{wxSTRINGIZE\_T}{wxstringizet}\\ +\helpref{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{wxsuppressgccprivatedtorwarning}\\ \helpref{wxSysErrorCode}{wxsyserrorcode}\\ \helpref{wxSysErrorMsg}{wxsyserrormsg}\\ \helpref{wxT}{wxt}\\ -\helpref{wxTraceLevel}{wxtracelevel}\\ \helpref{wxTrace}{wxtrace}\\ +\helpref{WXTRACE}{trace}\\ +\helpref{wxTraceLevel}{wxtracelevel}\\ +\helpref{WXTRACELEVEL}{tracelevel}\\ \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\ \helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\ \helpref{wxTrap}{wxtrap}\\ @@ -231,48 +271,74 @@ the corresponding topic. \helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\ \helpref{wxUnsetEnv}{wxunsetenv}\\ \helpref{wxUsleep}{wxusleep}\\ +\helpref{wxVaCopy}{wxvacopy}\\ \helpref{wxVsnprintf}{wxvsnprintf}\\ \helpref{wxWakeUpIdle}{wxwakeupidle}\\ -\helpref{wxWriteResource}{wxwriteresource}\\ \helpref{wxYield}{wxyield}\\ \helpref{wx\_const\_cast}{wxconstcastraw}\\ +\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}\\ \helpref{wx\_static\_cast}{wxstaticcastraw}\\ +\helpref{wx\_truncate\_cast}{wxtruncatecast}\\ \helpref{\_}{underscore}\\ \helpref{\_T}{underscoret} +\helpref{\_\_WXFUNCTION\_\_}{wxfunction} \section{Version macros}\label{versionfunctions} -The following constants are defined in wxWindows: +The following constants are defined in wxWidgets: \begin{itemize}\itemsep=0pt -\item {\tt wxMAJOR\_VERSION} is the major version of wxWindows -\item {\tt wxMINOR\_VERSION} is the minor version of wxWindows +\item {\tt wxMAJOR\_VERSION} is the major version of wxWidgets +\item {\tt wxMINOR\_VERSION} is the minor version of wxWidgets \item {\tt wxRELEASE\_NUMBER} is the release number +\item {\tt wxSUBRELEASE\_NUMBER} is the subrelease number which is $0$ for all +official releases \end{itemize} -For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and +For example, the values or these constants for wxWidgets 2.1.15 are 2, 1 and 15. Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing -the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the +the full wxWidgets version and {\tt wxVERSION\_NUMBER} is a combination of the three version numbers above: for 2.1.15, it is 2115 and it is 2200 for -wxWindows 2.2. +wxWidgets 2.2. + +The subrelease number is only used for the sources in between official releases +and so normally is not useful. \wxheading{Include files} or +\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} + +\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor}} + +Returns $1$ if the compiler being used to compile the code is GNU C++ +compiler (g++) version major.minor or greater. Otherwise, and also if +the compiler is not GNU C++ at all, returns $0$. + + +\membersection{wxCHECK\_SUNCC\_VERSION}\label{wxchecksunccversion} + +\func{bool}{wxCHECK\_SUNCC\_VERSION}{\param{}{major, minor}} + +Returns $1$ if the compiler being used to compile the code is Sun CC Pro +compiler and its version is at least \texttt{major.minor}. Otherwise returns +$0$. + + \membersection{wxCHECK\_VERSION}\label{wxcheckversion} \func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}} -This is a macro which evaluates to true if the current wxWindows version is at +This is a macro which evaluates to true if the current wxWidgets version is at least major.minor.release. -For example, to test if the program is compiled with wxWindows 2.2 or higher, +For example, to test if the program is compiled with wxWidgets 2.2 or higher, the following can be done: \begin{verbatim} @@ -288,18 +354,17 @@ the following can be done: \end{verbatim} -\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} +\membersection{wxCHECK\_VERSION\_FULL}\label{wxcheckversionfull} -\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} +\func{bool}{wxCHECK\_VERSION\_FULL}{\param{}{major, minor, release, subrel}} -Returns $1$ if the compiler being used to compile the code is GNU C++ -compiler (g++) version major.minor.release or greater. Otherwise, and also if -the compiler is not GNU C++ at all, returns $0$. +Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that +\texttt{wxSUBRELEASE\_NUMBER} is at least \arg{subrel}. \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion} -\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} +\func{bool}{wxCHECK\_W32API\_VERSION}{\param{}{major, minor, release}} Returns $1$ if the version of w32api headers used is major.minor.release or greater. Otherwise, and also if we are not compiling with mingw32/cygwin under @@ -315,31 +380,32 @@ to control the behaviour of the main event loop of the GUI programs. \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 initializes wxWidgets in a platform-dependent way. Use this if you are not +using the default wxWidgets entry code (e.g. main or WinMain). For example, you +can initialize wxWidgets from an Microsoft Foundation Classes application using this function. -\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, - \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}} +The following overload of wxEntry is available under all platforms: + +\func{int}{wxEntry}{\param{int\&}{ argc}, \param{wxChar **}{argv}} -wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the -function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows -message loop will be entered. +Under MS Windows, an additional overload suitable for calling from +\texttt{WinMain} is available: -\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, - \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}} +\func{int}{wxEntry}{\param{HINSTANCE }{hInstance}, \param{HINSTANCE }{hPrevInstance = \NULL}, \param{char *}{pCmdLine = \NULL}, \param{int }{nCmdShow = \texttt{SW\_SHOWNORMAL}}} -wxWindows initialization under Windows (for applications constructed as a DLL). +(notice that under Windows CE platform, and only there, the type of +\arg{pCmdLine} is \texttt{wchar\_t *}, otherwise it is \texttt{char *}, even in +Unicode build). -\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}} +\wxheading{See also} -wxWindows initialization under Unix. +\helpref{wxEntryStart}{wxentrystart} \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: +To clean up wxWidgets, call wxApp::OnExit followed by the static function +wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets: \begin{verbatim} int CTheApp::ExitInstance() @@ -358,11 +424,52 @@ int CTheApp::ExitInstance() +\membersection{::wxEntryCleanup}\label{wxentrycleanup} + +\func{void}{wxEntryCleanup}{\void} + +Free resources allocated by a successful call to \helpref{wxEntryStart}{wxentrystart}. + +\wxheading{Include files} + + + + +\membersection{::wxEntryStart}\label{wxentrystart} + +\func{bool}{wxEntryStart}{\param{int\&}{ argc}, \param{wxChar **}{argv}} + +This function can be used to perform the initialization of wxWidgets if you +can't use the default initialization code for any reason. + +If the function returns \true, the initialization was successful and the global +\helpref{wxApp}{wxapp} object \texttt{wxTheApp} has been created. Moreover, +\helpref{wxEntryCleanup}{wxentrycleanup} must be called afterwards. If the +function returns \false, a catastrophic initialization error occured and (at +least the GUI part of) the library can't be used at all. + +Notice that parameters \arg{argc} and \arg{argv} may be modified by this +function. + +An additional overload of wxEntryStart() is provided under MSW only: it is +meant to be called with the parameters passed to \texttt{WinMain()}. + +\func{bool}{wxEntryStart}{\param{HINSTANCE }{hInstance}, \param{HINSTANCE }{hPrevInstance = \NULL}, \param{char *}{pCmdLine = \NULL}, \param{int }{nCmdShow = \texttt{SW\_SHOWNORMAL}}} + +(notice that under Windows CE platform, and only there, the type of +\arg{pCmdLine} is \texttt{wchar\_t *}, otherwise it is \texttt{char *}, even in +Unicode build). + +\wxheading{Include files} + + + + \membersection{::wxGetApp}\label{wxgetapp} \func{wxAppDerivedClass\&}{wxGetApp}{\void} -This function doesn't exist in wxWindows but it is created by using +This function doesn't exist in wxWidgets but it is created by using the \helpref{IMPLEMENT\_APP}{implementapp} macro. Thus, before using it anywhere but in the same module where this macro is used, you must make it available using \helpref{DECLARE\_APP}{declareapp}. @@ -408,9 +515,9 @@ see \helpref{wxImage}{wximage}. This function is used in wxBase only and only if you don't create \helpref{wxApp}{wxapp} object at all. In this case you must call it from your -{\tt main()} function before calling any other wxWindows functions. +{\tt main()} function before calling any other wxWidgets functions. -If the function returns {\tt false} the initialization could not be performed, +If the function returns \false the initialization could not be performed, in this case the library cannot be used and \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither. @@ -479,7 +586,7 @@ the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and \wxheading{Include files} - + @@ -499,16 +606,16 @@ processes. \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteArgs}} -\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}} +\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{int }{flags = 0}} \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdout} and it only takes the {\tt command} argument, and returns a 2-element list {\tt ( status, output )}, where {\tt output} is an array reference.} -\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}} +\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}, \param{int }{flags = 0}} -\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr} +\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr} and it only takes the {\tt command} argument, and returns a 3-element list {\tt ( status, output, errors )}, where {\tt output} and {\tt errors} are array references.} @@ -531,9 +638,12 @@ In the case of synchronous execution, the return value is the exit code of the process (which terminates by the moment the function returns) and will be $-1$ if the process couldn't be started and typically 0 if the process terminated successfully. Also, while waiting for the process to -terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller -should ensure that this can cause no recursion, in the simplest case by -calling \helpref{wxEnableTopLevelWindows(false)}{wxenabletoplevelwindows}. +terminate, wxExecute will call \helpref{wxYield}{wxyield}. Because of this, by +default this function disables all application windows to avoid unexpected +reentrancies which could result from the users interaction with the program +while the child process is running. If you are sure that it is safe to not +disable the program windows, you may pass \texttt{wxEXEC\_NODISABLE} flag to +prevent this automatic disabling from happening. For asynchronous execution, however, the return value is the process id and zero value indicates that the command could not be executed. As an added @@ -555,14 +665,22 @@ happening, i.e. with this flag the child process window will be shown normally. Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure that the new process is a group leader (this will create a new session if -needed). Calling \helpref{wxKill}{wxkill} with the argument of -pid where pid -is the process ID of the new process will kill this process as well as all of -its children (except those which have started their own session). +needed). Calling \helpref{wxKill}{wxkill} passing wxKILL\_CHILDREN will +kill this process as well as all of its children (except those which have +started their own session). + +The {\tt wxEXEC\_NOEVENTS} flag prevents processing of any events from taking +place while the child process is running. It should be only used for very +short-lived processes as otherwise the application windows risk becoming +unresponsive from the users point of view. As this flag only makes sense with +{\tt wxEXEC\_SYNC}, {\tt wxEXEC\_BLOCK} equal to the sum of both of these flags +is provided as a convenience. Finally, you may use the third overloaded version of this function to execute -a process (always synchronously) and capture its output in the array -{\it output}. The fourth version adds the possibility to additionally capture -the messages from standard error output in the {\it errors} array. +a process (always synchronously, the contents of \arg{flags} is or'd with +\texttt{wxEXEC\_SYNC}) and capture its output in the array \arg{output}. The +fourth version adds the possibility to additionally capture the messages from +standard error output in the \arg{errors} array. {\bf NB:} Currently wxExecute() can only be used from the main thread, calling this function from another thread will result in an assert failure in debug @@ -605,9 +723,26 @@ application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp} +\membersection{::wxJoin}\label{wxjoin} + +\func{wxString}{wxJoin}{\param{const wxArrayString\&}{ arr}, \param{const wxChar}{ sep}, \param{const wxChar}{ escape = '$\backslash$'}} + +Concatenate all lines of the given \helpref{wxArrayString}{wxarraystring} object using the separator \arg{sep} and returns +the result as a \helpref{wxString}{wxstring}. + +If the \arg{escape} character is non-\NULL, then it's used as prefix for each occurrence of \arg{sep} +in the strings contained in \arg{arr} before joining them which is necessary +in order to be able to recover the original array contents from the string +later using \helpref{wxSplit}{wxsplit}. + +\wxheading{Include files} + + + + \membersection{::wxKill}\label{wxkill} -\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}} +\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}, \param{int }{flags = 0}} Equivalent to the Unix kill function: send the given signal {\it sig} to the process with PID {\it pid}. The valid signal values are @@ -635,7 +770,7 @@ enum wxSignal \end{verbatim} {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning -under both Unix and Windows but all the other signals are equivalent to +under both Unix and Windows but all the other signals are equivalent to {\tt wxSIGTERM} under Windows. Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will @@ -652,6 +787,12 @@ enum wxKillError }; \end{verbatim} +The {\it flags} parameter can be wxKILL\_NOCHILDREN (the default), +or wxKILL\_CHILDREN, in which case the child processes of this +process will be killed too. Note that under Unix, for wxKILL\_CHILDREN +to work you should have created the process by passing wxEXEC\_MAKE\_GROUP\_LEADER +to wxExecute. + \wxheading{See also} \helpref{wxProcess::Kill}{wxprocesskill},\rtfsp @@ -696,7 +837,7 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}. This function shuts down or reboots the computer depending on the value of the {\it flags}. Please notice that doing this requires the corresponding access -rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT) +rights (superuser under Unix, {\tt SE\_SHUTDOWN} privilege under Windows NT) and that this function is only implemented under Unix and Win32. \wxheading{Parameters} @@ -705,7 +846,7 @@ and that this function is only implemented under Unix and Win32. \wxheading{Returns} -{\tt true} on success, {\tt false} if an error occured. +\true on success, \false if an error occurred. \wxheading{Include files} @@ -739,7 +880,7 @@ to create and use the critical section only when needed. \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}} -This macro declares a (static) critical section object named {\it cs} if +This macro declares a (static) critical section object named {\it cs} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -748,9 +889,9 @@ This macro declares a (static) critical section object named {\it cs} if \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}} -This macro declares a critical section object named {\it cs} if +This macro declares a critical section object named {\it cs} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. As it doesn't -include the {\tt static} keyword (unlike +include the {\tt static} keyword (unlike \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}), it can be used to declare a class or struct member which explains its name. @@ -760,8 +901,8 @@ a class or struct member which explains its name. \func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}} -This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker} -object named {\it name} and associated with the critical section {\it cs} if +This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker} +object named {\it name} and associated with the critical section {\it cs} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -770,7 +911,7 @@ object named {\it name} and associated with the critical section {\it cs} if \func{}{wxCRITICAL\_SECTION}{\param{}{name}} -This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and +This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and \helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}: it creates a static critical section object and also the lock object associated with it. Because of this, it can be only used inside a function, not at global scope. For example: @@ -788,7 +929,7 @@ int IncCount() (note that we suppose that the function is called the first time from the main thread so that the critical section object is initialized correctly by the time -other threads start calling it, if this is not the case this approach can +other threads start calling it, if this is not the case this approach can {\bf not} be used and the critical section must be made a global instead). @@ -797,7 +938,7 @@ other threads start calling it, if this is not the case this approach can \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if +This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -806,7 +947,7 @@ This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if \func{bool}{wxIsMainThread}{\void} -Returns {\tt true} if this thread is the main one. Always returns {\tt true} if +Returns \true if this thread is the main one. Always returns \true if {\tt wxUSE\_THREADS} is $0$. @@ -815,7 +956,7 @@ Returns {\tt true} if this thread is the main one. Always returns {\tt true} if \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if +This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -869,7 +1010,7 @@ threads. \wxheading{Include files} - + \wxheading{See also} @@ -879,13 +1020,6 @@ threads. \helpref{wxFileName}{wxfilename} -\membersection{::wxDirExists}\label{functionwxdirexists} - -\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} - -Returns true if the directory exists. - - \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename} \func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}} @@ -907,6 +1041,9 @@ Returns true if the file exists and is a plain file. Returns time of last modification of given file. +The function returns \texttt{(time\_t)}$-1$ if an error occurred (e.g. file not +found). + \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath} @@ -923,13 +1060,17 @@ temporary storage that should not be deallocated. \membersection{::wxFindFirstFile}\label{wxfindfirstfile} -\func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}} +\func{wxString}{wxFindFirstFile}{\param{const wxString\& }{spec}, \param{int}{ flags = 0}} This function does directory searching; returns the first file that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to get the next matching file. Neither will report the current directory "." or the parent directory "..". +\wxheading{Warning} + +As of wx 2.5.2, these functions are not thread-safe! (they use static variables). You probably want to use \helpref{wxDir::GetFirst}{wxdirgetfirst} or \helpref{wxDirTraverser}{wxdirtraverser} instead. + {\it spec} may contain wildcards. {\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either. @@ -938,7 +1079,7 @@ For example: \begin{verbatim} wxString f = wxFindFirstFile("/home/project/*.*"); - while ( !f.IsEmpty() ) + while ( !f.empty() ) { ... f = wxFindNextFile(); @@ -966,15 +1107,39 @@ information is not needed. \wxheading{Returns} -{\tt true} on success, {\tt false} if an error occured (for example, the +\true on success, \false if an error occurred (for example, the directory doesn't exist). \wxheading{Portability} -This function is implemented for Win32, -Mac OS and generic Unix provided the system has {\tt statfs()} function. +The generic Unix implementation depends on the system having +the \texttt{statfs()} or \texttt{statvfs()} function. + +This function first appeared in wxWidgets 2.3.2. + -This function first appeared in wxWindows 2.3.2. +\membersection{::wxGetFileKind}\label{wxgetfilekind} + +\func{wxFileKind}{wxGetFileKind}{\param{int }{fd}} + +\func{wxFileKind}{wxGetFileKind}{\param{FILE *}{fp}} + +Returns the type of an open file. Possible return values are: + +\begin{verbatim} +enum wxFileKind +{ + wxFILE_KIND_UNKNOWN, + wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets + wxFILE_KIND_TERMINAL, // a tty + wxFILE_KIND_PIPE // a pipe +}; + +\end{verbatim} + +\wxheading{Include files} + + \membersection{::wxGetOSDirectory}\label{wxgetosdirectory} @@ -992,6 +1157,13 @@ Returns true if the argument is an absolute filename, i.e. with a slash or drive name at the beginning. +\membersection{::wxDirExists}\label{functionwxdirexists} + +\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} + +Returns true if \arg{dirname} exists and is a directory. + + \membersection{::wxPathOnly}\label{wxpathonly} \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}} @@ -1001,12 +1173,26 @@ Returns the directory part of the filename. \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename} -\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}} +\func{void}{wxUnix2DosFilename}{\param{wxChar *}{s}} + +This function is deprecated, use \helpref{wxFileName}{wxfilename} instead. Converts a Unix to a DOS filename by replacing forward slashes with backslashes. +\membersection{wxCHANGE\_UMASK}\label{wxchangeumask} + +\func{}{wxCHANGE\_UMASK}{\param{int }{mask}} + +Under Unix this macro changes the current process umask to the given value, +unless it is equal to $-1$ in which case nothing is done, and restores it to +the original value on scope exit. It works by declaring a variable which sets +umask to \arg{mask} in its constructor and restores it in its destructor. + +Under other platforms this macro expands to nothing. + + \membersection{::wxConcatFiles}\label{wxconcatfiles} \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, @@ -1021,10 +1207,12 @@ true if successful. \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}} Copies {\it file1} to {\it file2}, returning true if successful. If -{\it overwrite} parameter is true (default), the destination file is overwritten -if it exists, but if {\it overwrite} is false, the functions fails in this +{\it overwrite} parameter is \true (default), the destination file is overwritten +if it exists, but if {\it overwrite} is \false, the functions fails in this case. +This function supports resources forks under Mac OS. + \membersection{::wxGetCwd}\label{wxgetcwd} @@ -1037,7 +1225,7 @@ Returns a string containing the current (or working) directory. \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}} -{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead. +{\bf NB:} This function is deprecated: use \helpref{wxGetCwd}{wxgetcwd} instead. Copies the current working directory into the buffer if supplied, or copies the working directory into new storage (which you {\emph must} delete @@ -1078,7 +1266,7 @@ Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatc \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}} -Returns true if the {\it pattern}\/ matches the {\it text}\/; if {\it +Returns true if the \arg{pattern}\/ matches the {\it text}\/; if {\it dot\_special}\/ is true, filenames beginning with a dot are not matched with wildcard characters. See \helpref{wxIsWild}{wxiswild}. @@ -1087,24 +1275,42 @@ with wildcard characters. See \helpref{wxIsWild}{wxiswild}. \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}} -Makes the directory {\it dir}, returning true if successful. +Makes the directory \arg{dir}, returning true if successful. {\it perm} is the access mask for the directory for the systems on which it is -supported (Unix) and doesn't have effect for the other ones. +supported (Unix) and doesn't have any effect on the other ones. + + +\membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter} +\func{int}{wxParseCommonDialogsFilter}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}} + +Parses the \arg{wildCard}, returning the number of filters. +Returns 0 if none or if there's a problem. +The arrays will contain an equal number of items found before the error. +On platforms where native dialogs handle only one filter per entry, +entries in arrays are automatically adjusted. +\arg{wildCard} is in the form: +\begin{verbatim} + "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png" +\end{verbatim} \membersection{::wxRemoveFile}\label{wxremovefile} \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}} -Removes {\it file}, returning true if successful. +Removes \arg{file}, returning true if successful. \membersection{::wxRenameFile}\label{wxrenamefile} -\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}} +\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}} + +Renames \arg{file1} to \arg{file2}, returning true if successful. -Renames {\it file1} to {\it file2}, returning true if successful. +If \arg{overwrite} parameter is true (default), the destination file is +overwritten if it exists, but if \arg{overwrite} is false, the functions fails +in this case. \membersection{::wxRmdir}\label{wxrmdir} @@ -1115,6 +1321,11 @@ Removes the directory {\it dir}, returning true if successful. Does not work und The {\it flags} parameter is reserved for future use. +Please notice that there is also a wxRmDir() function which simply wraps the +standard POSIX rmdir() function and so return an integer error code instead of +a boolean value (but otherwise is currently identical to wxRmdir), don't +confuse these two functions. + \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory} @@ -1124,9 +1335,30 @@ Sets the current working directory, returning true if the operation succeeded. Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification. +\membersection{::wxSplit}\label{wxsplit} + +\func{wxArrayString}{wxSplit}{\param{const wxString\&}{ str}, \param{const wxChar}{ sep}, \param{const wxChar}{ escape = '\\'}} + +Splits the given \helpref{wxString}{wxstring} object using the separator \arg{sep} and returns the +result as a \helpref{wxArrayString}{wxarraystring}. + +If the \arg{escape} character is non-\NULL, then the occurrences of \arg{sep} immediately prefixed +with \arg{escape} are not considered as separators. + +Note that empty tokens will be generated if there are two or more adjacent separators. + +\wxheading{See also} + +\helpref{wxJoin}{wxjoin} + +\wxheading{Include files} + + + + \membersection{::wxSplitPath}\label{wxsplitfunction} -\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}} +\func{void}{wxSplitPath}{\param{const wxString\&}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}} {\bf NB:} This function is obsolete, please use \helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead. @@ -1180,13 +1412,29 @@ The functions in this section are used to retrieve information about the current computer and/or user characteristics. +\membersection{::wxGetEmailAddress}\label{wxgetemailaddress} + +\func{wxString}{wxGetEmailAddress}{\void} + +\func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}} + +Copies the user's email address into the supplied buffer, by +concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp +and \helpref{wxGetUserId}{wxgetuserid}. + +Returns true if successful, false otherwise. + +\wxheading{Include files} + + + + \membersection{::wxGetFreeMemory}\label{wxgetfreememory} -\func{long}{wxGetFreeMemory}{\void} +\func{wxMemorySize}{wxGetFreeMemory}{\void} Returns the amount of free memory in bytes under environments which -support it, and -1 if not supported. Currently, it is supported only -under Windows, Linux and Solaris. +support it, and -1 if not supported or failed to perform measurement. \wxheading{Include files} @@ -1209,21 +1457,6 @@ error. -\membersection{::wxGetEmailAddress}\label{wxgetemailaddress} - -\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}} - -Copies the user's email address into the supplied buffer, by -concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp -and \helpref{wxGetUserId}{wxgetuserid}. - -Returns true if successful, false otherwise. - -\wxheading{Include files} - - - - \membersection{::wxGetHomeDir}\label{wxgethomedir} \func{wxString}{wxGetHomeDir}{\void} @@ -1232,7 +1465,8 @@ Return the (current) user's home directory. \wxheading{See also} -\helpref{wxGetUserHome}{wxgetuserhome} +\helpref{wxGetUserHome}{wxgetuserhome}\\ +\helpref{wxStandardPaths}{wxstandardpaths} \wxheading{Include files} @@ -1251,7 +1485,7 @@ the domain name. Under Windows or NT, this function first looks in the environment variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +in the {\bf wxWidgets} section of the WIN.INI file is tried. The first variant of this function returns the hostname if successful or an empty string otherwise. The second (deprecated) function returns true @@ -1266,74 +1500,68 @@ if successful, false otherwise. -\membersection{::wxGetUserId}\label{wxgetuserid} +\membersection{::wxGetOsDescription}\label{wxgetosdescription} -\func{wxString}{wxGetUserId}{\void} +\func{wxString}{wxGetOsDescription}{\void} -\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}} +Returns the string containing the description of the current platform in a +user-readable form. For example, this function may return strings like +{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}. -This function returns the "user id" also known as "login name" under Unix i.e. -something like "jsmith". It uniquely identifies the current user (on this system). +\wxheading{See also} -Under Windows or NT, this function first looks in the environment -variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +\helpref{::wxGetOsVersion}{wxgetosversion} -The first variant of this function returns the login name if successful or an -empty string otherwise. The second (deprecated) function returns true -if successful, false otherwise. +\wxheading{Include files} + + + + +\membersection{::wxGetOsVersion}\label{wxgetosversion} + +\func{wxOperatingSystemId}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}} + +Gets the version and the operating system ID for currently running OS. +See \helpref{wxPlatformInfo}{wxplatforminfo} for more details about wxOperatingSystemId. \wxheading{See also} -\helpref{wxGetUserName}{wxgetusername} +\helpref{::wxGetOsDescription}{wxgetosdescription}, +\helpref{wxPlatformInfo}{wxplatforminfo} \wxheading{Include files} -\membersection{::wxGetOsDescription}\label{wxgetosdescription} +\membersection{::wxIsPlatformLittleEndian}\label{wxisplatformlittleendian} -\func{wxString}{wxGetOsDescription}{\void} +\func{bool}{wxIsPlatformLittleEndian}{\void} -Returns the string containing the description of the current platform in a -user-readable form. For example, this function may return strings like -{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}. +Returns \true if the current platform is little endian (instead of big endian). +The check is performed at run-time. \wxheading{See also} -\helpref{::wxGetOsVersion}{wxgetosversion} +\helpref{Byte order macros}{byteordermacros} \wxheading{Include files} -\membersection{::wxGetOsVersion}\label{wxgetosversion} +\membersection{::wxIsPlatform64Bit}\label{wxisplatform64bit} -\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}} +\func{bool}{wxIsPlatform64Bit}{\void} -Gets operating system version information. +Returns \true if the operating system the program is running under is 64 bit. +The check is performed at run-time and may differ from the value available at +compile-time (at compile-time you can just check if {\tt sizeof(void*)==8}) +since the program could be running in emulation mode or in a mixed 32/64 bit system +(bi-architecture operating system). -\begin{twocollist}\itemsep=0pt -\twocolitemruled{Platform}{Return types} -\twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X. - -Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. } -\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. } -\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.} -\twocolitem{OS/2}{Return value is wxOS2\_PM.} -\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.} -\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}} -\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.} -\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.} -\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.} -\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.} -\end{twocollist} - -\wxheading{See also} - -\helpref{::wxGetOsDescription}{wxgetosdescription} +Very important: this function is not 100\% reliable on some systems given the fact +that there isn't always a standard way to do a reliable check on the OS architecture. \wxheading{Include files} @@ -1353,95 +1581,109 @@ Returns the home directory for the given user. If the username is empty -\membersection{::wxGetUserName}\label{wxgetusername} +\membersection{::wxGetUserId}\label{wxgetuserid} -\func{wxString}{wxGetUserName}{\void} +\func{wxString}{wxGetUserId}{\void} -\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}} +\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}} -This function returns the full user name (something like "Mr. John Smith"). +This function returns the "user id" also known as "login name" under Unix i.e. +something like "jsmith". It uniquely identifies the current user (on this system). -Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file. If PenWindows -is running, the entry {\bf Current} in the section {\bf User} of -the PENWIN.INI file is used. +Under Windows or NT, this function first looks in the environment +variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp +in the {\bf wxWidgets} section of the WIN.INI file is tried. -The first variant of this function returns the user name if successful or an -empty string otherwise. The second (deprecated) function returns {\tt true} -if successful, {\tt false} otherwise. +The first variant of this function returns the login name if successful or an +empty string otherwise. The second (deprecated) function returns true +if successful, false otherwise. \wxheading{See also} -\helpref{wxGetUserId}{wxgetuserid} +\helpref{wxGetUserName}{wxgetusername} \wxheading{Include files} +\membersection{::wxGetUserName}\label{wxgetusername} -\section{String functions} - +\func{wxString}{wxGetUserName}{\void} -\membersection{::copystring}\label{copystring} +\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}} -\func{char *}{copystring}{\param{const char *}{s}} +This function returns the full user name (something like "Mr. John Smith"). -Makes a copy of the string {\it s} using the C++ new operator, so it can be -deleted with the {\it delete} operator. +Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp +in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows +is running, the entry {\bf Current} in the section {\bf User} of +the PENWIN.INI file is used. -This function is deprecated, use \helpref{wxString}{wxstring} class instead. +The first variant of this function returns the user name if successful or an +empty string otherwise. The second (deprecated) function returns \true +if successful, \false otherwise. +\wxheading{See also} -\membersection{ngettext}\label{ngettext} +\helpref{wxGetUserId}{wxgetuserid} -\func{const wxChar *}{ngettext}{\param{const char *}{str}, \param{const char *}{strPlural}, \param{size\_t }{n}} +\wxheading{Include files} -This macro expands into a call to plural form version of -\helpref{wxGetTranslation}{wxgettranslation} -function, so it marks the message for the extraction by {\tt xgettext} just as -\helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of -the string for the current locale during execution, either singular or plural -form depending on the value of \arg{n}. + -\wxheading{See also} -\helpref{\_}{underscore} +\section{String functions}\label{stringfunctions} \membersection{::wxGetTranslation}\label{wxgettranslation} -\func{const char *}{wxGetTranslation}{\param{const char * }{str}} +\func{const wxString\& }{wxGetTranslation}{\param{const wxString\& }{str}, + \param{const wxString\& }{domain = wxEmptyString}} -\func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}} +\func{const wxString\& }{wxGetTranslation}{\param{const wxString\& }{str}, \param{const wxString\& }{strPlural}, \param{size\_t }{n}, + \param{const wxString\& }{domain = wxEmptyString}} This function returns the translation of string {\it str} in the current \helpref{locale}{wxlocale}. If the string is not found in any of the loaded message catalogs (see \helpref{internationalization overview}{internationalization}), the original string is returned. In debug build, an error message is logged -- this -should help to find the strings which were not yet translated. As this function +should help to find the strings which were not yet translated. If +{\it domain} is specified then only that domain/catalog is searched +for a matching string. As this function is used very often, an alternative (and also common in Unix world) syntax is provided: the \helpref{\_()}{underscore} macro is defined to do the same thing as wxGetTranslation. The second form is used when retrieving translation of string that has different singular and plural form in English or different plural forms in some -other language. It takes two extra arguments: \arg{str} -parameter must contain the singular form of the string to be converted. -It is also used as the key for the search in the catalog. -The \arg{strPlural} parameter is the plural form (in English). -The parameter \arg{n} is used to determine the plural form. If no -message catalog is found \arg{str} is returned if `n == 1', -otherwise \arg{strPlural}. The \helpref{ngettext}{ngettext} macro is defined -to do the same thing. -See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling. +other language. It takes two extra arguments: as above, \arg{str} +parameter must contain the singular form of the string to be converted and +is used as the key for the search in the catalog. The \arg{strPlural} parameter +is the plural form (in English). The parameter \arg{n} is used to determine the +plural form. If no message catalog is found \arg{str} is returned if `n == 1', +otherwise \arg{strPlural}. + +See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} +for additional information on plural forms handling. For a shorter alternative +see the \helpref{wxPLURAL()}{wxplural} macro. + +Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}. + +Note that this function is not suitable for literal strings in Unicode +builds, since the literal strings must be enclosed into +\helpref{\_T()}{underscoret} or \helpref{wxT}{wxt} macro which makes them +unrecognised by \texttt{xgettext}, and so they are not extracted to the message +catalog. Instead, use the \helpref{\_()}{underscore} and +\helpref{wxPLURAL}{wxplural} macro for all literal strings. + \membersection{::wxIsEmpty}\label{wxisempty} \func{bool}{wxIsEmpty}{\param{const char *}{ p}} -Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty -string, {\tt false} otherwise. +Returns \true if the pointer is either {\tt NULL} or points to an empty +string, \false otherwise. \membersection{::wxStrcmp}\label{wxstrcmp} @@ -1466,6 +1708,19 @@ This function complements the standard C function {\it strcmp()} which performs case-sensitive comparison. +\membersection{::wxStringEq}\label{wxstringeq} + +\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}} + +{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead. + +A macro defined as: + +\begin{verbatim} +#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) +\end{verbatim} + + \membersection{::wxStringMatch}\label{wxstringmatch} \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\ @@ -1473,22 +1728,24 @@ case-sensitive comparison. {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead. -Returns {\tt true} if the substring {\it s1} is found within {\it s2}, -ignoring case if {\it exact} is false. If {\it subString} is {\tt false}, +Returns \true if the substring {\it s1} is found within {\it s2}, +ignoring case if {\it exact} is false. If {\it subString} is \false, no substring matching is done. -\membersection{::wxStringEq}\label{wxstringeq} - -\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}} +\membersection{::wxStringTokenize}\label{wxstringtokenize} -{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead. +\func{wxArrayString}{wxStringTokenize}{\param{const wxString\& }{str},\\ + \param{const wxString\& }{delims = wxDEFAULT\_DELIMITERS},\\ + \param{wxStringTokenizerMode }{mode = wxTOKEN\_DEFAULT}} -A macro defined as: +This is a convenience function wrapping +\helpref{wxStringTokenizer}{wxstringtokenizer} which simply returns all tokens +found in the given \arg{str} in an array. -\begin{verbatim} -#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) -\end{verbatim} +Please see +\helpref{wxStringTokenizer::wxStringTokenizer}{wxstringtokenizerwxstringtokenizer} +for the description of the other parameters. \membersection{::wxStrlen}\label{wxstrlen} @@ -1525,7 +1782,7 @@ enough space. wxT() is a macro which can be used with character and string literals (in other words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in -Unicode build configuration. Please see the +Unicode build configuration. Please see the \helpref{Unicode overview}{unicode} for more information. This macro is simply returns the value passed to it without changes in ASCII @@ -1544,16 +1801,16 @@ build. In fact, its definition is: \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}} This macro doesn't do anything in the program code -- it simply expands to the -value of its argument (expand in Unicode build where it is equivalent to +value of its argument (except in Unicode build where it is equivalent to \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT with the same string which would be really unreadable). However it does have a purpose and it is to mark the literal strings for the extraction into the message catalog created by {\tt xgettext} program. Usually this is achieved using \helpref{\_()}{underscore} but that macro not only marks -the string for extraction but also expands into +the string for extraction but also expands into a \helpref{wxGetTranslation}{wxgettranslation} function call which means that it -cannot be used in some situations, notably for the static arrays +cannot be used in some situations, notably for static array initialization. Here is an example which should make it more clear: suppose that you have a @@ -1584,8 +1841,6 @@ wxTRANSLATE() in the above, it wouldn't work as expected because there would be no translations for the weekday names in the program message catalog and wxGetTranslation wouldn't find them. - - \membersection{::wxVsnprintf}\label{wxvsnprintf} \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}} @@ -1593,6 +1848,12 @@ wxGetTranslation wouldn't find them. The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list } argument instead of arbitrary number of parameters. +Note that if \texttt{wxUSE\_PRINTF\_POS\_PARAMS} is set to 1, then this function supports +positional arguments (see \helpref{wxString::Printf}{wxstringprintf} for more information). +However other functions of the same family (wxPrintf, wxSprintf, wxFprintf, wxVfprintf, +wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional parameters +even when \texttt{wxUSE\_PRINTF\_POS\_PARAMS} is 1. + \wxheading{See also} \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv} @@ -1601,19 +1862,22 @@ argument instead of arbitrary number of parameters. \membersection{\_}\label{underscore} -\func{const wxChar *}{\_}{\param{const char *}{s}} +\func{const wxString\&}{\_}{\param{const wxString\&}{s}} -This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation} +This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation} function, so it marks the message for the extraction by {\tt xgettext} just as \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of the string for the current locale during execution. Don't confuse this macro with \helpref{\_T()}{underscoret}! -\wxheading{See also} -\helpref{ngettext}{ngettext} +\membersection{wxPLURAL}\label{wxplural} +\func{const wxString\&}{wxPLURAL}{\param{const wxString\&}{sing}, \param{const wxString\&}{plur}, \param{size\_t}{n}} + +This macro is identical to \helpref{\_()}{underscore} but for the plural variant +of \helpref{wxGetTranslation}{wxgettranslation}. \membersection{\_T}\label{underscoret} @@ -1623,7 +1887,7 @@ Don't confuse this macro with \helpref{\_T()}{underscoret}! \func{const wxChar *}{\_T}{\param{const wxChar }{ch}} This macro is exactly the same as \helpref{wxT}{wxt} and is defined in -wxWindows simply because it may be more intuitive for Windows programmers as +wxWidgets simply because it may be more intuitive for Windows programmers as the standard Win32 headers also define it (as well as yet another name for the same macro which is {\tt \_TEXT()}). @@ -1640,6 +1904,39 @@ parameter, or (in MS Windows or Motif) the wrong window frame may be brought to the front when the dialog box is popped up. +\membersection{::wxAboutBox}\label{wxaboutbox} + +\func{void}{wxAboutBox}{\param{const wxAboutDialogInfo\& }{info}} + +This function shows the standard about dialog containing the information +specified in \arg{info}. If the current platform has a native about dialog +which is capable of showing all the fields in \arg{info}, the native dialog is +used, otherwise the function falls back to the generic wxWidgets version of the +dialog, i.e. does the same thing as \helpref{wxGenericAboutBox()}{wxgenericaboutbox}. + +Here is an example of how this function may be used: +\begin{verbatim} +void MyFrame::ShowSimpleAboutDialog(wxCommandEvent& WXUNUSED(event)) +{ + wxAboutDialogInfo info; + info.SetName(_("My Program")); + info.SetVersion(_("1.2.3 Beta")); + info.SetDescription(_("This program does something great.")); + info.SetCopyright(_T("(C) 2007 Me ")); + + wxAboutBox(info); +} +\end{verbatim} + +Please see the \helpref{dialogs sample}{sampledialogs} for more examples of +using this function and \helpref{wxAboutDialogInfo}{wxaboutdialoginfo} for the +description of the information which can be shown in the about dialog. + +\wxheading{Include files} + + + + \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor} \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}} @@ -1719,7 +2016,7 @@ if ( !dir.empty() ) \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\ \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\ - \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\ + \param{const wxString\& }{wildcard = "*.*"}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\ \param{int}{ x = -1}, \param{int}{ y = -1}} Pops up a file selector box. In Windows, this is the common file selector @@ -1728,8 +2025,10 @@ The path and filename are distinct elements of a full file pathname. If path is empty, the current directory will be used. If filename is empty, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type -extension for the required filename. Flags may be a combination of wxOPEN, -wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. +extension for the required filename. Flags may be a combination of wxFD\_OPEN, +wxFD\_SAVE, wxFD\_OVERWRITE\_PROMPT or wxFD\_FILE\_MUST\_EXIST. Note that wxFD\_MULTIPLE +can only be used with \helpref{wxFileDialog}{wxfiledialog} and not here as this +function only returns a single file name. Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and @@ -1775,12 +2074,35 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. +\membersection{::wxGenericAboutBox}\label{wxgenericaboutbox} + +\func{void}{wxGenericAboutBox}{\param{const wxAboutDialogInfo\& }{info}} + +This function does the same thing as \helpref{wxAboutBox}{wxaboutbox} except +that it always uses the generic wxWidgets version of the dialog instead of the +native one. This is mainly useful if you need to customize the dialog by e.g. +adding custom controls to it (customizing the native dialog is not currently +supported). + +See the \helpref{dialogs sample}{sampledialogs} for an example of about dialog +customization. + +\wxheading{See also} + +\helpref{wxAboutDialogInfo}{wxaboutdialoginfo} + +\wxheading{Include files} + +\\ + + + \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser} -\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}} +\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}, \param{const wxString\& }{caption = wxEmptyString}} Shows the colour selection dialog and returns the colour selected by user or -invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour +invalid colour (use \helpref{wxColour:IsOk}{wxcolourisok} to test whether a colour is valid) if the dialog was cancelled. \wxheading{Parameters} @@ -1789,6 +2111,8 @@ is valid) if the dialog was cancelled. \docparam{colInit}{If given, this will be the colour initially selected in the dialog.} +\docparam{caption}{If given, this will be used for the dialog caption.} + \wxheading{Include files} @@ -1796,10 +2120,10 @@ is valid) if the dialog was cancelled. \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser} -\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}} +\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}, \param{const wxString\& }{caption = wxEmptyString}} Shows the font selection dialog and returns the font selected by user or -invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font +invalid font (use \helpref{wxFont:IsOk}{wxfontisok} to test whether a font is valid) if the dialog was cancelled. \wxheading{Parameters} @@ -1808,6 +2132,8 @@ is valid) if the dialog was cancelled. \docparam{fontInit}{If given, this will be the font initially selected in the dialog.} +\docparam{caption}{If given, this will be used for the dialog caption.} + \wxheading{Include files} @@ -1883,13 +2209,14 @@ Dialog is centered on its {\it parent} unless an explicit position is given in \wxheading{Include files} - + \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser} -\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ - \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}} +\func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ + \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\ + \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}} Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered in the dialog is not shown on screen but replaced with stars. This is intended @@ -1904,45 +2231,18 @@ to be used for entering passwords as the function name implies. \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\ - \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}} + \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}} Pop up a dialog box with title set to {\it caption}, {\it message}, and a \rtfsp{\it default\_value}. The user may type in text and press OK to return this text, -or press Cancel to return the empty string. - -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} - - - - -\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice} - -\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ - \param{int }{nsel}, \param{int *}{selection}, - \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} - -Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection -listbox. The user may choose one or more item(s) and press OK or Cancel. - -The number of initially selected choices, and array of the selected indices, -are passed in; this array will contain the user selections on exit, with -the function returning the number of selections. {\it selection} must be -as big as the number of choices, in case all are selected. - -If Cancel is pressed, -1 is returned. - -{\it choices} is an array of {\it n} strings for the listbox. +or press Cancel to return the empty string. 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} - + \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice} @@ -2066,7 +2366,7 @@ following identifiers: \begin{twocollist}\itemsep=0pt \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with wxCANCEL.} -\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with +\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May only be combined with wxYES\_NO or wxOK.} \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.} \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.} @@ -2104,7 +2404,7 @@ message will be split into separate lines, to cater for large messages. \param{bool }{showAtStartup = true}} This function shows a "startup tip" to the user. The return value is the -state of the ``Show tips at startup'' checkbox. +state of the `Show tips at startup' checkbox. \docparam{parent}{The parent window for the modal dialog} @@ -2126,7 +2426,7 @@ checkbox which is shown in the tips dialog.} -\section{Math functions} +\section{Math functions}\label{mathfunctions} \wxheading{Include files} @@ -2137,7 +2437,7 @@ checkbox which is shown in the tips dialog.} \func{int}{wxFinite}{\param{double }{x}} -Returns a non-zero value if {\it x} is neither infinite or NaN (not a number), +Returns a non-zero value if {\it x} is neither infinite nor NaN (not a number), returns 0 otherwise. @@ -2276,7 +2576,7 @@ the equivalent of the following code to the start of the metafile data: SetWindowExt(dc, maxX - minX, maxY - minY); \end{verbatim} -This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes. +This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes. Placeable metafiles may be imported by many Windows applications, and can be used in RTF (Rich Text Format) files. @@ -2456,7 +2756,7 @@ Empties the clipboard. \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats} -\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}} +\func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}} Enumerates the formats found in a list of available formats that belong to the clipboard. Each call to this function specifies a known @@ -2477,7 +2777,7 @@ wxOpenClipboard function. \membersection{::wxGetClipboardData}\label{wxgetclipboarddata} -\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}} +\func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}} Gets data from the clipboard. @@ -2493,7 +2793,7 @@ The clipboard must have previously been opened for this call to succeed. \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname} -\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}} +\func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}} Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format. @@ -2501,7 +2801,7 @@ length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable} -\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}} +\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}} Returns true if the given data format is available on the clipboard. @@ -2522,7 +2822,7 @@ Registers the clipboard data format name and returns an identifier. \membersection{::wxSetClipboardData}\label{wxsetclipboarddata} -\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}} +\func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}} Passes data to the clipboard. @@ -2538,9 +2838,112 @@ Passes data to the clipboard. The clipboard must have previously been opened for this call to succeed. +\section{Miscellaneous functions}\label{miscellany} + +\membersection{wxBase64Decode}\label{wxbase64decode} -\section{Miscellaneous functions}\label{miscellany} +\func{size\_t}{wxBase64Decode}{\param{void *}{dst}, \param{size\_t }{dstLen}, +\param{const char * }{src}, \param{size\_t }{srcLen = wxNO\_LEN}, +\param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict}, +\param{size\_t }{*posErr = \NULL}} + +\func{wxMemoryBuffer}{wxBase64Decode}{\\ +\param{const char * }{src}, \param{size\_t }{srcLen = wxNO\_LEN},\\ +\param{wxBase64DecodeMode }{mode = wxBase64DecodeMode\_Strict},\\ +\param{size\_t }{*posErr = \NULL}} + +These function decode a Base64-encoded string. The first version is a raw +decoding function and decodes the data into the provided buffer \arg{dst} of +the given size \arg{dstLen}. An error is returned if the buffer is not large +enough -- that is not at least \helpref{wxBase64DecodedSize(srcLen)}{wxbase64decodedsize} +bytes. The second version allocates memory internally and returns it as +\helpref{wxMemoryBuffer}{wxmemorybuffer} and is recommended for normal use. + +The first version returns the number of bytes written to the buffer or the +necessary buffer size if \arg{dst} was \NULL or \texttt{wxCONV\_FAILED} on +error, e.g. if the output buffer is too small or invalid characters were +encountered in the input string. The second version returns a buffer with the +base64 decoded binary equivalent of the input string. In neither case is the +buffer NUL-terminated. + +\wxheading{Parameters} + +\docparam{dst}{Pointer to output buffer, may be \NULL to just compute the +necessary buffer size.} + +\docparam{dstLen}{The size of the output buffer, ignored if \arg{dst} is +\NULL.} + +\docparam{src}{The input string, must not be \NULL.} + +\docparam{srcLen}{The length of the input string or special value +\texttt{wxNO\_LEN} if the string is \NUL-terminated and the length should be +computed by this function itself.} + +\docparam{mode}{This parameter specifies the function behaviour when invalid +characters are encountered in input. By default, any such character stops the +decoding with error. If the mode is wxBase64DecodeMode\_SkipWS, then the white +space characters are silently skipped instead. And if it is +wxBase64DecodeMode\_Relaxed, then all invalid characters are skipped.} + +\docparam{posErr}{If this pointer is non-\NULL and an error occurs during +decoding, it is filled with the index of the invalid character.} + +\wxheading{Include files} + + + + +\membersection{wxBase64DecodedSize}\label{wxbase64decodedsize} + +\func{size\_t}{wxBase64DecodedSize}{\param{size\_t }{srcLen}} + +Returns the size of the buffer necessary to contain the data encoded in a +base64 string of length \arg{srcLen}. This can be useful for allocating a +buffer to be passed to \helpref{wxBase64Decode}{wxbase64decode}. + + +\membersection{wxBase64Encode}\label{wxbase64encode} + +\func{size\_t}{wxBase64Encode}{\param{char *}{dst}, \param{size\_t }{dstLen}, +\param{const void *}{src}, \param{size\_t }{srcLen}} + +\func{wxString}{wxBase64Encode}{\param{const void *}{src}, \param{size\_t }{srcLen}} + +\func{wxString}{wxBase64Encode}{\param{const wxMemoryBuffer\& }{buf}} + +These functions encode the given data using base64. The first of them is the +raw encoding function writing the output string into provided buffer while the +other ones return the output as wxString. There is no error return for these +functions except for the first one which returns \texttt{wxCONV\_FAILED} if the +output buffer is too small. To allocate the buffer of the correct size, use +\helpref{wxBase64EncodedSize}{wxbase64encodedsize} or call this function with +\arg{dst} set to \NULL -- it will then return the necessary buffer size. + +\wxheading{Parameters} + +\docparam{dst}{The output buffer, may be \NULL to retrieve the needed buffer +size.} + +\docparam{dstLen}{The output buffer size, ignored if \arg{dst} is \NULL.} + +\docparam{src}{The input buffer, must not be \NULL.} + +\docparam{srcLen}{The length of the input data.} + +\wxheading{Include files} + + + + +\membersection{wxBase64EncodedSize}\label{wxbase64encodedsize} + +\func{size\_t}{wxBase64EncodedSize}{\param{size\_t }{len}} + +Returns the length of the string with base64 representation of a buffer of +specified size \arg{len}. This can be useful for allocating the buffer passed +to \helpref{wxBase64Encode}{wxbase64encode}. \membersection{wxCONCAT}\label{wxconcat} @@ -2554,15 +2957,15 @@ This macro returns the concatenation of two tokens \arg{x} and \arg{y}. \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}} -When loading a function from a DLL you always have to cast the returned -\tt{void *} pointer to the correct type and, even more annoyingly, you have to +When loading a function from a DLL you always have to cast the returned +{\tt void *} pointer to the correct type and, even more annoyingly, you have to repeat this type twice if you want to declare and define a function pointer all in one line This macro makes this slightly less painful by allowing you to specify the type only once, as the first parameter, and creating a variable of this type named after the function but with {\tt pfn} prefix and initialized with the -function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary} +function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary} \arg{dynlib}. \wxheading{Parameters} @@ -2576,6 +2979,36 @@ it is quoted automatically by the macro)} +\membersection{wxDEPRECATED}\label{wxdeprecated} + +This macro can be used around a function declaration to generate warnings +indicating that this function is deprecated (i.e. obsolete and planned to be +removed in the future) when it is used. Only Visual C++ 7 and higher and g++ +compilers currently support this functionality. + +Example of use: +\begin{verbatim} + // old function, use wxString version instead + wxDEPRECATED( void wxGetSomething(char *buf, size_t len) ); + + // ... + wxString wxGetSomething(); +\end{verbatim} + + +\membersection{wxDEPRECATED\_BUT\_USED\_INTERNALLY}\label{wxdeprecatedbutusedinternally} + +This is a special version of \helpref{wxDEPRECATED}{wxdeprecated} macro which +only does something when the deprecated function is used from the code outside +wxWidgets itself but doesn't generate warnings when it is used from wxWidgets. +It is used with the virtual functions which are called by the library itself -- +even if such function is deprecated the library still has to call it to ensure +that the existing code overriding it continues to work, but the use of this +macro ensures that a deprecation warning will be generated if this function is +used from the user code or, in case of Visual C++, even when it is simply +overridden. + + \membersection{wxEXPLICIT}\label{wxexplicit} {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if @@ -2584,6 +3017,25 @@ code which might have to be compiled with an old compiler without support for this language feature but still take advantage of it when it is available. + +\membersection{::wxGetKeyState}\label{wxgetkeystate} + +\func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}} + +For normal keys, returns \true if the specified key is currently down. + +For togglable keys (Caps Lock, Num Lock and Scroll Lock), returns +\true if the key is toggled such that its LED indicator is lit. There is +currently no way to test whether togglable keys are up or down. + +Even though there are virtual key codes defined for mouse buttons, they +cannot be used with this function currently. + +\wxheading{Include files} + + + + \membersection{wxLL}\label{wxll} \func{wxLongLong\_t}{wxLL}{\param{}{number}} @@ -2632,6 +3084,12 @@ printed. Example of using it: \func{long}{wxNewId}{\void} +This function is deprecated as the ids generated by it can conflict with the +ids defined by the user code, use \texttt{wxID\_ANY} to assign ids which are +guaranteed to not conflict with the user-defined ids for the controls and menu +items you create instead of using this function. + + Generates an integer identifier unique to this run of the program. \wxheading{Include files} @@ -2639,6 +3097,52 @@ Generates an integer identifier unique to this run of the program. +\membersection{wxON\_BLOCK\_EXIT}\label{wxonblockexit} + +\func{}{wxON\_BLOCK\_EXIT0}{\param{}{func}} + +\func{}{wxON\_BLOCK\_EXIT1}{\param{}{func}, \param{}{p1}} + +\func{}{wxON\_BLOCK\_EXIT2}{\param{}{func}, \param{}{p1}, \param{}{p2}} + +This family of macros allows to ensure that the global function \arg{func} +with 0, 1, 2 or more parameters (up to some implementaton-defined limit) is +executed on scope exit, whether due to a normal function return or because an +exception has been thrown. A typical example of its usage: +\begin{verbatim} + void *buf = malloc(size); + wxON_BLOCK_EXIT1(free, buf); +\end{verbatim} + +Please see the original article by Andrei Alexandrescu and Petru Marginean +published in December 2000 issue of \emph{C/C++ Users Journal} for more +details. + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxON\_BLOCK\_EXIT\_OBJ}{wxonblockexitobj} + + +\membersection{wxON\_BLOCK\_EXIT\_OBJ}\label{wxonblockexitobj} + +\func{}{wxON\_BLOCK\_EXIT\_OBJ0}{\param{}{obj}, \param{}{method}} + +\func{}{wxON\_BLOCK\_EXIT\_OBJ1}{\param{}{obj}, \param{}{method}, \param{}{p1}} + +\func{}{wxON\_BLOCK\_EXIT\_OBJ2}{\param{}{obj}, \param{}{method}, \param{}{p1}, \param{}{p2}} + +This family of macros is similar to \helpref{wxON\_BLOCK\_EXIT}{wxonblockexit} +but calls a method of the given object instead of a free function. + +\wxheading{Include files} + + + + \membersection{::wxRegisterId}\label{wxregisterid} \func{void}{wxRegisterId}{\param{long}{ id}} @@ -2655,7 +3159,7 @@ the given {\bf id}. \func{void}{wxDDECleanUp}{\void} -Called when wxWindows exits, to clean up the DDE system. This no longer needs to be +Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be called by the application. See also \helpref{wxDDEInitialize}{wxddeinitialize}. @@ -2672,7 +3176,7 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}. Initializes the DDE system. May be called multiple times without harm. This no longer needs to be called by the application: it will be called -by wxWindows if necessary. +by wxWidgets if necessary. See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp \helpref{wxDDECleanUp}{wxddecleanup}. @@ -2684,7 +3188,7 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} -\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}} +\func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}} This function enables or disables all top level windows. It is used by \helpref{::wxSafeYield}{wxsafeyield}. @@ -2757,15 +3261,43 @@ Find the deepest window at the mouse pointer position, returning the window and current pointer position in screen coordinates. +\membersection{wxFromString}\label{wxfromstring} + +\func{bool}{wxFromString}{\param{const wxString\& }{str}, + \param{wxColour* }{col}} + +\func{bool}{wxFromString}{\param{const wxString\& }{str}, + \param{wxFont* }{col}} + +Converts string to the type of the second argument. Returns \true on success. +See also: \helpref{wxToString}{wxtostring}. + + \membersection{::wxGetActiveWindow}\label{wxgetactivewindow} \func{wxWindow *}{wxGetActiveWindow}{\void} -Gets the currently active window (Windows only). +Gets the currently active window (implemented for MSW and GTK only currently, +always returns \NULL in the other ports). + +\wxheading{Include files} + + + + +\membersection{::wxGetBatteryState}\label{wxgetbatterystate} + +\func{wxBatteryState}{wxGetBatteryState}{\void} + +Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE}, +\texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE}, +\texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}. +\texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where +this feature is not implemented (currently everywhere but MS Windows). \wxheading{Include files} - + \membersection{::wxGetDisplayName}\label{wxgetdisplayname} @@ -2779,6 +3311,20 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa +\membersection{::wxGetPowerType}\label{wxgetpowertype} + +\func{wxPowerType}{wxGetPowerType}{\void} + +Returns the type of power source as one of \texttt{wxPOWER\_SOCKET}, +\texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}. +\texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this +feature is not implemented (currently everywhere but MS Windows). + +\wxheading{Include files} + + + + \membersection{::wxGetMousePosition}\label{wxgetmouseposition} \func{wxPoint}{wxGetMousePosition}{\void} @@ -2790,39 +3336,76 @@ Returns the mouse position in screen coordinates. -\membersection{::wxGetResource}\label{wxgetresource} +\membersection{::wxGetMouseState}\label{wxgetmousestate} + +\func{wxMouseState}{wxGetMouseState}{\void} + +Returns the current state of the mouse. Returns a wxMouseState +instance that contains the current position of the mouse pointer in +screen coordinants, as well as boolean values indicating the up/down +status of the mouse buttons and the modifier keys. + +\wxheading{Include files} + + + +wxMouseState has the following interface: + +\begin{verbatim} +class wxMouseState +{ +public: + wxMouseState(); + + wxCoord GetX(); + wxCoord GetY(); + + bool LeftDown(); + bool MiddleDown(); + bool RightDown(); + + bool ControlDown(); + bool ShiftDown(); + bool AltDown(); + bool MetaDown(); + bool CmdDown(); + + void SetX(wxCoord x); + void SetY(wxCoord y); + + void SetLeftDown(bool down); + void SetMiddleDown(bool down); + void SetRightDown(bool down); + + void SetControlDown(bool down); + void SetShiftDown(bool down); + void SetAltDown(bool down); + void SetMetaDown(bool down); +}; +\end{verbatim} -\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}} -\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{float *}{value}, \param{const wxString\& }{file = NULL}} -\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{long *}{value}, \param{const wxString\& }{file = NULL}} +\membersection{::wxGetStockLabel}\label{wxgetstocklabel} -\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{int *}{value}, \param{const wxString\& }{file = NULL}} +\func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}} -Gets a resource value from the resource database (for example, WIN.INI, or -.Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used, -otherwise the specified file is used. +Returns label that should be used for given {\it id} element. + +\wxheading{Parameters} -Under X, if an application class (wxApp::GetClassName) has been defined, -it is appended to the string /usr/lib/X11/app-defaults/ to try to find -an applications default file when merging all resource databases. +\docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.} -The reason for passing the result in an argument is that it -can be convenient to define a default value, which gets overridden -if the value exists in the resource file. It saves a separate -test for that resource's existence, and it also allows -the overloading of the function for different types. +\docparam{withCodes}{if false then strip accelerator code from the label; +usefull for getting labels without accelerator char code like for toolbar tooltip or +under platforms without traditional keyboard like smartphones} -See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}. +\docparam{accelerator}{optional accelerator string automatically added to label; useful +for building labels for \helpref{wxMenuItem}{wxmenuitem}} \wxheading{Include files} - + \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent} @@ -2837,6 +3420,28 @@ frame or dialog containing it, or {\tt NULL}. +\membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser} + +\func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}} + +Open the \arg{url} in user's default browser. If \arg{flags} parameter contains +\texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL +(currently this is only supported under Windows). The \arg{url} may also be a +local file path (with or without \texttt{file://} prefix), if it doesn't +correspond to an existing file and the URL has no scheme \texttt{http://} is +prepended to it by default. + +Returns \true if the application was successfully launched. + +Note that for some configurations of the running user, the application which +is launched to open the given URL may be URL-dependent (e.g. a browser may be used for +local URLs while another one may be used for remote URLs). + +\wxheading{Include files} + + + + \membersection{::wxLoadUserResource}\label{wxloaduserresource} \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}} @@ -2908,24 +3513,91 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}. \membersection{::wxStripMenuCodes}\label{wxstripmenucodes} -\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}} - -\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}} +\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{str}, \param{int }{flags = wxStrip\_All}} -{\bf NB:} This function is obsolete, please use -\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead. +Strips any menu codes from \arg{str} and returns the result. -Strips any menu codes from {\it in} and places the result -in {\it out} (or returns the new string, in the first form). +By default, the functions strips both the mnemonics character (\texttt{'\&'}) +which is used to indicate a keyboard shortkey, and the accelerators, which are +used only in the menu items and are separated from the main text by the +\texttt{$\backslash$t} (TAB) character. By using \arg{flags} of +\texttt{wxStrip\_Mnemonics} or \texttt{wxStrip\_Accel} to strip only the former +or the latter part, respectively. -Menu codes include \& (mark the next character with an underline -as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows). +Notice that in most cases +\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} or +\helpref{wxControl::GetLabelText}{wxcontrolgetlabeltext} can be used instead. \wxheading{Include files} +\membersection{wxSTRINGIZE}\label{wxstringize} + +\func{}{wxSTRINGIZE}{\param{}{x}} + +Returns the string representation of the given symbol which can be either a +literal or a macro (hence the advantage of using this macro instead of the +standard preprocessor \texttt{\#} operator which doesn't work with macros). + +Notice that this macro always produces a \texttt{char} string, use +\helpref{wxSTRINGIZE\_T}{wxstringizet} to build a wide string Unicode build. + +\wxheading{See also} + +\helpref{wxCONCAT}{wxconcat} + + +\membersection{wxSTRINGIZE\_T}\label{wxstringizet} + +\func{}{wxSTRINGIZE\_T}{\param{}{x}} + +Returns the string representation of the given symbol as either an ASCII or +Unicode string, depending on the current build. This is the Unicode-friendly +equivalent of \helpref{wxSTRINGIZE}{wxstringize}. + + +\membersection{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}\label{wxsuppressgccprivatedtorwarning} + +\func{}{wxSUPPRESS\_GCC\_PRIVATE\_DTOR\_WARNING}{\param{}{name}} + +GNU C++ compiler gives a warning for any class whose destructor is private +unless it has a friend. This warning may sometimes be useful but it doesn't +make sense for reference counted class which always delete themselves (hence +destructor should be private) but don't necessarily have any friends, so this +macro is provided to disable the warning in such case. The \arg{name} parameter +should be the name of the class but is only used to construct a unique friend +class name internally. Example of using the macro: + +\begin{verbatim} + class RefCounted + { + public: + RefCounted() { m_nRef = 1; } + void IncRef() { m_nRef++ ; } + void DecRef() { if ( !--m_nRef ) delete this; } + + private: + ~RefCounted() { } + + wxSUPPRESS_GCC_PRIVATE_DTOR(RefCounted) + }; +\end{verbatim} + +Notice that there should be no semicolon after this macro. + + +\membersection{wxToString}\label{wxtostring} + +\func{wxString}{wxToString}{\param{const wxColour\& }{col}} + +\func{wxString}{wxToString}{\param{const wxFont\& }{col}} + +Converts its argument to string. +See also: \helpref{wxFromString}{wxfromstring}. + + \membersection{wxULL}\label{wxull} \func{wxLongLong\_t}{wxULL}{\param{}{number}} @@ -2948,36 +3620,27 @@ allows to define unsigned 64 bit compile time constants: \helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong} -\membersection{::wxWriteResource}\label{wxwriteresource} - -\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}} +\membersection{wxVaCopy}\label{wxvacopy} -\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{float }{value}, \param{const wxString\& }{file = NULL}} +\func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}} -\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{long }{value}, \param{const wxString\& }{file = NULL}} +This macro is the same as the standard C99 \texttt{va\_copy} for the compilers +which support it or its replacement for those that don't. It must be used to +preserve the value of a \texttt{va\_list} object if you need to use it after +passing it to another function because it can be modified by the latter. -\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, - \param{int }{value}, \param{const wxString\& }{file = NULL}} +As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching +\texttt{va\_end}. -Writes a resource value into the resource database (for example, WIN.INI, or -.Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used, -otherwise the specified file is used. -Under X, the resource databases are cached until the internal function -\rtfsp{\bf wxFlushResources} is called automatically on exit, when -all updated resource databases are written to their files. -Note that it is considered bad manners to write to the .Xdefaults -file under Unix, although the WIN.INI file is fair game under Windows. +\membersection{\_\_WXFUNCTION\_\_}\label{wxfunction} -See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}. - -\wxheading{Include files} +\func{}{\_\_WXFUNCTION\_\_}{\void} - +This macro expands to the name of the current function if the compiler supports +any of \texttt{\_\_FUNCTION\_\_}, \texttt{\_\_func\_\_} or equivalent variables +or macros or to \NULL if none of them is available. @@ -3046,7 +3709,7 @@ data in big-endian format. \section{RTTI functions}\label{rttimacros} -wxWindows uses its own RTTI ("run-time type identification") system which +wxWidgets uses its own RTTI ("run-time type identification") system which predates the current standard C++ RTTI and so is kept for backwards compatibility reasons but also because it allows some things which the standard RTTI doesn't directly support (such as creating a class from its @@ -3054,7 +3717,7 @@ name). The standard C++ RTTI can be used in the user code without any problems and in general you shouldn't need to use the functions and the macros in this section -unless you are thinking of modifying or adding any wxWindows classes. +unless you are thinking of modifying or adding any wxWidgets classes. \wxheading{See also} @@ -3103,9 +3766,9 @@ class wxCommand: public wxObject \func{}{DECLARE\_APP}{className} -This is used in headers to create a forward declaration of the -\helpref{wxGetApp}{wxgetapp} function implemented by -\helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration +This is used in headers to create a forward declaration of the +\helpref{wxGetApp}{wxgetapp} function implemented by +\helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration {\tt className\& wxGetApp(void)}. Example: @@ -3136,8 +3799,11 @@ dynamically. The same as DECLARE\_ABSTRACT\_CLASS. \func{}{DECLARE\_DYNAMIC\_CLASS}{className} -Used inside a class declaration to declare that the objects of this class should be dynamically -creatable from run-time type information. +Used inside a class declaration to make the class known to wxWidgets RTTI +system and also declare that the objects of this class should be dynamically +creatable from run-time type information. Notice that this implies that the +class should have a default constructor, if this is not the case consider using +\helpref{DECLARE\_CLASS}{declareclass}. Example: @@ -3198,7 +3864,7 @@ a class that has run-time type information and two base classes. The same as IMP \func{}{IMPLEMENT\_APP}{className} This is used in the application class implementation file to make the application class known to -wxWindows for dynamic construction. You use this instead of +wxWidgets for dynamic construction. You use this instead of Old form: @@ -3354,7 +4020,7 @@ Example: \helpref{RTTI overview}{runtimeclassoverview}\\ \helpref{wxDynamicCastThis}{wxdynamiccastthis}\\ \helpref{wxConstCast}{wxconstcast}\\ -\helpref{wxStatiicCast}{wxstaticcast} +\helpref{wxStaticCast}{wxstaticcast} \membersection{wxDynamicCastThis}\label{wxdynamiccastthis} @@ -3363,7 +4029,7 @@ Example: This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the latter provokes spurious compilation warnings from some compilers (because it -tests whether {\tt this} pointer is non {\tt NULL} which is always true), so +tests whether {\tt this} pointer is non-{\tt NULL} which is always true), so this macro should be used to avoid them. \wxheading{See also} @@ -3390,21 +4056,35 @@ result of executing an equivalent of {\tt static\_cast(ptr)}. \func{T}{wx\_const\_cast}{T, x} -Same as \texttt{const\_cast(x)} if the compiler supports const cast or +Same as \texttt{const\_cast(x)} if the compiler supports const cast or \texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast}, the cast it to the type \arg{T} and not to \texttt{T *} and also the order of arguments is the same as for the standard cast. \wxheading{See also} -\helpref{wx\_static\_cast}{wxstaticcastraw}\\ +\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\ +\helpref{wx\_static\_cast}{wxstaticcastraw} + + +\membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw} + +\func{T}{wx\_reinterpret\_cast}{T, x} + +Same as \texttt{reinterpret\_cast(x)} if the compiler supports reinterpret cast or +\texttt{(T)x} for old compilers. + +\wxheading{See also} + +\helpref{wx\_const\_cast}{wxconstcastraw},\\ +\helpref{wx\_static\_cast}{wxstaticcastraw} \membersection{wx\_static\_cast}\label{wxstaticcastraw} \func{T}{wx\_static\_cast}{T, x} -Same as \texttt{static\_cast(x)} if the compiler supports static cast or +Same as \texttt{static\_cast(x)} if the compiler supports static cast or \texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast}, there are no checks being done and the meaning of the macro arguments is exactly the same as for the standard static cast, i.e. \arg{T} is the full type name and @@ -3412,8 +4092,21 @@ star is not appended to it. \wxheading{See also} -\helpref{wx\_const\_cast}{wxconstcastraw}\\ +\helpref{wx\_const\_cast}{wxconstcastraw},\\ +\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\ +\helpref{wx\_truncate\_cast}{wxtruncatecast} + + +\membersection{wx\_truncate\_cast}\label{wxtruncatecast} + +\func{T}{wx\_truncate\_cast}{T, x} + +This case doesn't correspond to any standard cast but exists solely to make +casts which possibly result in a truncation of an integer value more readable. + +\wxheading{See also} +\helpref{wx\_static\_cast}{wxstaticcastraw} \section{Log functions}\label{logfunctions} @@ -3421,7 +4114,7 @@ star is not appended to it. These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for further information. The functions use (implicitly) the currently active log target, so their descriptions here may not apply if the log target is not the -standard one (installed by wxWindows in the beginning of the program). +standard one (installed by wxWidgets in the beginning of the program). \wxheading{Include files} @@ -3455,14 +4148,14 @@ instead. \membersection{::wxError}\label{wxerror} -\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} +\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}} {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror} instead. 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}. +wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}. \wxheading{Include files} @@ -3471,14 +4164,14 @@ wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. \membersection{::wxFatalError}\label{wxfatalerror} -\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}} +\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}} {\bf NB:} This function is now obsolete, please use \helpref{wxLogFatalError}{wxlogfatalerror} instead. 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}. +wxWidgets errors. See also \helpref{wxError}{wxerror}. \wxheading{Include files} @@ -3524,11 +4217,7 @@ the program work. \func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}} For all normal, informational messages. They also appear in a message box by -default (but it can be changed). Notice that the standard behaviour is to not -show informational messages if there are any errors later - the logic being -that the later error messages make the informational messages preceding them -meaningless. - +default (but it can be changed). \membersection{::wxLogVerbose}\label{wxlogverbose} @@ -3564,7 +4253,7 @@ If the target frame doesn't have a statusbar, the message will be lost. \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}} -Mostly used by wxWindows itself, but might be handy for logging errors after +Mostly used by wxWidgets itself, but might be handy for logging errors after system call (API function) failure. It logs the specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending on the platform) and the corresponding error message. The second form @@ -3617,7 +4306,7 @@ the mask has been previously enabled by the call to \helpref{AddTraceMask}{wxlogaddtracemask} or by setting \helpref{{\tt WXTRACE} environment variable}{envvars}. The predefined string trace masks -used by wxWindows are: +used by wxWidgets are: \begin{itemize}\itemsep=0pt \item wxTRACE\_MemAlloc: trace memory allocation (new/delete) @@ -3627,7 +4316,14 @@ used by wxWindows are: \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only) \end{itemize} -The third version of the function only logs the message if all the bit +{\bf Caveats:} since both the mask and the format string are strings, +this might lead to function signature confusion in some cases: +if you intend to call the format string only version of wxLogTrace, +then add a \%s format string parameter and then supply a second string parameter for that \%s, the string mask version of wxLogTrace will erroneously get called instead, since you are supplying two string parameters to the function. +In this case you'll unfortunately have to avoid having two leading +string parameters, e.g. by adding a bogus integer (with its \%d format string). + +The third version of the function only logs the message if all the bits corresponding to the {\it mask} are set in the wxLog trace mask which can be set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less flexible than the previous one because it doesn't allow defining the user @@ -3766,29 +4462,8 @@ this value. \section{Time functions}\label{timefunctions} -The functions in this section deal with getting the current time and -starting/stopping the global timers. Please note that the timer functions are -deprecated because they work with one global timer only and -\helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes -should be used instead. For retrieving the current time, you may also use -\helpref{wxDateTime::Now}{wxdatetimenow} or -\helpref{wxDateTime::UNow}{wxdatetimeunow} methods. - - -\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime} - -\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}} - -Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}. - -If {\it resetTimer} is true (the default), the timer is reset to zero -by this call. - -See also \helpref{wxTimer}{wxtimer}. - -\wxheading{Include files} - - +The functions in this section deal with getting the current time and sleeping +for the specified time interval. \membersection{::wxGetLocalTime}\label{wxgetlocaltime} @@ -3803,7 +4478,7 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970. \wxheading{Include files} - + \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis} @@ -3819,7 +4494,7 @@ Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970. \wxheading{Include files} - + \membersection{::wxGetUTCTime}\label{wxgetutctime} @@ -3834,62 +4509,73 @@ Returns the number of seconds since GMT 00:00:00 Jan 1st 1970. \wxheading{Include files} - + -\membersection{::wxNow}\label{wxnow} +\membersection{::wxMicroSleep}\label{wxmicrosleep} -\func{wxString}{wxNow}{\void} +\func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}} -Returns a string representing the current date and time. +Sleeps for the specified number of microseconds. The microsecond resolution may +not, in fact, be available on all platforms (currently only Unix platforms with +nanosleep(2) may provide it) in which case this is the same as +\helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$). \wxheading{Include files} -\membersection{::wxSleep}\label{wxsleep} +\membersection{::wxMilliSleep}\label{wxmillisleep} -\func{void}{wxSleep}{\param{int}{ secs}} +\func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}} -Sleeps for the specified number of seconds. +Sleeps for the specified number of milliseconds. Notice that usage of this +function is encouraged instead of calling usleep(3) directly because the +standard usleep() function is not MT safe. \wxheading{Include files} -\membersection{::wxStartTimer}\label{wxstarttimer} - -\func{void}{wxStartTimer}{\void} +\membersection{::wxNow}\label{wxnow} -Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time. +\func{wxString}{wxNow}{\void} -See also \helpref{wxTimer}{wxtimer}. +Returns a string representing the current date and time. \wxheading{Include files} - + -\membersection{::wxUsleep}\label{wxusleep} +\membersection{::wxSleep}\label{wxsleep} -\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} +\func{void}{wxSleep}{\param{int}{ secs}} -Sleeps for the specified number of milliseconds. Notice that usage of this -function is encouraged instead of calling usleep(3) directly because the -standard usleep() function is not MT safe. +Sleeps for the specified number of seconds. \wxheading{Include files} +\membersection{::wxUsleep}\label{wxusleep} + +\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} + +This function is deprecated because its name is misleading: notice that the +argument is in milliseconds, not microseconds. Please use either +\helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep} +depending on the resolution you need. + + \section{Debugging macros and functions}\label{debugmacros} Useful macros and functions for error checking and defensive programming. -wxWindows defines three families of the assert-like macros: +wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined (in other words, in the debug build) but disappear completely in the release build. On the other hand, the wxCHECK macros stay event in release builds but a @@ -3904,7 +4590,7 @@ compilation error messages if the condition they check fail. \membersection{::wxOnAssert}\label{wxonassert} -\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}} +\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}} This function is called whenever one of debugging macros fails (i.e. condition is false in an assertion). It is only defined in the debug mode, in release @@ -3913,7 +4599,7 @@ builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything. To override the default behaviour in the debug builds which is to show the user a dialog asking whether he wants to abort the program, continue or continue ignoring any subsequent assert failures, you may override -\helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if +\helpref{wxApp::OnAssertFailure}{wxapponassertfailure} which is called by this function if the global application object exists. @@ -3984,8 +4670,8 @@ either change the line in which either of them appears on or use the \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro. Also note that Microsoft Visual C++ has a bug which results in compiler errors -if you use this macro with ``Program Database For Edit And Continue'' -(\texttt{/ZI}) option, so you shouldn't use it (``Program Database'' +if you use this macro with `Program Database For Edit And Continue' +(\texttt{/ZI}) option, so you shouldn't use it (`Program Database' (\texttt{/Zi}) is ok though) for the code making use of this macro. \wxheading{See also} @@ -4043,7 +4729,7 @@ This check is done even in release mode. Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). This check is done even in release mode. -This macro may be only used in non void functions, see also +This macro may be only used in non-void functions, see also \helpref{wxCHECK\_RET}{wxcheckret}. @@ -4099,11 +4785,10 @@ In release mode this function does nothing. \func{bool}{wxIsDebuggerRunning}{\void} -Returns {\tt true} if the program is running under debugger, {\tt false} -otherwise. +Returns \true if the program is running under debugger, \false otherwise. -Please note that this function is currently only implemented for Mac builds -using CodeWarrior and always returns {\tt false} elsewhere. +Please note that this function is currently only implemented for Win32 and Mac +builds using CodeWarrior and always returns \false elsewhere. @@ -4141,17 +4826,21 @@ Returns the current value of the environment variable {\it var} in {\it value}. {\it value} may be {\tt NULL} if you just want to know if the variable exists and are not interested in its value. -Returns {\tt true} if the variable exists, {\tt false} otherwise. +Returns \true if the variable exists, \false otherwise. \membersection{wxSetEnv}\label{wxsetenv} -\func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}} +\func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxString\& }{value}} Sets the value of the environment variable {\it var} (adding it if necessary) to {\it value}. -Returns {\tt true} on success. +Returns \true on success. + +\wxheading{See also} + +\helpref{wxUnsetEnv}{wxunsetenv} \membersection{wxUnsetEnv}\label{wxunsetenv} @@ -4162,5 +4851,47 @@ Removes the variable {\it var} from the environment. \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this function. -Returns {\tt true} on success. +Returns \true on success. + +\wxheading{See also} + +\helpref{wxSetEnv}{wxsetenv} + + +\section{Atomic operations}\label{atomicoperations} + +When using multi-threaded applications, it is often required to access or +modify memory which is shared between threads. Atomic integer and pointer +operations are an efficient way to handle this issue (another, less efficient, +way is to use a \helpref{mutex}{wxmutex} or \helpref{critical +section}{wxcriticalsection}). A native implementation exists for Windows, +Linux, Solaris and Mac OS X, for other OS, a +\helpref{wxCriticalSection}{wxcriticalsection} is used to protect the data. + +One particular application is reference counting (used by so-called smart +pointers). + +You should define your variable with the type wxAtomicInt in order to apply +atomic operations to it. + +\wxheading{Include files} + + + +\membersection{::wxAtomicInc}\label{wxatomicinc} + +\func{void}{wxAtomicInc}{\param{wxAtomicInt\& }{value}} + +This function increments \arg{value} in an atomic manner. + + +\membersection{::wxAtomicDec}\label{wxatomicdec} + +\func{wxInt32}{wxAtomicDec}{\param{wxAtomicInt\& }{value}} + +This function decrements \arg{value} in an atomic manner. + +Returns 0 if \arg{value} is 0 after decrementation or any non-zero value (not +necessarily equal to the value of the variable) otherwise. +