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