@li @ref page_func_cat_dialog
@li @ref page_func_cat_math
@li @ref page_func_cat_gdi
-@li @ref page_func_cat_printer
@li @ref page_func_cat_clipboard
@li @ref page_func_cat_log
@li @ref page_func_cat_time
The functions in this section are used on application startup/shutdown and also
to control the behaviour of the main event loop of the GUI programs.
-@li ::wxEntry()
-@li ::wxEntryCleanup()
-@li ::wxEntryStart()
-@li ::wxGetApp()
-@li ::wxHandleFatalExceptions()
-@li ::wxInitAllImageHandlers()
-@li ::wxInitialize()
-@li ::wxSafeYield()
-@li ::wxUninitialize()
-@li ::wxYield()
-@li ::wxWakeUpIdle()
+@li wxEntry()
+@li wxEntryCleanup()
+@li wxEntryStart()
+@li wxGetApp()
+@li wxHandleFatalExceptions()
+@li wxInitAllImageHandlers()
+@li wxInitialize()
+@li wxSafeYield()
+@li wxUninitialize()
+@li wxYield()
+@li wxWakeUpIdle()
@section page_func_cat_procctrl Process Control
The functions in this section are used to launch or terminate the other
processes.
-@li ::wxExecute()
-@li ::wxExit()
-@li ::wxJoin()
-@li ::wxKill()
-@li ::wxGetProcessId()
-@li ::wxShell()
-@li ::wxShutdown()
+@li wxExecute()
+@li wxExit()
+@li wxJoin()
+@li wxKill()
+@li wxGetProcessId()
+@li wxShell()
+@li wxShutdown()
@section page_func_cat_thread Threads
@sa wxThread, wxMutex, @ref overview_thread
-@li ::wxIsMainThread()
-@li ::wxMutexGuiEnter()
-@li ::wxMutexGuiLeave()
+@li wxIsMainThread()
+@li wxMutexGuiEnter()
+@li wxMutexGuiLeave()
@section page_func_cat_file Files and Directories
@sa wxPathList, wxDir, wxFile, wxFileName
-@li ::wxDos2UnixFilename()
-@li ::wxFileExists()
-@li ::wxFileModificationTime()
-@li ::wxFileNameFromPath()
-@li ::wxFindFirstFile()
-@li ::wxFindNextFile()
-@li ::wxGetDiskSpace()
-@li ::wxGetFileKind()
-@li ::wxGetOSDirectory()
-@li ::wxIsAbsolutePath()
-@li ::wxDirExists()
-@li ::wxPathOnly()
-@li ::wxUnix2DosFilename()
-@li ::wxConcatFiles()
-@li ::wxCopyFile()
-@li ::wxGetCwd()
-@li ::wxGetWorkingDirectory()
-@li ::wxGetTempFileName()
-@li ::wxIsWild()
-@li ::wxMatchWild()
-@li ::wxMkdir()
-@li ::wxParseCommonDialogsFilter()
-@li ::wxRemoveFile()
-@li ::wxRenameFile()
-@li ::wxRmdir()
-@li ::wxSetWorkingDirectory()
-@li ::wxSplit()
-@li ::wxSplitPath()
-@li ::wxTransferFileToStream()
-@li ::wxTransferStreamToFile()
+@li wxDos2UnixFilename()
+@li wxFileExists()
+@li wxFileModificationTime()
+@li wxFileNameFromPath()
+@li wxFindFirstFile()
+@li wxFindNextFile()
+@li wxGetDiskSpace()
+@li wxGetFileKind()
+@li wxGetOSDirectory()
+@li wxIsAbsolutePath()
+@li wxDirExists()
+@li wxPathOnly()
+@li wxUnix2DosFilename()
+@li wxConcatFiles()
+@li wxCopyFile()
+@li wxGetCwd()
+@li wxGetWorkingDirectory()
+@li wxGetTempFileName()
+@li wxIsWild()
+@li wxMatchWild()
+@li wxMkdir()
+@li wxParseCommonDialogsFilter()
+@li wxRemoveFile()
+@li wxRenameFile()
+@li wxRmdir()
+@li wxSetWorkingDirectory()
+@li wxSplit()
+@li wxSplitPath()
+@li wxTransferFileToStream()
+@li wxTransferStreamToFile()
@section page_func_cat_networkuseros Network, User and OS
The functions in this section are used to retrieve information about the
current computer and/or user characteristics.
-@li ::wxGetEmailAddress()
-@li ::wxGetFreeMemory()
-@li ::wxGetFullHostName()
-@li ::wxGetHomeDir()
-@li ::wxGetHostName()
-@li ::wxGetOsDescription()
-@li ::wxGetOsVersion()
-@li ::wxIsPlatformLittleEndian()
-@li ::wxIsPlatform64Bit()
-@li ::wxGetUserHome()
-@li ::wxGetUserId()
-@li ::wxGetUserName()
+@li wxGetEmailAddress()
+@li wxGetFreeMemory()
+@li wxGetFullHostName()
+@li wxGetHomeDir()
+@li wxGetHostName()
+@li wxGetOsDescription()
+@li wxGetOsVersion()
+@li wxIsPlatformLittleEndian()
+@li wxIsPlatform64Bit()
+@li wxGetUserHome()
+@li wxGetUserId()
+@li wxGetUserName()
@section page_func_cat_string Strings
-@li ::wxGetTranslation()
-@li ::wxIsEmpty()
-@li ::wxStrcmp()
-@li ::wxStricmp()
-@li ::wxStringEq()
-@li ::wxStringMatch()
-@li ::wxStringTokenize()
-@li ::wxStrlen()
-@li ::wxSnprintf()
-@li ::wxVsnprintf()
+@li wxGetTranslation()
+@li wxIsEmpty()
+@li wxStrcmp()
+@li wxStricmp()
+@li wxStringEq()
+@li wxStringMatch()
+@li wxStringTokenize()
+@li wxStrlen()
+@li wxSnprintf()
+@li wxVsnprintf()
@section page_func_cat_dialog Dialogs
(in MS Windows or Motif) the wrong window frame may be brought to the front when
the dialog box is popped up.
-@li ::wxAboutBox()
-@li ::wxBeginBusyCursor()
-@li ::wxBell()
-@li ::wxCreateFileTipProvider()
-@li ::wxDirSelector()
-@li ::wxFileSelector()
-@li ::wxEndBusyCursor()
-@li ::wxGenericAboutBox()
-@li ::wxGetColourFromUser()
-@li ::wxGetFontFromUser()
-@li ::wxGetMultipleChoices()
-@li ::wxGetNumberFromUser()
-@li ::wxGetPasswordFromUser()
-@li ::wxGetTextFromUser()
-@li ::wxGetSingleChoice()
-@li ::wxGetSingleChoiceIndex()
-@li ::wxGetSingleChoiceData()
-@li ::wxInfoMessageBox()
-@li ::wxIsBusy()
-@li ::wxMessageBox()
-@li ::wxShowTip()
+@li wxAboutBox()
+@li wxBeginBusyCursor()
+@li wxBell()
+@li wxCreateFileTipProvider()
+@li wxDirSelector()
+@li wxFileSelector()
+@li wxEndBusyCursor()
+@li wxGenericAboutBox()
+@li wxGetColourFromUser()
+@li wxGetFontFromUser()
+@li wxGetMultipleChoices()
+@li wxGetNumberFromUser()
+@li wxGetPasswordFromUser()
+@li wxGetTextFromUser()
+@li wxGetSingleChoice()
+@li wxGetSingleChoiceIndex()
+@li wxGetSingleChoiceData()
+@li wxInfoMessageBox()
+@li wxIsBusy()
+@li wxMessageBox()
+@li wxShowTip()
@section page_func_cat_math Math
@header{wx/math.h}
-@li ::wxFinite()
-@li ::wxIsNaN()
+@li wxFinite()
+@li wxIsNaN()
@section page_func_cat_gdi Graphics Device Interface
@header{wx/gdicmn.h}
-@li ::wxBITMAP()
-@li ::wxClientDisplayRect()
-@li ::wxColourDisplay()
-@li ::wxDisplayDepth()
-@li ::wxDisplaySize()
-@li ::wxDisplaySizeMM()
-@li ::wxDROP_ICON()
-@li ::wxICON()
-@li ::wxMakeMetafilePlaceable()
-@li ::wxSetCursor()
-
-
-@section page_func_cat_printer Printing
-
-@warning These functions are deprecated and should no longer be used.
-
-The following functions are used to control PostScript printing. Under Windows,
-PostScript output can only be sent to a file.
-
-@header{wx/dcps.h}
-
-@li ::wxGetPrinterCommand()
-@li ::wxGetPrinterFile()
-@li ::wxGetPrinterMode()
-@li ::wxGetPrinterOptions()
-@li ::wxGetPrinterOrientation()
-@li ::wxGetPrinterPreviewCommand()
-@li ::wxGetPrinterScaling()
-@li ::wxGetPrinterTranslation()
-@li ::wxSetPrinterCommand()
-@li ::wxSetPrinterFile()
-@li ::wxSetPrinterMode()
-@li ::wxSetPrinterOptions()
-@li ::wxSetPrinterOrientation()
-@li ::wxSetPrinterPreviewCommand()
-@li ::wxSetPrinterScaling()
-@li ::wxSetPrinterTranslation()
+@li wxBITMAP()
+@li wxClientDisplayRect()
+@li wxColourDisplay()
+@li wxDisplayDepth()
+@li wxDisplaySize()
+@li wxDisplaySizeMM()
+@li wxDROP_ICON()
+@li wxICON()
+@li wxMakeMetafilePlaceable()
+@li wxSetCursor()
@section page_func_cat_clipboard Clipboard
@header{wx/clipbrd.h}
-@li ::wxClipboardOpen()
-@li ::wxCloseClipboard()
-@li ::wxEmptyClipboard()
-@li ::wxEnumClipboardFormats()
-@li ::wxGetClipboardData()
-@li ::wxGetClipboardFormatName()
-@li ::wxIsClipboardFormatAvailable()
-@li ::wxOpenClipboard()
-@li ::wxRegisterClipboardFormat()
-@li ::wxSetClipboardData()
+@li wxClipboardOpen()
+@li wxCloseClipboard()
+@li wxEmptyClipboard()
+@li wxEnumClipboardFormats()
+@li wxGetClipboardData()
+@li wxGetClipboardFormatName()
+@li wxIsClipboardFormatAvailable()
+@li wxOpenClipboard()
+@li wxRegisterClipboardFormat()
+@li wxSetClipboardData()
@section page_func_cat_log Logging
@header{wx/log.h}
-@li ::wxDebugMsg()
-@li ::wxError()
-@li ::wxFatalError()
-@li ::wxLogError()
-@li ::wxLogFatalError()
-@li ::wxLogWarning()
-@li ::wxLogMessage()
-@li ::wxLogVerbose()
-@li ::wxLogStatus()
-@li ::wxLogSysError()
-@li ::wxLogDebug()
-@li ::wxLogTrace()
-@li ::wxSafeShowMessage()
-@li ::wxSysErrorCode()
-@li ::wxSysErrorMsg()
-@li ::wxTrace()
-@li ::wxTraceLevel()
+@li wxDebugMsg()
+@li wxError()
+@li wxFatalError()
+@li wxLogError()
+@li wxLogFatalError()
+@li wxLogWarning()
+@li wxLogMessage()
+@li wxLogVerbose()
+@li wxLogStatus()
+@li wxLogSysError()
+@li wxLogDebug()
+@li wxLogTrace()
+@li wxSafeShowMessage()
+@li wxSysErrorCode()
+@li wxSysErrorMsg()
+@li wxTrace()
+@li wxTraceLevel()
@section page_func_cat_time Time
The functions in this section deal with getting the current time and sleeping
for the specified time interval.
-@li ::wxGetLocalTime()
-@li ::wxGetLocalTimeMillis()
-@li ::wxGetUTCTime()
-@li ::wxMicroSleep()
-@li ::wxMilliSleep()
-@li ::wxNow()
-@li ::wxSleep()
-@li ::wxUsleep()
+@li wxGetLocalTime()
+@li wxGetLocalTimeMillis()
+@li wxGetUTCTime()
+@li wxMicroSleep()
+@li wxMilliSleep()
+@li wxNow()
+@li wxSleep()
+@li wxUsleep()
@section page_func_cat_debug Debugging
@header{wx/debug.h}
-@li ::wxOnAssert()
-@li ::wxTrap()
-@li ::wxIsDebuggerRunning()
+@li wxOnAssert()
+@li wxTrap()
+@li wxIsDebuggerRunning()
@section page_func_cat_env Environment
@header{wx/utils.h}
-@li ::wxGetenv()
-@li ::wxGetEnv()
-@li ::wxSetEnv()
-@li ::wxUnsetEnv()
+@li wxGetenv()
+@li wxGetEnv()
+@li wxSetEnv()
+@li wxUnsetEnv()
@section page_func_cat_atomic Atomic Operations
@header{wx/atomic.h}
-@li ::wxAtomicInc()
-@li ::wxAtomicDec()
+@li wxAtomicInc()
+@li wxAtomicDec()
@section page_func_cat_misc Miscellaneous
-@li ::wxBase64Decode()
-@li ::wxBase64DecodedSize()
-@li ::wxBase64Encode()
-@li ::wxBase64EncodedSize()
-@li ::wxGetKeyState()
-@li ::wxNewId()
-@li ::wxRegisterId()
-@li ::wxDDECleanUp()
-@li ::wxDDEInitialize()
-@li ::wxEnableTopLevelWindows()
-@li ::wxFindMenuItemId()
-@li ::wxFindWindowByLabel()
-@li ::wxFindWindowByName()
-@li ::wxFindWindowAtPoint()
-@li ::wxFindWindowAtPointer()
-@li ::wxGetActiveWindow()
-@li ::wxGetBatteryState()
-@li ::wxGetDisplayName()
-@li ::wxGetPowerType()
-@li ::wxGetMousePosition()
-@li ::wxGetMouseState()
-@li ::wxGetStockLabel()
-@li ::wxGetTopLevelParent()
-@li ::wxLaunchDefaultBrowser()
-@li ::wxLoadUserResource()
-@li ::wxPostDelete()
-@li ::wxPostEvent()
-@li ::wxSetDisplayName()
-@li ::wxStripMenuCodes()
+@li wxBase64Decode()
+@li wxBase64DecodedSize()
+@li wxBase64Encode()
+@li wxBase64EncodedSize()
+@li wxGetKeyState()
+@li wxNewId()
+@li wxRegisterId()
+@li wxDDECleanUp()
+@li wxDDEInitialize()
+@li wxEnableTopLevelWindows()
+@li wxFindMenuItemId()
+@li wxFindWindowByLabel()
+@li wxFindWindowByName()
+@li wxFindWindowAtPoint()
+@li wxFindWindowAtPointer()
+@li wxGetActiveWindow()
+@li wxGetBatteryState()
+@li wxGetDisplayName()
+@li wxGetPowerType()
+@li wxGetMousePosition()
+@li wxGetMouseState()
+@li wxGetStockLabel()
+@li wxGetTopLevelParent()
+@li wxLaunchDefaultBrowser()
+@li wxLoadUserResource()
+@li wxPostDelete()
+@li wxPostEvent()
+@li wxSetDisplayName()
+@li wxStripMenuCodes()
*/
The following constants are defined in wxWidgets:
-@li wxMAJOR_VERSION is the major version of wxWidgets
-@li wxMINOR_VERSION is the minor version of wxWidgets
-@li wxRELEASE_NUMBER is the release number
-@li wxSUBRELEASE_NUMBER is the subrelease number which is @c 0 for all
- official releases
+@beginDefList
+@itemdef{ wxMAJOR_VERSION, The major version of wxWidgets }
+@itemdef{ wxMINOR_VERSION, The minor version of wxWidgets }
+@itemdef{ wxRELEASE_NUMBER, The release number }
+@itemdef{ wxSUBRELEASE_NUMBER, The subrelease number which is 0 for all
+ official releases }
+@endDefList
For example, the values or these constants for wxWidgets 2.8.7
are 2, 8, 7 and 0.
@header{wx/version.h}
@header{wx/defs.h}
-@li wxCHECK_GCC_VERSION
-@li wxCHECK_SUNCC_VERSION
-@li wxCHECK_VERSION
-@li wxCHECK_VERSION_FULL
-@li wxCHECK_VISUALC_VERSION
-@li wxCHECK_W32API_VERSION
+@li wxCHECK_GCC_VERSION()
+@li wxCHECK_SUNCC_VERSION()
+@li wxCHECK_VERSION()
+@li wxCHECK_VERSION_FULL()
+@li wxCHECK_VISUALC_VERSION()
+@li wxCHECK_W32API_VERSION()
@section page_macro_cat_misc Miscellaneous
@header{FIXME}
-@li wxCONCAT
-@li wxDECLARE_APP
-@li wxDYNLIB_FUNCTION
-@li wxDEPRECATED
-@li wxDEPRECATED_BUT_USED_INTERNALLY
-@li wxDEPRECATED_INLINE
-@li wxEXPLICIT
-@li wxON_BLOCK_EXIT
-@li wxON_BLOCK_EXIT_OBJ
-@li wxSTRINGIZE
-@li wxSTRINGIZE_T
-@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING
-@li __WXFUNCTION__
-@li wxS
-@li wxT
-@li wxTRANSLATE
-@li _
-@li wxPLURAL
-@li _T
-@li WXTRACE
-@li WXTRACELEVEL
+@li wxCONCAT()
+@li wxDECLARE_APP()
+@li wxDYNLIB_FUNCTION()
+@li wxDEPRECATED()
+@li wxDEPRECATED_BUT_USED_INTERNALLY()
+@li wxDEPRECATED_INLINE()
+@li wxEXPLICIT()
+@li wxON_BLOCK_EXIT()
+@li wxON_BLOCK_EXIT_OBJ()
+@li wxSTRINGIZE()
+@li wxSTRINGIZE_T()
+@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING()
+@li __WXFUNCTION__()
+@li wxS()
+@li wxT()
+@li wxTRANSLATE()
+@li _()
+@li wxPLURAL()
+@li _T()
+@li WXTRACE()
+@li WXTRACELEVEL()
@section page_macro_cat_byteorder Byte Order
The macros are helpful for transforming the data to the correct format.
-@li wxINTXX_SWAP_ALWAYS
-@li wxINTXX_SWAP_ON_BE
-@li wxINTXX_SWAP_ON_LE
-@li wxFORCE_LINK_THIS_MODULE
-@li wxFORCE_LINK_MODULE
-@li wxIMPLEMENT_APP
+@li wxINTXX_SWAP_ALWAYS()
+@li wxINTXX_SWAP_ON_BE()
+@li wxINTXX_SWAP_ON_LE()
+@li wxFORCE_LINK_THIS_MODULE()
+@li wxFORCE_LINK_MODULE()
+@li wxIMPLEMENT_APP()
@section page_macro_cat_rtti Runtime Type Information (RTTI)
Related Overviews: @ref overview_rtti
-@li #CLASSINFO
-@li #DECLARE_ABSTRACT_CLASS
-@li #DECLARE_APP
-@li #DECLARE_CLASS
-@li #DECLARE_DYNAMIC_CLASS
-@li #IMPLEMENT_ABSTRACT_CLASS
-@li #IMPLEMENT_ABSTRACT_CLASS2
-@li #IMPLEMENT_APP
-@li #IMPLEMENT_CLASS
-@li #IMPLEMENT_CLASS2
-@li #IMPLEMENT_DYNAMIC_CLASS
-@li #IMPLEMENT_DYNAMIC_CLASS2
-@li #wxConstCast
-@li ::wxCreateDynamicObject
-@li #WXDEBUG_NEW
-@li #wxDynamicCast
-@li #wxDynamicCastThis
-@li #wxStaticCast
-@li #wx_const_cast
-@li #wx_reinterpret_cast
-@li #wx_static_cast
-@li #wx_truncate_cast
+@li CLASSINFO()
+@li DECLARE_ABSTRACT_CLASS()
+@li DECLARE_APP()
+@li DECLARE_CLASS()
+@li DECLARE_DYNAMIC_CLASS()
+@li IMPLEMENT_ABSTRACT_CLASS()
+@li IMPLEMENT_ABSTRACT_CLASS2()
+@li IMPLEMENT_APP()
+@li IMPLEMENT_CLASS()
+@li IMPLEMENT_CLASS2()
+@li IMPLEMENT_DYNAMIC_CLASS()
+@li IMPLEMENT_DYNAMIC_CLASS2()
+@li wxConstCast()
+@li wxCreateDynamicObject()
+@li WXDEBUG_NEW()
+@li wxDynamicCast()
+@li wxDynamicCastThis()
+@li wxStaticCast()
+@li wx_const_cast()
+@li wx_reinterpret_cast()
+@li wx_static_cast()
+@li wx_truncate_cast()
@section page_macro_cat_debugging Debugging
@header{wx/debug.h}
-@li wxASSERT
-@li wxASSERT_MIN_BITSIZE
-@li wxASSERT_MSG
-@li wxCOMPILE_TIME_ASSERT
-@li wxCOMPILE_TIME_ASSERT2
-@li wxFAIL
-@li wxFAIL_MSG
-@li wxCHECK
-@li wxCHECK_MSG
-@li wxCHECK_RET
-@li wxCHECK2
-@li wxCHECK2_MSG
+@li wxASSERT()
+@li wxASSERT_MIN_BITSIZE()
+@li wxASSERT_MSG()
+@li wxCOMPILE_TIME_ASSERT()
+@li wxCOMPILE_TIME_ASSERT2()
+@li wxFAIL()
+@li wxFAIL_MSG()
+@li wxCHECK()
+@li wxCHECK_MSG()
+@li wxCHECK_RET()
+@li wxCHECK2()
+@li wxCHECK2_MSG()
*/
static void SetResolution(int ppi);
};
-
-
-// ============================================================================
-// Global functions/macros
-// ============================================================================
-
-/**
- Gets the printer command used to print a file. The default is @c lpr.
-*/
-wxString wxGetPrinterCommand();
-
-/**
- Sets the printer command used to print a file. The default is @c lpr.
-*/
-void wxSetPrinterCommand(const wxString& command);
-
-/**
- Gets the orientation (PS_PORTRAIT or PS_LANDSCAPE). The default is PS_PORTRAIT.
-*/
-int wxGetPrinterOrientation();
-
-/**
- Sets the additional options for the print command (e.g. specific printer). The
- default is nothing.
-*/
-void wxSetPrinterOptions(const wxString& options);
-
-/**
- Gets the translation (from the top left corner) for PostScript output. The
- default is 0.0, 0.0.
-*/
-void wxGetPrinterTranslation(float* x, float* y);
-
-/**
- Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
-*/
-void wxSetPrinterScaling(float x, float y);
-
-/**
- Sets the orientation (PS_PORTRAIT or PS_LANDSCAPE). The default is PS_PORTRAIT.
-*/
-void wxSetPrinterOrientation(int orientation);
-
-/**
- Sets the printing mode controlling where output is sent (PS_PREVIEW, PS_FILE or
- PS_PRINTER).
- The default is PS_PREVIEW.
-*/
-void wxSetPrinterMode(int mode);
-
-/**
- Sets the PostScript output filename.
-*/
-void wxSetPrinterFile(const wxString& filename);
-
-/**
- Gets the PostScript output filename.
-*/
-wxString wxGetPrinterFile();
-
-/**
- Gets the additional options for the print command (e.g. specific printer). The
- default is nothing.
-*/
-wxString wxGetPrinterOptions();
-
-/**
- Gets the command used to view a PostScript file. The default depends on the
- platform.
-*/
-wxString wxGetPrinterPreviewCommand();
-
-/**
- Gets the printing mode controlling where output is sent (PS_PREVIEW, PS_FILE or
- PS_PRINTER).
- The default is PS_PREVIEW.
-*/
-int wxGetPrinterMode();
-
-/**
- Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
-*/
-void wxGetPrinterScaling(float* x, float* y);
-
-/**
- Sets the command used to view a PostScript file. The default depends on the
- platform.
-*/
-void wxSetPrinterPreviewCommand(const wxString& command);
-