docs/doxygen/mainpages/cat_functions.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        cat_functions.h
   3 // Purpose:     Functions-by-category page of the Doxygen manual
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /*!
  11
  12  @page page_func_cat Functions by category
  13
  14  A classification of wxWidgets functions by category.
  15
  16  @li @ref page_func_cat_appinitterm
  17  @li @ref page_func_cat_procctrl
  18  @li @ref page_func_cat_thread
  19  @li @ref page_func_cat_file
  20  @li @ref page_func_cat_networkuseros
  21  @li @ref page_func_cat_string
  22  @li @ref page_func_cat_dialog
  23  @li @ref page_func_cat_math
  24  @li @ref page_func_cat_gdi
  25  @li @ref page_func_cat_printer
  26  @li @ref page_func_cat_clipboard
  27  @li @ref page_func_cat_misc
  28  @li @ref page_func_cat_log
  29  @li @ref page_func_cat_time
  30  @li @ref page_func_cat_debug
  31  @li @ref page_func_cat_env
  32  @li @ref page_func_cat_atomic
  33
  34
  35  <hr>
  36
  37
  38
  39  @section page_func_cat_appinitterm Application initialization and termination
  40
  41  The functions in this section are used on application startup/shutdown and also
  42  to control the behaviour of the main event loop of the GUI programs.
  43
  44  @li wxEntry
  45  @li wxEntryCleanup
  46  @li wxEntryStart
  47  @li wxGetApp
  48  @li wxHandleFatalExceptions
  49  @li wxInitAllImageHandlers
  50  @li wxInitialize
  51  @li wxSafeYield
  52  @li wxUninitialize
  53  @li wxYield
  54  @li wxWakeUpIdle
  55
  56
  57  @section page_func_cat_procctrl Process control functions
  58
  59  The functions in this section are used to launch or terminate the other processes.
  60
  61  @li wxExecute
  62  @li wxExit
  63  @li wxJoin
  64  @li wxKill
  65  @li wxGetProcessId
  66  @li wxShell
  67  @li wxShutdown
  68
  69
  70  @section page_func_cat_thread Thread functions
  71
  72  The functions and macros here mainly exist to make it writing the code which may be
  73  compiled in multi thread build (wxUSE_THREADS = 1) as well as in single thread
  74  configuration (wxUSE_THREADS = 0).
  75
  76  For example, a static variable must be protected against simultaneous access by multiple
  77  threads in the former configuration but in the latter the extra overhead of using the
  78  critical section is not needed. To solve this problem, the wxCRITICAL_SECTION macro
  79  may be used to create and use the critical section only when needed.
  80
  81  @header{wx/thread.h}
  82
  83  @sa
  84  wxThread, wxMutex, @ref overview_thread
  85
  86  @li wxIsMainThread
  87  @li wxMutexGuiEnter
  88  @li wxMutexGuiLeave
  89
  90
  91  @section page_func_cat_file File functions
  92
  93  @header{wx/filefn.h}
  94
  95  @sa
  96  wxPathList, wxDir, wxFile, wxFileName
  97
  98  @li wxDos2UnixFilename
  99  @li wxFileExists
 100  @li wxFileModificationTime
 101  @li wxFileNameFromPath
 102  @li wxFindFirstFile
 103  @li wxFindNextFile
 104  @li wxGetDiskSpace
 105  @li wxGetFileKind
 106  @li wxGetOSDirectory
 107  @li wxIsAbsolutePath
 108  @li wxDirExists
 109  @li wxPathOnly
 110  @li wxUnix2DosFilename
 111  @li wxConcatFiles
 112  @li wxCopyFile
 113  @li wxGetCwd
 114  @li wxGetWorkingDirectory
 115  @li wxGetTempFileName
 116  @li wxIsWild
 117  @li wxMatchWild
 118  @li wxMkdir
 119  @li wxParseCommonDialogsFilter
 120  @li wxRemoveFile
 121  @li wxRenameFile
 122  @li wxRmdir
 123  @li wxSetWorkingDirectory
 124  @li wxSplit
 125  @li wxSplitPath
 126  @li wxTransferFileToStream
 127  @li wxTransferStreamToFile
 128
 129
 130  @section page_func_cat_networkuseros Network, user and OS functions
 131
 132  The functions in this section are used to retrieve information about the current
 133  computer and/or user characteristics.
 134
 135  @li wxGetEmailAddress
 136  @li wxGetFreeMemory
 137  @li wxGetFullHostName
 138  @li wxGetHomeDir
 139  @li wxGetHostName
 140  @li wxGetOsDescription
 141  @li wxGetOsVersion
 142  @li wxIsPlatformLittleEndian
 143  @li wxIsPlatform64Bit
 144  @li wxGetUserHome
 145  @li wxGetUserId
 146  @li wxGetUserName
 147
 148
 149  @section page_func_cat_string String functions
 150
 151  @li wxGetTranslation
 152  @li wxIsEmpty
 153  @li wxStrcmp
 154  @li wxStricmp
 155  @li wxStringEq
 156  @li wxStringMatch
 157  @li wxStringTokenize
 158  @li wxStrlen
 159  @li wxSnprintf
 160  @li wxVsnprintf
 161
 162
 163  @section page_func_cat_dialog Dialog functions
 164
 165  Below are a number of convenience functions for getting input from the user
 166  or displaying messages. Note that in these functions the last three parameters
 167  are optional. However, it is recommended to pass a parent frame parameter, or
 168  (in MS Windows or Motif) the wrong window frame may be brought to the front when
 169  the dialog box is popped up.
 170
 171  @li wxAboutBox
 172  @li wxBeginBusyCursor
 173  @li wxBell
 174  @li wxCreateFileTipProvider
 175  @li wxDirSelector
 176  @li wxFileSelector
 177  @li wxEndBusyCursor
 178  @li wxGenericAboutBox
 179  @li wxGetColourFromUser
 180  @li wxGetFontFromUser
 181  @li wxGetMultipleChoices
 182  @li wxGetNumberFromUser
 183  @li wxGetPasswordFromUser
 184  @li wxGetTextFromUser
 185  @li wxGetSingleChoice
 186  @li wxGetSingleChoiceIndex
 187  @li wxGetSingleChoiceData
 188  @li wxInfoMessageBox
 189  @li wxIsBusy
 190  @li wxMessageBox
 191  @li wxShowTip
 192
 193
 194  @section page_func_cat_math Math functions
 195
 196  @header{wx/math.h}
 197
 198  @li wxFinite
 199  @li wxIsNaN
 200
 201
 202  @section page_func_cat_gdi GDI functions
 203
 204  The following are relevant to the GDI (Graphics Device Interface).
 205
 206  @header{gdicmn.h}
 207
 208  @li wxBITMAP
 209  @li wxClientDisplayRect
 210  @li wxColourDisplay
 211  @li wxDisplayDepth
 212  @li wxDisplaySize
 213  @li wxDisplaySizeMM
 214  @li wxDROP_ICON
 215  @li wxICON
 216  @li wxMakeMetafilePlaceable
 217  @li wxSetCursor
 218
 219
 220  @section page_func_cat_printer Printer settings
 221
 222  NB: These routines are obsolete and should no longer be used!
 223
 224  The following functions are used to control PostScript printing.
 225  Under Windows, PostScript output can only be sent to a file.
 226
 227  @header{wx/dcps.h}
 228
 229  @li wxGetPrinterCommand
 230  @li wxGetPrinterFile
 231  @li wxGetPrinterMode
 232  @li wxGetPrinterOptions
 233  @li wxGetPrinterOrientation
 234  @li wxGetPrinterPreviewCommand
 235  @li wxGetPrinterScaling
 236  @li wxGetPrinterTranslation
 237  @li wxSetPrinterCommand
 238  @li wxSetPrinterFile
 239  @li wxSetPrinterMode
 240  @li wxSetPrinterOptions
 241  @li wxSetPrinterOrientation
 242  @li wxSetPrinterPreviewCommand
 243  @li wxSetPrinterScaling
 244  @li wxSetPrinterTranslation
 245
 246
 247  @section page_func_cat_clipboard Clipboard functions
 248
 249  These clipboard functions are implemented for Windows only.
 250  The use of these functions is deprecated and the code is no longer maintained.
 251  Use the wxClipboard class instead.
 252
 253  @header{wx/clipbrd.h}
 254
 255  @li wxClipboardOpen
 256  @li wxCloseClipboard
 257  @li wxEmptyClipboard
 258  @li wxEnumClipboardFormats
 259  @li wxGetClipboardData
 260  @li wxGetClipboardFormatName
 261  @li wxIsClipboardFormatAvailable
 262  @li wxOpenClipboard
 263  @li wxRegisterClipboardFormat
 264  @li wxSetClipboardData
 265
 266
 267  @section page_func_cat_misc Miscellaneous functions and macros
 268
 269  @li wxBase64Decode
 270  @li wxBase64DecodedSize
 271  @li wxBase64Encode
 272  @li wxBase64EncodedSize
 273  @li wxGetKeyState
 274  @li wxNewId
 275  @li wxRegisterId
 276  @li wxDDECleanUp
 277  @li wxDDEInitialize
 278  @li wxEnableTopLevelWindows
 279  @li wxFindMenuItemId
 280  @li wxFindWindowByLabel
 281  @li wxFindWindowByName
 282  @li wxFindWindowAtPoint
 283  @li wxFindWindowAtPointer
 284  @li wxGetActiveWindow
 285  @li wxGetBatteryState
 286  @li wxGetDisplayName
 287  @li wxGetPowerType
 288  @li wxGetMousePosition
 289  @li wxGetMouseState
 290  @li wxGetStockLabel
 291  @li wxGetTopLevelParent
 292  @li wxLaunchDefaultBrowser
 293  @li wxLoadUserResource
 294  @li wxPostDelete
 295  @li wxPostEvent
 296  @li wxSetDisplayName
 297  @li wxStripMenuCodes
 298
 299
 300  @section page_func_cat_log Log functions
 301
 302  These functions provide a variety of logging functions: see @ref overview_log for
 303  further information. The functions use (implicitly) the currently active log target,
 304  so their descriptions here may not apply if the log target is not the standard one
 305  (installed by wxWidgets in the beginning of the program).
 306
 307  @header{wx/log.h}
 308
 309  @li wxDebugMsg
 310  @li wxError
 311  @li wxFatalError
 312  @li wxLogError
 313  @li wxLogFatalError
 314  @li wxLogWarning
 315  @li wxLogMessage
 316  @li wxLogVerbose
 317  @li wxLogStatus
 318  @li wxLogSysError
 319  @li wxLogDebug
 320  @li wxLogTrace
 321  @li wxSafeShowMessage
 322  @li wxSysErrorCode
 323  @li wxSysErrorMsg
 324  @li wxTrace
 325  @li wxTraceLevel
 326
 327
 328  @section page_func_cat_time Time functions
 329
 330  The functions in this section deal with getting the current time and sleeping
 331  for the specified time interval.
 332
 333  @li wxGetLocalTime
 334  @li wxGetLocalTimeMillis
 335  @li wxGetUTCTime
 336  @li wxMicroSleep
 337  @li wxMilliSleep
 338  @li wxNow
 339  @li wxSleep
 340  @li wxUsleep
 341
 342
 343  @section page_func_cat_debug Debugging macros and functions
 344
 345  Useful macros and functions for error checking and defensive programming.
 346  wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL
 347  macros only do anything if __WXDEBUG__ is defined (in other words, in the debug build)
 348  but disappear completely in the release build. On the other hand, the wxCHECK macros
 349  stay event in release builds but a check failure doesn't generate any user-visible effects
 350  then. Finally, the compile time assertions don't happen during the run-time but result
 351  in the compilation error messages if the condition they check fail.
 352
 353  @header{wx/debug.h}
 354
 355  @li wxOnAssert
 356  @li wxTrap
 357  @li wxIsDebuggerRunning
 358
 359
 360  @section page_func_cat_env Environment access functions
 361
 362  The functions in this section allow to access (get) or change value of environment
 363  variables in a portable way. They are currently implemented under Win32 and
 364  POSIX-like systems (Unix).
 365
 366  @header{wx/utils.h}
 367
 368  @li wxGetenv
 369  @li wxGetEnv
 370  @li wxSetEnv
 371  @li wxUnsetEnv
 372
 373
 374  @section page_func_cat_atomic Atomic operation functions
 375
 376  When using multi-threaded applications, it is often required to access or modify
 377  memory which is shared between threads. Atomic integer and pointer operations are
 378  an efficient way to handle this issue (another, less efficient, way is to use a mutex
 379  or critical section). A native implementation exists for Windows, Linux, Solaris and
 380  Mac OS X, for other OS, a wxCriticalSection is used to protect the data.
 381
 382  One particular application is reference counting (used by so-called smart pointers).
 383
 384  You should define your variable with the type wxAtomicInt in order to apply atomic operations to it.
 385
 386  @header{wx/atomic.h}
 387
 388  @li wxAtomicInc
 389  @li wxAtomicDec
 390
 391 */