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 to control the behaviour of the main event loop of the GUI programs.
  42 ::wxEntry
  43 ::wxEntryCleanup
  44 ::wxEntryStart
  45 ::wxGetApp
  46 ::wxHandleFatalExceptions
  47 ::wxInitAllImageHandlers
  48 ::wxInitialize
  49 ::wxSafeYield
  50 ::wxUninitialize
  51 ::wxYield
  52 ::wxWakeUpIdle
  53
  54
  55  @section page_func_cat_procctrl Process control functions
  56 The functions in this section are used to launch or terminate the other processes.
  57 ::wxExecute
  58 ::wxExit
  59 ::wxJoin
  60 ::wxKill
  61 ::wxGetProcessId
  62 ::wxShell
  63 ::wxShutdown
  64
  65  @section page_func_cat_thread Thread functions
  66 The functions and macros here mainly exist to make it writing the code which may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in single thread configuration (wxUSE_THREADS = 0).
  67 For example, a static variable must be protected against simultaneous access by multiple threads in the former configuration but in the latter the extra overhead of using the critical section is not needed. To solve this problem, the wxCRITICAL_SECTION macro may be used to create and use the critical section only when needed.
  68 Include files
  69 <wx/thread.h>
  70 See also
  71 wxThread, wxMutex, Multithreading overview
  72
  73 ::wxIsMainThread
  74 ::wxMutexGuiEnter
  75 ::wxMutexGuiLeave
  76
  77  @section page_func_cat_file File functions
  78 Include files
  79 <wx/filefn.h>
  80 See also
  81 wxPathList
  82 wxDir
  83 wxFile
  84 wxFileName
  85
  86 ::wxDos2UnixFilename
  87 ::wxFileExists
  88 ::wxFileModificationTime
  89 ::wxFileNameFromPath
  90 ::wxFindFirstFile
  91 ::wxFindNextFile
  92 ::wxGetDiskSpace
  93 ::wxGetFileKind
  94 ::wxGetOSDirectory
  95 ::wxIsAbsolutePath
  96 ::wxDirExists
  97 ::wxPathOnly
  98 ::wxUnix2DosFilename
  99 ::wxConcatFiles
 100 ::wxCopyFile
 101 ::wxGetCwd
 102 ::wxGetWorkingDirectory
 103 ::wxGetTempFileName
 104 ::wxIsWild
 105 ::wxMatchWild
 106 ::wxMkdir
 107 ::wxParseCommonDialogsFilter
 108 ::wxRemoveFile
 109 ::wxRenameFile
 110 ::wxRmdir
 111 ::wxSetWorkingDirectory
 112 ::wxSplit
 113 ::wxSplitPath
 114 ::wxTransferFileToStream
 115 ::wxTransferStreamToFile
 116
 117  @section page_func_cat_networkuseros Network, user and OS functions
 118 The functions in this section are used to retrieve information about the current computer and/or user characteristics.
 119 ::wxGetEmailAddress
 120 ::wxGetFreeMemory
 121 ::wxGetFullHostName
 122 ::wxGetHomeDir
 123 ::wxGetHostName
 124 ::wxGetOsDescription
 125 ::wxGetOsVersion
 126 ::wxIsPlatformLittleEndian
 127 ::wxIsPlatform64Bit
 128 ::wxGetUserHome
 129 ::wxGetUserId
 130 ::wxGetUserName
 131
 132
 133  @section page_func_cat_string String functions
 134 ::wxGetTranslation
 135 ::wxIsEmpty
 136 wxS
 137 ::wxStrcmp
 138 ::wxStricmp
 139 ::wxStringEq
 140 ::wxStringMatch
 141 ::wxStringTokenize
 142 ::wxStrlen
 143 ::wxSnprintf
 144 wxT
 145 wxTRANSLATE
 146 ::wxVsnprintf
 147 _
 148 wxPLURAL
 149 _T
 150
 151  @section page_func_cat_dialog Dialog functions
 152 Below are a number of convenience functions for getting input from the user or displaying messages. Note that in these functions the last three parameters are optional. However, it is recommended to pass a parent frame parameter, or (in MS Windows or Motif) the wrong window frame may be brought to the front when the dialog box is popped up.
 153 ::wxAboutBox
 154 ::wxBeginBusyCursor
 155 ::wxBell
 156 ::wxCreateFileTipProvider
 157 ::wxDirSelector
 158 ::wxFileSelector
 159 ::wxEndBusyCursor
 160 ::wxGenericAboutBox
 161 ::wxGetColourFromUser
 162 ::wxGetFontFromUser
 163 ::wxGetMultipleChoices
 164 ::wxGetNumberFromUser
 165 ::wxGetPasswordFromUser
 166 ::wxGetTextFromUser
 167 ::wxGetSingleChoice
 168 ::wxGetSingleChoiceIndex
 169 ::wxGetSingleChoiceData
 170 ::wxInfoMessageBox
 171 ::wxIsBusy
 172 ::wxMessageBox
 173 ::wxShowTip
 174
 175  @section page_func_cat_math Math functions
 176 Include files
 177 <wx/math.h>
 178 wxFinite
 179 wxIsNaN
 180
 181  @section page_func_cat_gdi GDI functions
 182 The following are relevant to the GDI (Graphics Device Interface).
 183 Include files
 184 <wx/gdicmn.h>
 185 wxBITMAP
 186 ::wxClientDisplayRect
 187 ::wxColourDisplay
 188 ::wxDisplayDepth
 189 ::wxDisplaySize
 190 ::wxDisplaySizeMM
 191 ::wxDROP_ICON
 192 wxICON
 193 ::wxMakeMetafilePlaceable
 194 ::wxSetCursor
 195
 196  @section page_func_cat_printer Printer settings
 197 NB: These routines are obsolete and should no longer be used!
 198 The following functions are used to control PostScript printing. Under Windows, PostScript output can only be sent to a file.
 199 Include files
 200 <wx/dcps.h>
 201 ::wxGetPrinterCommand
 202 ::wxGetPrinterFile
 203 ::wxGetPrinterMode
 204 ::wxGetPrinterOptions
 205 ::wxGetPrinterOrientation
 206 ::wxGetPrinterPreviewCommand
 207 ::wxGetPrinterScaling
 208 ::wxGetPrinterTranslation
 209 ::wxSetPrinterCommand
 210 ::wxSetPrinterFile
 211 ::wxSetPrinterMode
 212 ::wxSetPrinterOptions
 213 ::wxSetPrinterOrientation
 214 ::wxSetPrinterPreviewCommand
 215 ::wxSetPrinterScaling
 216 ::wxSetPrinterTranslation
 217
 218  @section page_func_cat_clipboard Clipboard functions
 219 These clipboard functions are implemented for Windows only. The use of these functions is deprecated and the code is no longer maintained. Use the wxClipboard class instead.
 220 Include files
 221 <wx/clipbrd.h>
 222 ::wxClipboardOpen
 223 ::wxCloseClipboard
 224 ::wxEmptyClipboard
 225 ::wxEnumClipboardFormats
 226 ::wxGetClipboardData
 227 ::wxGetClipboardFormatName
 228 ::wxIsClipboardFormatAvailable
 229 ::wxOpenClipboard
 230 ::wxRegisterClipboardFormat
 231 ::wxSetClipboardData
 232
 233  @section page_func_cat_misc Miscellaneous functions and macros
 234 ::wxBase64Decode
 235 ::wxBase64DecodedSize
 236 ::wxBase64Encode
 237 ::wxBase64EncodedSize
 238 ::wxGetKeyState
 239 ::wxNewId
 240 ::wxRegisterId
 241 ::wxDDECleanUp
 242 ::wxDDEInitialize
 243 ::wxEnableTopLevelWindows
 244 ::wxFindMenuItemId
 245 ::wxFindWindowByLabel
 246 ::wxFindWindowByName
 247 ::wxFindWindowAtPoint
 248 ::wxFindWindowAtPointer
 249 ::wxGetActiveWindow
 250 ::wxGetBatteryState
 251 ::wxGetDisplayName
 252 ::wxGetPowerType
 253 ::wxGetMousePosition
 254 ::wxGetMouseState
 255 ::wxGetStockLabel
 256 ::wxGetTopLevelParent
 257 ::wxLaunchDefaultBrowser
 258 ::wxLoadUserResource
 259 ::wxPostDelete
 260 ::wxPostEvent
 261 ::wxSetDisplayName
 262 ::wxStripMenuCodes
 263
 264
 265  @section page_func_cat_log Log functions
 266 These functions provide a variety of logging functions: see Log classes overview 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 wxWidgets in the beginning of the program).
 267 Include files
 268 <wx/log.h>
 269 ::wxDebugMsg
 270 ::wxError
 271 ::wxFatalError
 272 ::wxLogError
 273 ::wxLogFatalError
 274 ::wxLogWarning
 275 ::wxLogMessage
 276 ::wxLogVerbose
 277 ::wxLogStatus
 278 ::wxLogSysError
 279 ::wxLogDebug
 280 ::wxLogTrace
 281 ::wxSafeShowMessage
 282 ::wxSysErrorCode
 283 ::wxSysErrorMsg
 284 WXTRACE
 285 WXTRACELEVEL
 286 ::wxTrace
 287 ::wxTraceLevel
 288
 289  @section page_func_cat_time Time functions
 290 The functions in this section deal with getting the current time and sleeping for the specified time interval.
 291 ::wxGetLocalTime
 292 ::wxGetLocalTimeMillis
 293 ::wxGetUTCTime
 294 ::wxMicroSleep
 295 ::wxMilliSleep
 296 ::wxNow
 297 ::wxSleep
 298 ::wxUsleep
 299
 300
 301  @section page_func_cat_debug Debugging macros and functions
 302 Useful macros and functions for error checking and defensive programming. 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 check failure doesn't generate any user-visible effects then. Finally, the compile time assertions don't happen during the run-time but result in the compilation error messages if the condition they check fail.
 303 Include files
 304 <wx/debug.h>
 305 ::wxOnAssert
 306 ::wxTrap
 307 ::wxIsDebuggerRunning
 308
 309  @section page_func_cat_env Environment access functions
 310 The functions in this section allow to access (get) or change value of environment variables in a portable way. They are currently implemented under Win32 and POSIX-like systems (Unix).
 311 Include files
 312 <wx/utils.h>
 313 wxGetenv
 314 wxGetEnv
 315 wxSetEnv
 316 wxUnsetEnv
 317
 318  @section page_func_cat_atomic Atomic operation functions
 319 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 mutex or critical section). A native implementation exists for Windows, Linux, Solaris and Mac OS X, for other OS, a wxCriticalSection is used to protect the data.
 320 One particular application is reference counting (used by so-called smart pointers).
 321 You should define your variable with the type wxAtomicInt in order to apply atomic operations to it.
 322 Include files
 323 <wx/atomic.h>
 324 ::wxAtomicInc
 325 ::wxAtomicDec
 326
 327 */