cat_classes.h 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822
  1. /////////////////////////////////////////////////////////////////////////////
  2. // Name: cat_classes.h
  3. // Purpose: Classes-by-category page of the Doxygen manual
  4. // Author: wxWidgets team
  5. // Licence: wxWindows licence
  6. /////////////////////////////////////////////////////////////////////////////
  7. /**
  8. @page page_class_cat Overview of Available Classes
  9. @tableofcontents
  10. This page contains a summarized listing of classes, please see the
  11. @ref group_class page for a full listing by category or the
  12. <a href="classes.html">full list of classes</a> in alphabetical order.
  13. @section page_class_cat_basicwnd Basic Windows
  14. The following are the most important window classes
  15. @li wxWindow: base class for all windows and controls
  16. @li wxControl: base class (mostly) for native controls/widgets
  17. @li wxPanel: window which can smartly manage child windows
  18. @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
  19. wxScrolled)
  20. @li wxTopLevelWindow: Any top level window, dialog or frame
  21. @section page_class_cat_winlayout Window Layout
  22. There are two different systems for laying out windows (and dialogs in
  23. particular). One is based upon so-called sizers and it requires less typing,
  24. thinking and calculating and will in almost all cases produce dialogs looking
  25. equally well on all platforms, the other is based on so-called constraints and
  26. is deprecated, though still available.
  27. Related Overviews: @ref overview_sizer
  28. These are the classes relevant to sizer-based layout:
  29. @li wxSizer: Abstract base class
  30. @li wxBoxSizer: A sizer for laying out windows in a row or column
  31. @li wxGridSizer: A sizer for laying out windows in a grid with all fields
  32. having the same size
  33. @li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
  34. @li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
  35. is in, and items can span rows and/or columns.
  36. @li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
  37. @li wxWrapSizer: A sizer which wraps its child controls as size permits
  38. Other layout classes:
  39. @li wxLayoutAlgorithm: An alternative window layout facility
  40. @section page_class_cat_managedwnd Managed Windows
  41. There are several types of window that are directly controlled by the window
  42. manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
  43. are similar in wxWidgets, but only dialogs may be modal.
  44. Related Overviews: @ref overview_cmndlg
  45. @li wxDialog: Dialog box
  46. @li wxFrame: Normal frame
  47. @li wxMDIChildFrame: MDI child frame
  48. @li wxMDIParentFrame: MDI parent frame
  49. @li wxMiniFrame: A frame with a small title bar
  50. @li wxPopupWindow: A toplevel window without decorations, e.g. for a combobox pop-up
  51. @li wxPropertySheetDialog: Property sheet dialog
  52. @li wxSplashScreen: Splash screen class
  53. @li wxTipWindow: Shows text in a small window
  54. @li wxWizard: A wizard dialog
  55. @section page_class_cat_menus Menus
  56. @li wxMenu: Displays a series of menu items for selection
  57. @li wxMenuBar: Contains a series of menus for use with a frame
  58. @li wxMenuItem: Represents a single menu item
  59. @section page_class_cat_ctrl Controls
  60. Typically, these are small windows which provide interaction with the user.
  61. Controls that are not static can have wxValidator associated with them.
  62. @li wxAnimationCtrl: A control to display an animation
  63. @li wxControl: The base class for controls
  64. @li wxBitmapButton: Push button control, displaying a bitmap
  65. @li wxBitmapComboBox: A combobox with bitmaps next to text items
  66. @li wxBitmapToggleButton: A toggle button with bitmaps.
  67. @li wxButton: Push button control, displaying text
  68. @li wxCalendarCtrl: Control showing an entire calendar month
  69. @li wxCheckBox: Checkbox control
  70. @li wxCheckListBox: A listbox with a checkbox to the left of each item
  71. @li wxChoice: Choice control (a combobox without the editable area)
  72. @li wxCollapsiblePane: A panel which can be shown/hidden by the user
  73. @li wxComboBox: A choice with an editable area
  74. @li wxComboCtrl: A combobox with application defined popup
  75. @li wxDataViewCtrl: A control to display tabular or tree like data
  76. @li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with a wxTreeCtrl-like API
  77. @li wxDataViewListCtrl: A specialized wxDataViewCtrl for displaying and editing simple tables.
  78. @li wxEditableListBox: A listbox with editable items.
  79. @li wxFileCtrl: A control for selecting a file. Useful for custom file dialogs.
  80. @li wxGauge: A control to represent a varying quantity, such as time remaining
  81. @li wxGenericDirCtrl: A control for displaying a directory tree
  82. @li wxGrid: A control to display spread-sheet like data in tabular form
  83. @li wxHeaderCtrl: a small control to display the top header of tabular data
  84. @li wxHtmlListBox: An abstract class for creating listboxes showing HTML
  85. content
  86. @li wxHyperlinkCtrl: A static text which opens an URL when clicked
  87. @li wxListBox: A list of strings for single or multiple selection
  88. @li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
  89. multicolumn report view
  90. @li wxListView: A simpler interface (fa&ccedil;ade) for wxListCtrl in report
  91. mode
  92. @li wxNotebook: A notebook class
  93. @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
  94. @li wxPropertyGrid: A complex control to display hierachical, editable information
  95. @li wxRadioBox: A group of radio buttons
  96. @li wxRadioButton: A round button to be used with others in a mutually
  97. exclusive way
  98. @li wxRearrangeCtrl: A control allowing the user to rearrange a list of items.
  99. @li wxRichTextCtrl: Generic rich text editing control
  100. @li wxSimpleHtmlListBox: A listbox showing HTML content
  101. @li wxStaticBox: A static, or group box for visually grouping related controls
  102. @li wxScrollBar: Scrollbar control
  103. @li wxSearchCtrl: A text input control used to initiate a search
  104. @li wxSpinButton: A spin or `up-down' control
  105. @li wxSpinCtrl: A spin control - i.e. spin button and text control displaying
  106. an integer
  107. @li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying
  108. a real number
  109. @li wxStaticText: One or more lines of non-editable text
  110. @li wxTextCtrl: Single or multiline text editing control
  111. @li wxToggleButton: A button which stays pressed when clicked by user.
  112. @li wxTreeCtrl: Tree (hierarchy) control
  113. @li wxTreeListCtrl: Multi-column tree control with simple interface
  114. @li wxStaticBitmap: A control to display a bitmap
  115. @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
  116. editing component for plain text editing.
  117. @li wxSlider: A slider that can be dragged by the user
  118. @li wxVListBox: A listbox supporting variable height rows
  119. @section page_class_cat_validator Validators
  120. These are the window validators, used for filtering and validating user input.
  121. Related Overviews: @ref overview_validator
  122. @li wxValidator: Base validator class
  123. @li wxTextValidator: Text control validator class
  124. @li wxGenericValidator: Generic control validator class
  125. @li wxIntegerValidator: Text control validator class for integer numbers
  126. @li wxFloatingPointValidator: Text control validator class for floating point numbers
  127. @section page_class_cat_pickers Picker Controls
  128. A picker control is a control whose appearance and behaviour is highly
  129. platform-dependent.
  130. @li wxColourPickerCtrl: A control which allows the user to choose a colour
  131. @li wxDirPickerCtrl: A control which allows the user to choose a directory
  132. @li wxFilePickerCtrl: A control which allows the user to choose a file
  133. @li wxFontPickerCtrl: A control which allows the user to choose a font
  134. @li wxDatePickerCtrl: Small date picker control
  135. @section page_class_cat_miscwnd Miscellaneous Windows
  136. The following are a variety of classes that are derived from wxWindow.
  137. @li wxCollapsiblePane: A panel which can be shown/hidden by the user
  138. @li wxPanel: A window whose colour changes according to current user settings
  139. @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
  140. wxScrolled)
  141. @li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable
  142. widths
  143. @li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable
  144. heights
  145. @li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
  146. variable sizes.
  147. @li wxGrid: A grid (table) window
  148. @li wxInfoBar: An information bar usually shown on top of the main window.
  149. @li wxRichToolTip: A customizable tooltip.
  150. @li wxSplitterWindow: Window which can be split vertically or horizontally
  151. @li wxStatusBar: Implements the status bar on a frame
  152. @li wxToolBar: Toolbar class
  153. @li wxNotebook: Notebook class
  154. @li wxListbook: Similar to notebook but using list control
  155. @li wxChoicebook: Similar to notebook but using choice control
  156. @li wxTreebook: Similar to notebook but using tree control
  157. @li wxSashWindow: Window with four optional sashes that can be dragged
  158. @li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
  159. arrangement
  160. @li wxSimplebook: Another book control but one allowing only the program, not
  161. the user, to change its current page.
  162. @li wxWizardPage: A base class for the page in wizard dialog.
  163. @li wxWizardPageSimple: A page in wizard dialog.
  164. @li wxCustomBackgroundWindow: A window allowing to set a custom bitmap.
  165. @section page_class_cat_aui Window Docking (wxAUI)
  166. wxAUI is a set classes for writing a customizable application interface
  167. with built-in docking, floatable panes and a flexible MDI-like interface.
  168. Related Overviews: @ref overview_aui
  169. @li wxAuiManager: The central class for managing the interface
  170. @li wxAuiNotebook: A replacement notebook class with extra features
  171. @li wxAuiPaneInfo: Describes a single pane
  172. @li wxAuiDockArt: Art and metrics provider for customizing the docking user
  173. interface
  174. @li wxAuiTabArt: Art and metrics provider for customizing the notebook user
  175. interface
  176. @section page_class_cat_cmndlg Common Dialogs
  177. Common dialogs are ready-made dialog classes which are frequently used in an
  178. application.
  179. Related Overviews: @ref overview_cmndlg
  180. @li wxDialog: Base class for common dialogs
  181. @li wxColourDialog: Colour chooser dialog
  182. @li wxDirDialog: Directory selector dialog
  183. @li wxFileDialog: File selector dialog
  184. @li wxFindReplaceDialog: Text search/replace dialog
  185. @li wxFontDialog: Font chooser dialog
  186. @li wxMessageDialog: Simple message box dialog
  187. @li wxMultiChoiceDialog: Dialog to get one or more selections from a list
  188. @li wxPageSetupDialog: Standard page setup dialog
  189. @li wxPasswordEntryDialog: Dialog to get a password from the user
  190. @li wxPrintDialog: Standard print dialog
  191. @li wxProgressDialog: Progress indication dialog
  192. @li wxRearrangeDialog: Dialog allowing the user to rearrange a list of items.
  193. @li wxRichTextFormattingDialog: A dialog for formatting the content of a
  194. wxRichTextCtrl
  195. @li wxRichMessageDialog: Nicer message box dialog
  196. @li wxSingleChoiceDialog: Dialog to get a single selection from a list and
  197. return the string
  198. @li wxSymbolPickerDialog: Symbol selector dialog
  199. @li wxTextEntryDialog: Dialog to get a single line of text from the user
  200. @li wxWizard: A wizard dialog.
  201. @section page_class_cat_html HTML
  202. wxWidgets provides a set of classes to display text in HTML format. These
  203. classes include a help system based on the HTML widget.
  204. @li wxHtmlHelpController: HTML help controller class
  205. @li wxHtmlWindow: HTML window class
  206. @li wxHtmlEasyPrinting: Simple class for printing HTML
  207. @li wxHtmlPrintout: Generic HTML wxPrintout class
  208. @li wxHtmlParser: Generic HTML parser class
  209. @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
  210. @li wxHtmlWinParser: HTML parser class for wxHtmlWindow
  211. @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
  212. @section page_class_cat_dc Device Contexts
  213. Device contexts are surfaces that may be drawn on, and provide an abstraction
  214. that allows parameterisation of your drawing code by passing different device
  215. contexts.
  216. Related Overviews: @ref overview_dc
  217. @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
  218. inside @b OnPaint().
  219. @li wxBufferedDC: A helper device context for double buffered drawing.
  220. @li wxBufferedPaintDC: A helper device context for double buffered drawing
  221. inside @b OnPaint().
  222. @li wxClientDC: A device context to access the client area outside
  223. @b OnPaint() events
  224. @li wxPaintDC: A device context to access the client area inside @b OnPaint()
  225. events
  226. @li wxWindowDC: A device context to access the non-client area
  227. @li wxScreenDC: A device context to access the entire screen
  228. @li wxDC: The device context base class
  229. @li wxMemoryDC: A device context for drawing into bitmaps
  230. @li wxMetafileDC: A device context for drawing into metafiles
  231. @li wxMirrorDC: A proxy device context allowing for simple mirroring.
  232. @li wxPostScriptDC: A device context for drawing into PostScript files
  233. @li wxPrinterDC: A device context for drawing to printers
  234. @section page_class_cat_gc Graphics Context classes
  235. These classes are related to drawing using a new vector based drawing API and
  236. are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
  237. @li wxGraphicsRenderer: Represents a drawing engine.
  238. @li wxGraphicsContext: Represents a graphics context currently being drawn on.
  239. @li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
  240. @li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
  241. @li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
  242. @li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
  243. @li wxGraphicsPath: Represents a path for drawing
  244. @section page_class_cat_gdi Graphics Device Interface
  245. These classes are related to drawing on device contexts and windows.
  246. @li wxColour: Represents the red, blue and green elements of a colour
  247. @li wxDCClipper: Wraps the operations of setting and destroying the clipping
  248. region
  249. @li wxBrush: Used for filling areas on a device context
  250. @li wxBrushList: The list of previously-created brushes
  251. @li wxFont: Represents fonts
  252. @li wxFontList: The list of previously-created fonts
  253. @li wxPen: Used for drawing lines on a device context
  254. @li wxPenList: The list of previously-created pens
  255. @li wxPalette: Represents a table of indices into RGB values
  256. @li wxRegion: Represents a simple or complex region on a window or device
  257. context
  258. @li wxRendererNative: Abstracts high-level drawing primitives
  259. @section page_class_cat_image Image and bitmap classes
  260. These classes represent images and bitmap in various formats and ways
  261. to access and create them.
  262. Related Overviews: @ref overview_bitmap
  263. @li wxAnimation: Represents an animation
  264. @li wxBitmap: Represents a platform dependent bitmap
  265. @li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
  266. @li wxCursor: A small, transparent bitmap representing the cursor
  267. @li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
  268. device contexts
  269. @li wxImage: A platform-independent image class
  270. @li wxImageHandler: Class for loading a saving a wxImage in a specific format
  271. @li wxImageList: A list of images, used with some controls
  272. @li wxMask: Represents a mask to be used with a bitmap for transparent drawing
  273. @li wxMemoryDC: A device context for drawing into bitmaps
  274. @li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
  275. @section page_class_cat_events Events
  276. An event object contains information about a specific event. Event handlers
  277. (usually member functions) have a single, event argument.
  278. Related Overviews: @ref overview_events
  279. @li wxActivateEvent: A window or application activation event
  280. @li wxCalendarEvent: Used with wxCalendarCtrl
  281. @li wxCalculateLayoutEvent: Used to calculate window layout
  282. @li wxChildFocusEvent: A child window focus event
  283. @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
  284. @li wxCloseEvent: A close window or end session event
  285. @li wxCommandEvent: An event from a variety of standard controls
  286. @li wxContextMenuEvent: An event generated when the user issues a context menu
  287. command
  288. @li wxDateEvent: Used with wxDatePickerCtrl
  289. @li wxDialUpEvent: Event send by wxDialUpManager
  290. @li wxDropFilesEvent: A drop files event
  291. @li wxEraseEvent: An erase background event
  292. @li wxEvent: The event base class
  293. @li wxFindDialogEvent: Event sent by wxFindReplaceDialog
  294. @li wxFocusEvent: A window focus event
  295. @li wxKeyEvent: A keypress event
  296. @li wxIconizeEvent: An iconize/restore event
  297. @li wxIdleEvent: An idle event
  298. @li wxInitDialogEvent: A dialog initialisation event
  299. @li wxJoystickEvent: A joystick event
  300. @li wxKeyboardState: State of the keyboard modifiers.
  301. @li wxListEvent: A list control event
  302. @li wxMaximizeEvent: A maximize event
  303. @li wxMenuEvent: A menu event
  304. @li wxMouseCaptureChangedEvent: A mouse capture changed event
  305. @li wxMouseCaptureLostEvent: A mouse capture lost event
  306. @li wxMouseEvent: A mouse event
  307. @li wxMouseState: State of the mouse
  308. @li wxMoveEvent: A move event
  309. @li wxNavigationKeyEvent: An event set by navigation keys such as tab
  310. @li wxNotebookEvent: A notebook control event
  311. @li wxNotifyEvent: A notification event, which can be vetoed
  312. @li wxPaintEvent: A paint event
  313. @li wxProcessEvent: A process ending event
  314. @li wxQueryLayoutInfoEvent: Used to query layout information
  315. @li wxRichTextEvent: A rich text editing event
  316. @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
  317. buttons
  318. @li wxScrollWinEvent: A scroll event from scrolled windows
  319. @li wxSizeEvent: A size event
  320. @li wxSocketEvent: A socket event
  321. @li wxSpinEvent: An event from wxSpinButton
  322. @li wxSplitterEvent: An event from wxSplitterWindow
  323. @li wxSysColourChangedEvent: A system colour change event
  324. @li wxTimerEvent: A timer expiration event
  325. @li wxTreebookEvent: A treebook control event
  326. @li wxTreeEvent: A tree control event
  327. @li wxUpdateUIEvent: A user interface update event
  328. @li wxWindowCreateEvent: A window creation event
  329. @li wxWindowDestroyEvent: A window destruction event
  330. @li wxWizardEvent: A wizard event
  331. @section page_class_cat_appmanagement Application and Process Management
  332. @li wxApp: Application class
  333. @li wxCmdLineParser: Command line parser class
  334. @li wxDynamicLibrary: Class to work with shared libraries.
  335. @li wxProcess: Process class
  336. @section page_class_cat_printing Printing Framework
  337. A printing and previewing framework is implemented to make it relatively
  338. straightforward to provide document printing facilities.
  339. Related Overviews: @ref overview_printing
  340. @li wxPreviewFrame: Frame for displaying a print preview
  341. @li wxPreviewCanvas: Canvas for displaying a print preview
  342. @li wxPreviewControlBar: Standard control bar for a print preview
  343. @li wxPrintDialog: Standard print dialog
  344. @li wxPageSetupDialog: Standard page setup dialog
  345. @li wxPrinter: Class representing the printer
  346. @li wxPrinterDC: Printer device context
  347. @li wxPrintout: Class representing a particular printout
  348. @li wxPrintPreview: Class representing a print preview
  349. @li wxPrintData: Represents information about the document being printed
  350. @li wxPrintDialogData: Represents information about the print dialog
  351. @li wxPageSetupDialogData: Represents information about the page setup dialog
  352. @section page_class_cat_dvf Document/View Framework
  353. wxWidgets supports a document/view framework which provides housekeeping for a
  354. document-centric application.
  355. Related Overviews: @ref overview_docview
  356. @li wxCommand: Base class for undo/redo actions
  357. @li wxCommandProcessor: Maintains the undo/redo stack
  358. @li wxDocument: Represents a document
  359. @li wxView: Represents a view
  360. @li wxDocTemplate: Manages the relationship between a document class and a
  361. view class
  362. @li wxDocManager: Manages the documents and views in an application
  363. @li wxDocChildFrame: A child frame for showing a document view
  364. @li wxDocParentFrame: A parent frame to contain views
  365. @li wxDocMDIChildFrame: An MDI child frame for showing a document view
  366. @li wxDocMDIParentFrame: An MDI parent frame to contain views
  367. @li wxFileHistory: Maintains a list of the most recently visited files
  368. @section page_class_cat_dnd Clipboard and Drag & Drop
  369. Related Overviews: @ref overview_dnd
  370. @li wxDataObject: Data object class
  371. @li wxDataFormat: Represents a data format
  372. @li wxTextDataObject: Text data object class
  373. @li wxFileDataObject: File data object class
  374. @li wxBitmapDataObject: Bitmap data object class
  375. @li wxURLDataObject: URL data object class
  376. @li wxCustomDataObject: Custom data object class
  377. @li wxClipboard: Clipboard class
  378. @li wxDropTarget: Drop target class
  379. @li wxFileDropTarget: File drop target class
  380. @li wxTextDropTarget: Text drop target class
  381. @li wxDropSource: Drop source class
  382. @section page_class_cat_vfs Virtual File System
  383. wxWidgets provides a set of classes that implement an extensible virtual file
  384. system, used internally by the HTML classes.
  385. @li wxFSFile: Represents a file in the virtual file system
  386. @li wxFileSystem: Main interface for the virtual file system
  387. @li wxFileSystemHandler: Class used to announce file system type
  388. @section page_class_cat_threading Threading
  389. wxWidgets provides a set of classes to make use of the native thread
  390. capabilities of the various platforms.
  391. Related Overviews: @ref overview_thread
  392. @li wxThread: Thread class
  393. @li wxThreadHelper: Manages background threads easily
  394. @li wxMutex: Mutex class
  395. @li wxMutexLocker: Mutex locker utility class
  396. @li wxCriticalSection: Critical section class
  397. @li wxCriticalSectionLocker: Critical section locker utility class
  398. @li wxCondition: Condition class
  399. @li wxSemaphore: Semaphore class
  400. @section page_class_cat_rtti Runtime Type Information (RTTI)
  401. wxWidgets supports runtime manipulation of class information, and dynamic
  402. creation of objects given class names.
  403. Related Overviews: @ref overview_rtti
  404. @see @ref group_funcmacro_rtti "RTTI Functions and Macros"
  405. @li wxClassInfo: Holds runtime class information
  406. @li wxObject: Root class for classes with runtime information
  407. @section page_class_cat_debugging Debugging
  408. wxWidgets supports some aspects of debugging an application through classes,
  409. functions and macros.
  410. Related Overviews: @ref overview_debugging
  411. @see @ref group_funcmacro_debug "Debugging Functions and Macros"
  412. @li wxDebugContext: Provides memory-checking facilities
  413. @li wxDebugReport: Base class for creating debug reports in case of a program
  414. crash.
  415. @li wxDebugReportCompress: Class for creating compressed debug reports.
  416. @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
  417. @li wxDebugReportPreview: Abstract base class for previewing the contents of a
  418. debug report.
  419. @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
  420. @section page_class_cat_logging Logging
  421. wxWidgets provides several classes and functions for message logging.
  422. Related overview: @ref overview_log
  423. @see @ref group_funcmacro_log "Logging Functions and Macros"
  424. @li wxLog: The base log class
  425. @li wxLogStderr: Log messages to a C STDIO stream
  426. @li wxLogStream: Log messages to a C++ iostream
  427. @li wxLogTextCtrl: Log messages to a wxTextCtrl
  428. @li wxLogWindow: Log messages to a log frame
  429. @li wxLogGui: Default log target for GUI programs
  430. @li wxLogNull: Temporarily suppress message logging
  431. @li wxLogChain: Allows to chain two log targets
  432. @li wxLogInterposer: Allows to filter the log messages
  433. @li wxLogInterposerTemp: Allows to filter the log messages
  434. @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
  435. @section page_class_cat_data Data Structures
  436. These are the data structure classes supported by wxWidgets.
  437. @li wxAny: A class for storing arbitrary types that may change at run-time
  438. @li wxCmdLineParser: Command line parser class
  439. @li wxDateSpan: A logical time interval.
  440. @li wxDateTime: A class for date/time manipulations
  441. @li wxLongLong: A portable 64 bit integer type
  442. @li wxObject: The root class for most wxWidgets classes
  443. @li wxPathList: A class to help search multiple paths
  444. @li wxPoint: Representation of a point
  445. @li wxRect: A class representing a rectangle
  446. @li wxRegEx: Regular expression support
  447. @li wxRegion: A class representing a region
  448. @li wxString: A string class
  449. @li wxStringTokenizer: A class for interpreting a string as a list of tokens or
  450. words
  451. @li wxRealPoint: Representation of a point using floating point numbers
  452. @li wxSize: Representation of a size
  453. @li wxTimeSpan: A time interval.
  454. @li wxURI: Represents a Uniform Resource Identifier
  455. @li wxVariant: A class for storing arbitrary types that may change at run-time
  456. @section page_class_cat_conv Text Conversion
  457. These classes define objects for performing conversions between different
  458. multibyte and Unicode encodings and wide character strings.
  459. @li wxMBConv: Base class for all converters, defines the API implemented by all
  460. the other converter classes.
  461. @li wxMBConvUTF7: Converter for UTF-7
  462. @li wxMBConvUTF8: Converter for UTF-8
  463. @li wxMBConvUTF16: Converter for UTF-16
  464. @li wxMBConvUTF32: Converter for UTF-32
  465. @li wxCSConv: Converter for any system-supported encoding which can be
  466. specified by name.
  467. Related Overviews: @ref overview_mbconv
  468. @section page_class_cat_containers Containers
  469. These are classes, templates and class macros are used by wxWidgets. Most of
  470. these classes provide a subset or almost complete STL API.
  471. Related Overviews: @ref overview_container
  472. @li wxArray<T>: A type-safe dynamic array implementation (macro based)
  473. @li wxArrayString: An efficient container for storing wxString objects
  474. @li wxHashMap<T>: A type-safe hash map implementation (macro based)
  475. @li wxHashSet<T>: A type-safe hash set implementation(macro based)
  476. @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
  477. @li wxList<T>: A type-safe linked list implementation (macro based)
  478. @li wxVector<T>: Template base vector implementation identical to std::vector
  479. @section page_class_cat_smartpointers Smart Pointers
  480. wxWidgets provides a few smart pointer class templates.
  481. @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
  482. @li wxScopedPtr<T>: A scoped pointer
  483. @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
  484. @li wxWeakRef<T>: A weak reference
  485. @section page_class_cat_file File Handling
  486. wxWidgets has several small classes to work with disk files and directories.
  487. Related overview: @ref overview_file
  488. @li wxFileName: Operations with the file name and attributes
  489. @li wxDir: Class for enumerating files/subdirectories.
  490. @li wxDirTraverser: Class used together with wxDir for recursively enumerating
  491. the files/subdirectories
  492. @li wxFile: Low-level file input/output class.
  493. @li wxFFile: Another low-level file input/output class.
  494. @li wxTempFile: Class to safely replace an existing file
  495. @li wxTextFile: Class for working with text files as with arrays of lines
  496. @li wxStandardPaths: Paths for standard directories
  497. @li wxPathList: A class to help search multiple paths
  498. @li wxFileSystemWatcher: Class providing notifications of file system changes
  499. @section page_class_cat_streams Streams
  500. wxWidgets has its own set of stream classes as an alternative to the
  501. standard stream libraries and to provide enhanced functionality.
  502. Related overview: @ref overview_stream
  503. @li wxStreamBase: Stream base class
  504. @li wxStreamBuffer: Stream buffer class
  505. @li wxInputStream: Input stream class
  506. @li wxOutputStream: Output stream class
  507. @li wxCountingOutputStream: Stream class for querying what size a stream would
  508. have.
  509. @li wxFilterInputStream: Filtered input stream class
  510. @li wxFilterOutputStream: Filtered output stream class
  511. @li wxBufferedInputStream: Buffered input stream class
  512. @li wxBufferedOutputStream: Buffered output stream class
  513. @li wxMemoryInputStream: Memory input stream class
  514. @li wxMemoryOutputStream: Memory output stream class
  515. @li wxDataInputStream: Platform-independent binary data input stream class
  516. @li wxDataOutputStream: Platform-independent binary data output stream class
  517. @li wxTextInputStream: Platform-independent text data input stream class
  518. @li wxTextOutputStream: Platform-independent text data output stream class
  519. @li wxFileInputStream: File input stream class
  520. @li wxFileOutputStream: File output stream class
  521. @li wxFFileInputStream: Another file input stream class
  522. @li wxFFileOutputStream: Another file output stream class
  523. @li wxTempFileOutputStream: Stream to safely replace an existing file
  524. @li wxStringInputStream: String input stream class
  525. @li wxStringOutputStream: String output stream class
  526. @li wxZlibInputStream: Zlib and gzip (compression) input stream class
  527. @li wxZlibOutputStream: Zlib and gzip (compression) output stream class
  528. @li wxZipInputStream: Input stream for reading from ZIP archives
  529. @li wxZipOutputStream: Output stream for writing from ZIP archives
  530. @li wxTarInputStream: Input stream for reading from tar archives
  531. @li wxTarOutputStream: Output stream for writing from tar archives
  532. @li wxSocketInputStream: Socket input stream class
  533. @li wxSocketOutputStream: Socket output stream class
  534. @section page_class_cat_xml XML
  535. @li wxXmlDocument: A class to parse XML files
  536. @li wxXmlNode: A class which represents XML nodes
  537. @li wxXmlAttribute: A class which represent an XML attribute
  538. @section page_class_cat_archive Archive
  539. @li wxArchiveInputStream
  540. @li wxArchiveOutputStream
  541. @li wxArchiveEntry
  542. @section page_class_cat_xrc XML Based Resource System (XRC)
  543. Resources allow your application to create controls and other user interface
  544. elements from specifications stored in an XML format.
  545. Related overview: @ref overview_xrc
  546. @li wxXmlResource: The main class for working with resources
  547. @li wxXmlResourceHandler: The base class for XML resource handlers
  548. @section page_class_cat_net Networking
  549. wxWidgets provides its own classes for socket based networking.
  550. @li wxDialUpManager: Provides functions to check the status of network
  551. connection and to establish one
  552. @li wxIPV4address: Represents an Internet address
  553. @li wxIPaddress: Represents an Internet address
  554. @li wxSocketBase: Represents a socket base object
  555. @li wxSocketClient: Represents a socket client
  556. @li wxSocketServer: Represents a socket server
  557. @li wxSocketEvent: A socket event
  558. @li wxFTP: FTP protocol class
  559. @li wxHTTP: HTTP protocol class
  560. @li wxURL: Represents a Universal Resource Locator
  561. @section page_class_cat_ipc Interprocess Communication
  562. wxWidgets provides simple interprocess communications facilities based on
  563. Windows DDE, but available on most platforms using TCP.
  564. Related overview: @ref overview_ipc
  565. @li wxClient, wxDDEClient: Represents a client
  566. @li wxConnection, wxDDEConnection: Represents the connection between a client
  567. and a server
  568. @li wxServer, wxDDEServer: Represents a server
  569. @section page_class_cat_help Help
  570. @li wxHelpController: Family of classes for controlling help windows
  571. @li wxHtmlHelpController: HTML help controller class
  572. @li wxContextHelp: Class to put application into context-sensitive help mode
  573. @li wxContextHelpButton: Button class for putting application into
  574. context-sensitive help mode
  575. @li wxHelpProvider: Abstract class for context-sensitive help provision
  576. @li wxSimpleHelpProvider: Class for simple context-sensitive help provision
  577. @li wxHelpControllerHelpProvider: Class for context-sensitive help provision
  578. via a help controller
  579. @li wxToolTip: Class implementing tooltips
  580. @section page_class_cat_media Multimedia
  581. @li wxMediaCtrl: Display multimedia contents.
  582. @section page_class_cat_gl OpenGL
  583. @li wxGLCanvas: Canvas that you can render OpenGL calls to.
  584. @li wxGLContext: Class to ease sharing of OpenGL data resources.
  585. @section page_class_cat_misc Miscellaneous
  586. @li wxCaret: A caret (cursor) object
  587. @li wxConfigBase: Classes for reading/writing the configuration settings
  588. @li wxTimer: Timer class
  589. @li wxStopWatch: Stop watch class
  590. @li wxMimeTypesManager: MIME-types manager class
  591. @li wxSystemSettings: System settings class for obtaining various global
  592. parameters
  593. @li wxSystemOptions: System options class for run-time configuration
  594. @li wxAcceleratorTable: Accelerator table
  595. @li wxAutomationObject: OLE automation class
  596. @li wxFontMapper: Font mapping, finding suitable font for given encoding
  597. @li wxEncodingConverter: Encoding conversions
  598. @li wxCalendarDateAttr: Used with wxCalendarCtrl
  599. @li wxQuantize: Class to perform quantization, or colour reduction
  600. @li wxSingleInstanceChecker: Check that only single program instance is running
  601. */