1 \chapter{Classes by category
}\label{classesbycat
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}%
5 A classification of wxWidgets classes by category.
7 {\large {\bf Managed windows
}}
9 There are several types of window that are directly controlled by the
10 window manager (such as MS Windows, or the Motif Window Manager).
11 Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
14 \begin{twocollist
}\itemsep=
0pt
15 \twocolitem{\helpref{wxTopLevelWindow
}{wxtoplevelwindow
}}{Any top level window, dialog or frame
}
16 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Dialog box
}
17 \twocolitem{\helpref{wxFrame
}{wxframe
}}{Normal frame
}
18 \twocolitem{\helpref{wxMDIChildFrame
}{wxmdichildframe
}}{MDI child frame
}
19 \twocolitem{\helpref{wxMDIParentFrame
}{wxmdiparentframe
}}{MDI parent frame
}
20 \twocolitem{\helpref{wxMiniFrame
}{wxminiframe
}}{A frame with a small title bar
}
21 \twocolitem{\helpref{wxSplashScreen
}{wxsplashscreen
}}{Splash screen class
}
22 \twocolitem{\helpref{wxPropertySheetDialog
}{wxpropertysheetdialog
}}{Property sheet dialog
}
23 %\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog
24 %(deprecated, use wxNotebook instead)}
25 \twocolitem{\helpref{wxTipWindow
}{wxtipwindow
}}{Shows text in a small window
}
26 \twocolitem{\helpref{wxWizard
}{wxwizard
}}{A wizard dialog
}
29 See also
{\bf Common dialogs
}.
31 {\large {\bf Miscellaneous windows
}}
33 The following are a variety of classes that are derived from wxWindow.
36 \begin{twocollist
}\itemsep=
0pt
37 \twocolitem{\helpref{wxPanel
}{wxpanel
}}{A window whose colour changes according to current user settings
}
38 \twocolitem{\helpref{wxScrolledWindow
}{wxscrolledwindow
}}{Window with automatically managed scrollbars
}
39 \twocolitem{\helpref{wxGrid
}{wxgrid
}}{A grid (table) window
}
40 \twocolitem{\helpref{wxSplitterWindow
}{wxsplitterwindow
}}{Window which can be split vertically or horizontally
}
41 \twocolitem{\helpref{wxStatusBar
}{wxstatusbar
}}{Implements the status bar on a frame
}
42 \twocolitem{\helpref{wxToolBar
}{wxtoolbar
}}{Toolbar class
}
43 %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
44 \twocolitem{\helpref{wxNotebook
}{wxnotebook
}}{Notebook class
}
45 \twocolitem{\helpref{wxListbook
}{wxlistbook
}}{Similar to notebook but using list control
}
46 \twocolitem{\helpref{wxChoicebook
}{wxchoicebook
}}{Similar to notebook but using choice control
}
47 \twocolitem{\helpref{wxSashWindow
}{wxsashwindow
}}{Window with four optional sashes that can be dragged
}
48 \twocolitem{\helpref{wxSashLayoutWindow
}{wxsashlayoutwindow
}}{Window that can be involved in an IDE-like layout arrangement
}
49 \twocolitem{\helpref{wxVScrolledWindow
}{wxvscrolledwindow
}}{As wxScrolledWindow but supports lines of variable height
}
50 \twocolitem{\helpref{wxWizardPage
}{wxwizardpage
}}{A base class for the page in wizard dialog.
}
51 \twocolitem{\helpref{wxWizardPageSimple
}{wxwizardpagesimple
}}{A page in wizard dialog.
}
54 {\large {\bf Common dialogs
}}
56 \overview{Overview
}{commondialogsoverview
}
58 Common dialogs are ready-made dialog classes which are frequently used
62 \begin{twocollist
}\itemsep=
0pt
63 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Base class for common dialogs
}
64 \twocolitem{\helpref{wxColourDialog
}{wxcolourdialog
}}{Colour chooser dialog
}
65 \twocolitem{\helpref{wxDirDialog
}{wxdirdialog
}}{Directory selector dialog
}
66 \twocolitem{\helpref{wxFileDialog
}{wxfiledialog
}}{File selector dialog
}
67 \twocolitem{\helpref{wxFindReplaceDialog
}{wxfindreplacedialog
}}{Text search/replace dialog
}
68 \twocolitem{\helpref{wxMultiChoiceDialog
}{wxmultichoicedialog
}}{Dialog to get one or more selections from a list
}
69 \twocolitem{\helpref{wxSingleChoiceDialog
}{wxsinglechoicedialog
}}{Dialog to get a single selection from a list and return the string
}
70 \twocolitem{\helpref{wxTextEntryDialog
}{wxtextentrydialog
}}{Dialog to get a single line of text from the user
}
71 \twocolitem{\helpref{wxPasswordEntryDialog
}{wxpasswordentrydialog
}}{Dialog to get a password from the user
}
72 \twocolitem{\helpref{wxFontDialog
}{wxfontdialog
}}{Font chooser dialog
}
73 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
74 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
75 \twocolitem{\helpref{wxMessageDialog
}{wxmessagedialog
}}{Simple message box dialog
}
76 \twocolitem{\helpref{wxWizard
}{wxwizard
}}{A wizard dialog.
}
79 {\large {\bf Controls
}}
81 Typically, these are small windows which provide interaction with the user. Controls
82 that are not static can have
\helpref{validators
}{wxvalidator
} associated with them.
85 \begin{twocollist
}\itemsep=
0pt
86 \twocolitem{\helpref{wxControl
}{wxcontrol
}}{The base class for controls
}
87 \twocolitem{\helpref{wxButton
}{wxbutton
}}{Push button control, displaying text
}
88 \twocolitem{\helpref{wxBitmapButton
}{wxbitmapbutton
}}{Push button control, displaying a bitmap
}
89 \twocolitem{\helpref{wxToggleButton
}{wxtogglebutton
}}{A button which stays pressed when clicked by user.
}
90 \twocolitem{\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}{Control showing an entire calendar month
}
91 \twocolitem{\helpref{wxCheckBox
}{wxcheckbox
}}{Checkbox control
}
92 \twocolitem{\helpref{wxCheckListBox
}{wxchecklistbox
}}{A listbox with a checkbox to the left of each item
}
93 \twocolitem{\helpref{wxChoice
}{wxchoice
}}{Choice control (a combobox without the editable area)
}
94 \twocolitem{\helpref{wxComboBox
}{wxcombobox
}}{A choice with an editable area
}
95 \twocolitem{\helpref{wxDatePickerCtrl
}{wxdatepickerctrl
}}{Small date picker control
}
96 \twocolitem{\helpref{wxGauge
}{wxgauge
}}{A control to represent a varying quantity, such as time remaining
}
97 \twocolitem{\helpref{wxGenericDirCtrl
}{wxgenericdirctrl
}}{A control for displaying a directory tree
}
98 \twocolitem{\helpref{wxHtmlListBox
}{wxhtmllistbox
}}{A listbox showing HTML content
}
99 \twocolitem{\helpref{wxStaticBox
}{wxstaticbox
}}{A static, or group box for visually grouping related controls
}
100 \twocolitem{\helpref{wxListBox
}{wxlistbox
}}{A list of strings for single or multiple selection
}
101 \twocolitem{\helpref{wxListCtrl
}{wxlistctrl
}}{A control for displaying lists of strings and/or icons, plus a multicolumn
report view
}
102 \twocolitem{\helpref{wxListView
}{wxlistview
}}{A simpler interface (
{\it fa
\c{c
}ade
} for wxListCtrl in
report mode
}
103 \twocolitem{\helpref{wxTextCtrl
}{wxtextctrl
}}{Single or multiline text editing control
}
104 \twocolitem{\helpref{wxTreeCtrl
}{wxtreectrl
}}{Tree (hierarchy) control
}
105 \twocolitem{\helpref{wxScrollBar
}{wxscrollbar
}}{Scrollbar control
}
106 \twocolitem{\helpref{wxSpinButton
}{wxspinbutton
}}{A spin or `up-down' control
}
107 \twocolitem{\helpref{wxSpinCtrl
}{wxspinctrl
}}{A spin control - i.e. spin button and text control
}
108 \twocolitem{\helpref{wxStaticText
}{wxstatictext
}}{One or more lines of non-editable text
}
109 \twocolitem{\helpref{wxStaticBitmap
}{wxstaticbitmap
}}{A control to display a bitmap
}
110 \twocolitem{\helpref{wxRadioBox
}{wxradiobox
}}{A group of radio buttons
}
111 \twocolitem{\helpref{wxRadioButton
}{wxradiobutton
}}{A round button to be used with others in a mutually exclusive way
}
112 \twocolitem{\helpref{wxSlider
}{wxslider
}}{A slider that can be dragged by the user
}
113 \twocolitem{\helpref{wxVListBox
}{wxvlistbox
}}{A listbox supporting variable height rows
}
119 \begin{twocollist
}\itemsep=
0pt
120 \twocolitem{\helpref{wxMenu
}{wxmenu
}}{Displays a series of menu items for selection
}
121 \twocolitem{\helpref{wxMenuBar
}{wxmenubar
}}{Contains a series of menus for use with a frame
}
122 \twocolitem{\helpref{wxMenuItem
}{wxmenuitem
}}{Represents a single menu item
}
125 {\large {\bf Window layout
}}
127 There are two different systems for laying out windows (and dialogs in particular).
128 One is based upon so-called sizers and it requires less typing, thinking and calculating
129 and will in almost all cases produce dialogs looking equally well on all platforms, the
130 other is based on so-called constraints and is deprecated, though still available.
132 \overview{Sizer overview
}{sizeroverview
} describes sizer-based layout.
134 These are the classes relevant to sizer-based layout.
137 \begin{twocollist
}\itemsep=
0pt
138 \twocolitem{\helpref{wxSizer
}{wxsizer
}}{Abstract base class
}
139 \twocolitem{\helpref{wxGridSizer
}{wxgridsizer
}}{A sizer for laying out windows in a grid with all fields having the same size
}
140 \twocolitem{\helpref{wxFlexGridSizer
}{wxflexgridsizer
}}{A sizer for laying out windows in a flexible grid
}
141 \twocolitem{\helpref{wxGridBagSizer
}{wxgridbagsizer
}}{Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.
}
142 \twocolitem{\helpref{wxBoxSizer
}{wxboxsizer
}}{A sizer for laying out windows in a row or column
}
143 \twocolitem{\helpref{wxStaticBoxSizer
}{wxstaticboxsizer
}}{Same as wxBoxSizer, but with a surrounding static box
}
146 \overview{Constraints overview
}{constraintsoverview
} describes constraints-based layout.
148 These are the classes relevant to constraints-based window layout.
151 \begin{twocollist
}\itemsep=
0pt
152 \twocolitem{\helpref{wxIndividualLayoutConstraint
}{wxindividuallayoutconstraint
}}{Represents a single constraint dimension
}
153 \twocolitem{\helpref{wxLayoutConstraints
}{wxlayoutconstraints
}}{Represents the constraints for a window class
}
156 {\large {\bf Device contexts
}}
158 \overview{Overview
}{dcoverview
}
160 Device contexts are surfaces that may be drawn on, and provide an
161 abstraction that allows parameterisation of your drawing code
162 by passing different device contexts.
165 \begin{twocollist
}\itemsep=
0pt
166 \twocolitem{\helpref{wxBufferedDC
}{wxbuffereddc
}}{A helper device context for double buffered drawing.
}
167 \twocolitem{\helpref{wxBufferedPaintDC
}{wxbufferedpaintdc
}}{A helper device context for double buffered drawing inside
\textbf{OnPaint
}.
}
168 \twocolitem{\helpref{wxClientDC
}{wxclientdc
}}{A device context to access the client area outside
{\bf OnPaint
} events
}
169 \twocolitem{\helpref{wxPaintDC
}{wxpaintdc
}}{A device context to access the client area inside
{\bf OnPaint
} events
}
170 \twocolitem{\helpref{wxWindowDC
}{wxwindowdc
}}{A device context to access the non-client area
}
171 \twocolitem{\helpref{wxScreenDC
}{wxscreendc
}}{A device context to access the entire screen
}
172 \twocolitem{\helpref{wxDC
}{wxdc
}}{The device context base class
}
173 \twocolitem{\helpref{wxMemoryDC
}{wxmemorydc
}}{A device context for drawing into bitmaps
}
174 \twocolitem{\helpref{wxMetafileDC
}{wxmetafiledc
}}{A device context for drawing into metafiles
}
175 \twocolitem{\helpref{wxMirrorDC
}{wxmirrordc
}}{A proxy device context allowing for simple mirroring.
}
176 \twocolitem{\helpref{wxPostScriptDC
}{wxpostscriptdc
}}{A device context for drawing into PostScript files
}
177 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{A device context for drawing to printers
}
180 {\large {\bf Graphics device interface
}}
182 \overview{Bitmaps overview
}{wxbitmapoverview
}
184 These classes are related to drawing on device contexts and windows.
187 \begin{twocollist
}\itemsep=
0pt
188 \twocolitem{\helpref{wxColour
}{wxcolour
}}{Represents the red, blue and green elements of a colour
}
189 \twocolitem{\helpref{wxDCClipper
}{wxdcclipper
}}{Wraps the operations of setting and destroying the clipping region
}
190 \twocolitem{\helpref{wxBitmap
}{wxbitmap
}}{Represents a bitmap
}
191 \twocolitem{\helpref{wxBrush
}{wxbrush
}}{Used for filling areas on a device context
}
192 \twocolitem{\helpref{wxBrushList
}{wxbrushlist
}}{The list of previously-created brushes
}
193 \twocolitem{\helpref{wxCursor
}{wxcursor
}}{A small, transparent bitmap representing the cursor
}
194 \twocolitem{\helpref{wxFont
}{wxfont
}}{Represents fonts
}
195 \twocolitem{\helpref{wxFontList
}{wxfontlist
}}{The list of previously-created fonts
}
196 \twocolitem{\helpref{wxIcon
}{wxicon
}}{A small, transparent bitmap for assigning to frames and drawing on device contexts
}
197 \twocolitem{\helpref{wxImage
}{wximage
}}{A platform-independent image class
}
198 \twocolitem{\helpref{wxImageList
}{wximagelist
}}{A list of images, used with some controls
}
199 \twocolitem{\helpref{wxMask
}{wxmask
}}{Represents a mask to be used with a bitmap for transparent drawing
}
200 \twocolitem{\helpref{wxPen
}{wxpen
}}{Used for drawing lines on a device context
}
201 \twocolitem{\helpref{wxPenList
}{wxpenlist
}}{The list of previously-created pens
}
202 \twocolitem{\helpref{wxPalette
}{wxpalette
}}{Represents a table of indices into RGB values
}
203 \twocolitem{\helpref{wxRegion
}{wxregion
}}{Represents a simple or complex region on a window or device context
}
204 \twocolitem{\helpref{wxRendererNative
}{wxrenderernative
}}{Abstracts high-level drawing primitives
}
207 {\large {\bf Events
}}
209 \overview{Overview
}{eventhandlingoverview
}
211 An event object contains information about a specific event. Event handlers
212 (usually member functions) have a single, event argument.
215 \begin{twocollist
}\itemsep=
0pt
216 \twocolitem{\helpref{wxActivateEvent
}{wxactivateevent
}}{A window or application activation event
}
217 \twocolitem{\helpref{wxCalendarEvent
}{wxcalendarevent
}}{Used with
\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}
218 \twocolitem{\helpref{wxCalculateLayoutEvent
}{wxcalculatelayoutevent
}}{Used to calculate window layout
}
219 \twocolitem{\helpref{wxCloseEvent
}{wxcloseevent
}}{A close window or end session event
}
220 \twocolitem{\helpref{wxCommandEvent
}{wxcommandevent
}}{An event from a variety of standard controls
}
221 \twocolitem{\helpref{wxContextMenuEvent
}{wxcontextmenuevent
}}{An event generated when the user issues a context menu command
}
222 \twocolitem{\helpref{wxDialUpEvent
}{wxdialupevent
}}{Event send by
\helpref{wxDialUpManager
}{wxdialupmanager
}}
223 \twocolitem{\helpref{wxDropFilesEvent
}{wxdropfilesevent
}}{A drop files event
}
224 \twocolitem{\helpref{wxEraseEvent
}{wxeraseevent
}}{An erase background event
}
225 \twocolitem{\helpref{wxEvent
}{wxevent
}}{The event base class
}
226 \twocolitem{\helpref{wxFindDialogEvent
}{wxfinddialogevent
}}{Event sent by
227 \helpref{wxFindReplaceDialog
}{wxfindreplacedialog
}}
228 \twocolitem{\helpref{wxFocusEvent
}{wxfocusevent
}}{A window focus event
}
229 \twocolitem{\helpref{wxKeyEvent
}{wxkeyevent
}}{A keypress event
}
230 \twocolitem{\helpref{wxIconizeEvent
}{wxiconizeevent
}}{An iconize/restore event
}
231 \twocolitem{\helpref{wxIdleEvent
}{wxidleevent
}}{An idle event
}
232 \twocolitem{\helpref{wxInitDialogEvent
}{wxinitdialogevent
}}{A dialog initialisation event
}
233 \twocolitem{\helpref{wxJoystickEvent
}{wxjoystickevent
}}{A joystick event
}
234 \twocolitem{\helpref{wxListEvent
}{wxlistevent
}}{A list control event
}
235 \twocolitem{\helpref{wxMaximizeEvent
}{wxmaximizeevent
}}{A maximize event
}
236 \twocolitem{\helpref{wxMenuEvent
}{wxmenuevent
}}{A menu event
}
237 \twocolitem{\helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}}{A mouse capture changed event
}
238 \twocolitem{\helpref{wxMouseEvent
}{wxmouseevent
}}{A mouse event
}
239 \twocolitem{\helpref{wxMoveEvent
}{wxmoveevent
}}{A move event
}
240 \twocolitem{\helpref{wxNotebookEvent
}{wxnotebookevent
}}{A notebook control event
}
241 \twocolitem{\helpref{wxNotifyEvent
}{wxnotifyevent
}}{A notification event, which can be vetoed
}
242 \twocolitem{\helpref{wxPaintEvent
}{wxpaintevent
}}{A paint event
}
243 \twocolitem{\helpref{wxProcessEvent
}{wxprocessevent
}}{A process ending event
}
244 \twocolitem{\helpref{wxQueryLayoutInfoEvent
}{wxquerylayoutinfoevent
}}{Used to query layout information
}
245 \twocolitem{\helpref{wxScrollEvent
}{wxscrollevent
}}{A scroll event from sliders, stand-alone scrollbars and spin buttons
}
246 \twocolitem{\helpref{wxScrollWinEvent
}{wxscrollwinevent
}}{A scroll event from scrolled windows
}
247 \twocolitem{\helpref{wxSizeEvent
}{wxsizeevent
}}{A size event
}
248 \twocolitem{\helpref{wxSocketEvent
}{wxsocketevent
}}{A socket event
}
249 \twocolitem{\helpref{wxSpinEvent
}{wxspinevent
}}{An event from
\helpref{wxSpinButton
}{wxspinbutton
}}
250 \twocolitem{\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}}{A system colour change event
}
251 \twocolitem{\helpref{wxTimerEvent
}{wxtimerevent
}}{A timer expiration event
}
252 \twocolitem{\helpref{wxTreeEvent
}{wxtreeevent
}}{A tree control event
}
253 \twocolitem{\helpref{wxUpdateUIEvent
}{wxupdateuievent
}}{A user interface update event
}
254 \twocolitem{\helpref{wxWizardEvent
}{wxwizardevent
}}{A wizard event
}
257 {\large {\bf Validators
}}
259 \overview{Overview
}{validatoroverview
}
261 These are the window validators, used for filtering and validating
265 \begin{twocollist
}\itemsep=
0pt
266 \twocolitem{\helpref{wxValidator
}{wxvalidator
}}{Base validator class
}
267 \twocolitem{\helpref{wxTextValidator
}{wxtextvalidator
}}{Text control validator class
}
268 \twocolitem{\helpref{wxGenericValidator
}{wxgenericvalidator
}}{Generic control validator class
}
271 {\large {\bf Data structures
}}
273 These are the data structure classes supported by wxWidgets.
276 \begin{twocollist
}\itemsep=
0pt
277 \twocolitem{\helpref{wxCmdLineParser
}{wxcmdlineparser
}}{Command line parser class
}
278 \twocolitem{\helpref{wxDateSpan
}{wxdatespan
}}{A logical time interval.
}
279 \twocolitem{\helpref{wxDateTime
}{wxdatetime
}}{A class for date/time manipulations
}
280 %\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O}
281 %\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O}
282 \twocolitem{\helpref{wxHashMap
}{wxhashmap
}}{A simple hash map implementation
}
283 \twocolitem{\helpref{wxHashSet
}{wxhashset
}}{A simple hash set implementation
}
284 \twocolitem{\helpref{wxHashTable
}{wxhashtable
}}{A simple hash table implementation (deprecated, use wxHashMap)
}
285 % \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data}
286 \twocolitem{\helpref{wxList
}{wxlist
}}{A simple linked list implementation
}
287 \twocolitem{\helpref{wxLongLong
}{wxlonglong
}}{A portable
64 bit integer type
}
288 \twocolitem{\helpref{wxNode
}{wxnode
}}{Represents a node in the wxList implementation
}
289 \twocolitem{\helpref{wxObject
}{wxobject
}}{The root class for most wxWidgets classes
}
290 \twocolitem{\helpref{wxPathList
}{wxpathlist
}}{A class to help search multiple paths
}
291 \twocolitem{\helpref{wxPoint
}{wxpoint
}}{Representation of a point
}
292 \twocolitem{\helpref{wxRect
}{wxrect
}}{A class representing a rectangle
}
293 \twocolitem{\helpref{wxRegEx
}{wxregex
}}{Regular expression support
}
294 \twocolitem{\helpref{wxRegion
}{wxregion
}}{A class representing a region
}
295 \twocolitem{\helpref{wxString
}{wxstring
}}{A string class
}
296 \twocolitem{\helpref{wxStringTokenizer
}{wxstringtokenizer
}}{A class for interpreting a string as a list of tokens or words
}
297 \twocolitem{\helpref{wxRealPoint
}{wxrealpoint
}}{Representation of a point using floating point numbers
}
298 \twocolitem{\helpref{wxSize
}{wxsize
}}{Representation of a size
}
299 \twocolitem{\helpref{wxTimeSpan
}{wxtimespan
}}{A time interval.
}
300 \twocolitem{\helpref{wxURI
}{wxuri
}}{Represents a Uniform Resource Identifier
}
301 \twocolitem{\helpref{wxVariant
}{wxvariant
}}{A class for storing arbitrary types that may change at run-time
}
304 {\large {\bf Run-time class information system
}}
306 \overview{Overview
}{runtimeclassoverview
}
308 wxWidgets supports run-time manipulation of class information, and dynamic
309 creation of objects given class names.
312 \begin{twocollist
}\itemsep=
0pt
313 \twocolitem{\helpref{wxClassInfo
}{wxclassinfo
}}{Holds run-time class information
}
314 \twocolitem{\helpref{wxObject
}{wxobject
}}{Root class for classes with run-time information
}
315 \twocolitem{\helpref{RTTI macros
}{rttimacros
}}{Macros for manipulating run-time information
}
318 {\large {\bf Logging features
}}
320 \overview{Overview
}{wxlogoverview
}
322 wxWidgets provides several classes and functions for message logging.
323 Please see the
\helpref{wxLog overview
}{wxlogoverview
} for more details.
326 \begin{twocollist
}\itemsep=
0pt
327 \twocolitem{\helpref{wxLog
}{wxlog
}}{The base log class
}
328 \twocolitem{\helpref{wxLogStderr
}{wxlogstderr
}}{Log messages to a C STDIO stream
}
329 \twocolitem{\helpref{wxLogStream
}{wxlogstream
}}{Log messages to a C++ iostream
}
330 \twocolitem{\helpref{wxLogTextCtrl
}{wxlogtextctrl
}}{Log messages to a
\helpref{wxTextCtrl
}{wxtextctrl
}}
331 \twocolitem{\helpref{wxLogWindow
}{wxlogwindow
}}{Log messages to a log frame
}
332 \twocolitem{\helpref{wxLogGui
}{wxloggui
}}{Default log target for GUI programs
}
333 \twocolitem{\helpref{wxLogNull
}{wxlognull
}}{Temporarily suppress message logging
}
334 \twocolitem{\helpref{wxLogChain
}{wxlogchain
}}{Allows to chain two log targets
}
335 \twocolitem{\helpref{wxLogPassThrough
}{wxlogpassthrough
}}{Allows to filter the log messages
}
336 \twocolitem{\helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}}{Allows
337 to redirect output sent to
{\tt cout
} to a
\helpref{wxTextCtrl
}{wxtextctrl
}}
338 \twocolitem{\helpref{Log functions
}{logfunctions
}}{Error and warning logging functions
}
341 {\large {\bf Debugging features
}}
343 \overview{Overview
}{debuggingoverview
}
345 wxWidgets supports some aspects of debugging an application through
346 classes, functions and macros.
349 \begin{twocollist
}\itemsep=
0pt
350 \twocolitem{\helpref{wxDebugContext
}{wxdebugcontext
}}{Provides memory-checking facilities
}
351 \twocolitem{\helpref{Debugging macros
}{debugmacros
}}{Debug macros for assertion and checking
}
352 \twocolitem{\helpref{WXDEBUG
\_NEW}{debugnew
}}{Use this macro to give further debugging information
}
353 \twocolitem{\helpref{wxDebugReport
}{wxdebugreport
}}{Base class for creating debug reports in case of a program crash.
}
354 \twocolitem{\helpref{wxDebugReportCompress
}{wxdebugreportcompress
}}{Class for creating compressed debug reports.
}
355 \twocolitem{\helpref{wxDebugReportUpload
}{wxdebugreportupload
}}{Class for uploading compressed debug reports via HTTP.
}
356 \twocolitem{\helpref{wxDebugReportPreview
}{wxdebugreportpreview
}}{Abstract base class for previewing the contents of a debug
report.
}
357 \twocolitem{\helpref{wxDebugReportPreviewStd
}{wxdebugreportpreviewstd
}}{Standard implementation of wxDebugReportPreview.
}
360 {\large {\bf Networking classes
}}
362 wxWidgets provides its own classes for socket based networking.
365 \begin{twocollist
}\itemsep=
0pt
366 \twocolitem{\helpref{wxDialUpManager
}{wxdialupmanager
}}{Provides functions to check the status of network connection and to establish one
}
367 \twocolitem{\helpref{wxIPV4address
}{wxipv4address
}}{Represents an Internet address
}
368 \twocolitem{\helpref{wxIPaddress
}{wxipaddress
}}{Represents an Internet address
}
369 \twocolitem{\helpref{wxSocketBase
}{wxsocketbase
}}{Represents a socket base object
}
370 \twocolitem{\helpref{wxSocketClient
}{wxsocketclient
}}{Represents a socket client
}
371 \twocolitem{\helpref{wxSocketServer
}{wxsocketserver
}}{Represents a socket server
}
372 \twocolitem{\helpref{wxSocketEvent
}{wxsocketevent
}}{A socket event
}
373 \twocolitem{\helpref{wxFTP
}{wxftp
}}{FTP protocol class
}
374 \twocolitem{\helpref{wxHTTP
}{wxhttp
}}{HTTP protocol class
}
375 \twocolitem{\helpref{wxURL
}{wxurl
}}{Represents a Universal Resource Locator
}
379 {\large {\bf Interprocess communication
}}
381 \overview{Overview
}{ipcoverview
}
383 wxWidgets provides simple interprocess communications facilities
384 based on Windows DDE, but available on most platforms using TCP.
387 \begin{twocollist
}\itemsep=
0pt
388 \twocolitem{\helpref{wxClient
}{wxclient
},
\helpref{wxDDEClient
}{wxddeclient
}}{Represents a client
}
389 \twocolitem{\helpref{wxConnection
}{wxconnection
},
\helpref{wxDDEConnection
}{wxddeconnection
}}{Represents the connection between a client and a server
}
390 \twocolitem{\helpref{wxServer
}{wxserver
},
\helpref{wxDDEServer
}{wxddeserver
}}{Represents a server
}
391 %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
394 {\large {\bf Document/view framework
}}
396 \overview{Overview
}{docviewoverview
}
398 wxWidgets supports a
document/view framework which provides
399 housekeeping for a
document-centric application.
402 \begin{twocollist
}\itemsep=
0pt
403 \twocolitem{\helpref{wxDocument
}{wxdocument
}}{Represents a
document}
404 \twocolitem{\helpref{wxView
}{wxview
}}{Represents a view
}
405 \twocolitem{\helpref{wxDocTemplate
}{wxdoctemplate
}}{Manages the relationship between a
document class and a view class
}
406 \twocolitem{\helpref{wxDocManager
}{wxdocmanager
}}{Manages the documents and views in an application
}
407 \twocolitem{\helpref{wxDocChildFrame
}{wxdocchildframe
}}{A child frame for showing a
document view
}
408 \twocolitem{\helpref{wxDocParentFrame
}{wxdocparentframe
}}{A parent frame to contain views
}
409 %\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
410 %\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
413 {\large {\bf Printing framework
}}
415 \overview{Overview
}{printingoverview
}
417 A printing and previewing framework is implemented to
418 make it relatively straightforward to provide
document printing
422 \begin{twocollist
}\itemsep=
0pt
423 \twocolitem{\helpref{wxPreviewFrame
}{wxpreviewframe
}}{Frame for displaying a print preview
}
424 \twocolitem{\helpref{wxPreviewCanvas
}{wxpreviewcanvas
}}{Canvas for displaying a print preview
}
425 \twocolitem{\helpref{wxPreviewControlBar
}{wxpreviewcontrolbar
}}{Standard control bar for a print preview
}
426 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
427 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
428 \twocolitem{\helpref{wxPrinter
}{wxprinter
}}{Class representing the printer
}
429 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{Printer device context
}
430 \twocolitem{\helpref{wxPrintout
}{wxprintout
}}{Class representing a particular printout
}
431 \twocolitem{\helpref{wxPrintPreview
}{wxprintpreview
}}{Class representing a print preview
}
432 \twocolitem{\helpref{wxPrintData
}{wxprintdata
}}{Represents information about the
document being printed
}
433 \twocolitem{\helpref{wxPrintDialogData
}{wxprintdialogdata
}}{Represents information about the print dialog
}
434 \twocolitem{\helpref{wxPageSetupDialogData
}{wxpagesetupdialogdata
}}{Represents information about the page setup dialog
}
437 {\large {\bf Drag and drop and clipboard classes
}}
439 \overview{Drag and drop and clipboard overview
}{wxdndoverview
}
442 \begin{twocollist
}\itemsep=
0pt
443 \twocolitem{\helpref{wxDataObject
}{wxdataobject
}}{Data object class
}
444 \twocolitem{\helpref{wxDataFormat
}{wxdataformat
}}{Represents a data format
}
445 \twocolitem{\helpref{wxTextDataObject
}{wxtextdataobject
}}{Text data object class
}
446 \twocolitem{\helpref{wxFileDataObject
}{wxfiledataobject
}}{File data object class
}
447 \twocolitem{\helpref{wxBitmapDataObject
}{wxbitmapdataobject
}}{Bitmap data object class
}
448 \twocolitem{\helpref{wxCustomDataObject
}{wxcustomdataobject
}}{Custom data object class
}
449 \twocolitem{\helpref{wxClipboard
}{wxclipboard
}}{Clipboard class
}
450 \twocolitem{\helpref{wxDropTarget
}{wxdroptarget
}}{Drop target class
}
451 \twocolitem{\helpref{wxFileDropTarget
}{wxfiledroptarget
}}{File drop target class
}
452 \twocolitem{\helpref{wxTextDropTarget
}{wxtextdroptarget
}}{Text drop target class
}
453 \twocolitem{\helpref{wxDropSource
}{wxdropsource
}}{Drop source class
}
456 {\large {\bf File related classes
}}
458 wxWidgets has several small classes to work with disk files, see
\helpref{file classes
459 overview
}{wxfileoverview
} for more details.
462 \begin{twocollist
}\itemsep=
0pt
463 \twocolitem{\helpref{wxFileName
}{wxfilename
}}{Operations with the file name and attributes
}
464 \twocolitem{\helpref{wxDir
}{wxdir
}}{Class for enumerating files/subdirectories.
}
465 \twocolitem{\helpref{wxDirTraverser
}{wxdirtraverser
}}{Class used together with wxDir for recursively enumerating the files/subdirectories
}
466 \twocolitem{\helpref{wxFile
}{wxfile
}}{Low-level file input/output class.
}
467 \twocolitem{\helpref{wxFFile
}{wxffile
}}{Another low-level file input/output class.
}
468 \twocolitem{\helpref{wxTempFile
}{wxtempfile
}}{Class to safely replace an existing file
}
469 \twocolitem{\helpref{wxTextFile
}{wxtextfile
}}{Class for working with text files as with arrays of lines
}
470 \twocolitem{\helpref{wxStandardPaths
}{wxstandardpaths
}}{Paths for standard directories
}
473 {\large {\bf Stream classes
}}
475 wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
476 libraries, and to provide enhanced functionality.
479 \begin{twocollist
}\itemsep=
0pt
480 \twocolitem{\helpref{wxStreamBase
}{wxstreambase
}}{Stream base class
}
481 \twocolitem{\helpref{wxStreamBuffer
}{wxstreambuffer
}}{Stream buffer class
}
482 \twocolitem{\helpref{wxInputStream
}{wxinputstream
}}{Input stream class
}
483 \twocolitem{\helpref{wxOutputStream
}{wxoutputstream
}}{Output stream class
}
484 \twocolitem{\helpref{wxCountingOutputStream
}{wxcountingoutputstream
}}{Stream class for querying what size a stream would have.
}
485 \twocolitem{\helpref{wxFilterInputStream
}{wxfilterinputstream
}}{Filtered input stream class
}
486 \twocolitem{\helpref{wxFilterOutputStream
}{wxfilteroutputstream
}}{Filtered output stream class
}
487 \twocolitem{\helpref{wxBufferedInputStream
}{wxbufferedinputstream
}}{Buffered input stream class
}
488 \twocolitem{\helpref{wxBufferedOutputStream
}{wxbufferedoutputstream
}}{Buffered output stream class
}
489 \twocolitem{\helpref{wxMemoryInputStream
}{wxmeminputstream
}}{Memory input stream class
}
490 \twocolitem{\helpref{wxMemoryOutputStream
}{wxmemoutputstream
}}{Memory output stream class
}
491 \twocolitem{\helpref{wxDataInputStream
}{wxdatainputstream
}}{Platform-independent binary data input stream class
}
492 \twocolitem{\helpref{wxDataOutputStream
}{wxdataoutputstream
}}{Platform-independent binary data output stream class
}
493 \twocolitem{\helpref{wxTextInputStream
}{wxtextinputstream
}}{Platform-independent text data input stream class
}
494 \twocolitem{\helpref{wxTextOutputStream
}{wxtextoutputstream
}}{Platform-independent text data output stream class
}
495 \twocolitem{\helpref{wxFileInputStream
}{wxfileinputstream
}}{File input stream class
}
496 \twocolitem{\helpref{wxFileOutputStream
}{wxfileoutputstream
}}{File output stream class
}
497 \twocolitem{\helpref{wxFFileInputStream
}{wxffileinputstream
}}{Another file input stream class
}
498 \twocolitem{\helpref{wxFFileOutputStream
}{wxffileoutputstream
}}{Another file output stream class
}
499 \twocolitem{\helpref{wxTempFileOutputStream
}{wxtempfileoutputstream
}}{Stream to safely replace an existing file
}
500 \twocolitem{\helpref{wxStringInputStream
}{wxstringinputstream
}}{String input stream class
}
501 \twocolitem{\helpref{wxStringOutputStream
}{wxstringoutputstream
}}{String output stream class
}
502 \twocolitem{\helpref{wxZlibInputStream
}{wxzlibinputstream
}}{Zlib (compression) input stream class
}
503 \twocolitem{\helpref{wxZlibOutputStream
}{wxzliboutputstream
}}{Zlib (compression) output stream class
}
504 \twocolitem{\helpref{wxZipInputStream
}{wxzipinputstream
}}{Input stream for reading from ZIP archives
}
505 \twocolitem{\helpref{wxZipOutputStream
}{wxzipoutputstream
}}{Output stream for writing from ZIP archives
}
506 \twocolitem{\helpref{wxSocketInputStream
}{wxsocketinputstream
}}{Socket input stream class
}
507 \twocolitem{\helpref{wxSocketOutputStream
}{wxsocketoutputstream
}}{Socket output stream class
}
510 {\large {\bf Threading classes
}}
512 \overview{Multithreading overview
}{wxthreadoverview
}
514 wxWidgets provides a set of classes to make use of the native thread
515 capabilities of the various platforms.
518 \begin{twocollist
}\itemsep=
0pt
519 \twocolitem{\helpref{wxThread
}{wxthread
}}{Thread class
}
520 \twocolitem{\helpref{wxThreadHelper
}{wxthreadhelper
}}{Manages background threads easily
}
521 \twocolitem{\helpref{wxMutex
}{wxmutex
}}{Mutex class
}
522 \twocolitem{\helpref{wxMutexLocker
}{wxmutexlocker
}}{Mutex locker utility class
}
523 \twocolitem{\helpref{wxCriticalSection
}{wxcriticalsection
}}{Critical section class
}
524 \twocolitem{\helpref{wxCriticalSectionLocker
}{wxcriticalsectionlocker
}}{Critical section locker utility class
}
525 \twocolitem{\helpref{wxCondition
}{wxcondition
}}{Condition class
}
526 \twocolitem{\helpref{wxSemaphore
}{wxsemaphore
}}{Semaphore class
}
529 {\large {\bf HTML classes
}}
531 wxWidgets provides a set of classes to display text in HTML format. These
532 class include a help system based on the HTML widget.
535 \begin{twocollist
}\itemsep=
0pt
536 \twocolitem{\helpref{wxHtmlHelpController
}{wxhtmlhelpcontroller
}}{HTML help controller class
}
537 \twocolitem{\helpref{wxHtmlWindow
}{wxhtmlwindow
}}{HTML window class
}
538 \twocolitem{\helpref{wxHtmlEasyPrinting
}{wxhtmleasyprinting
}}{Simple class for printing HTML
}
539 \twocolitem{\helpref{wxHtmlPrintout
}{wxhtmlprintout
}}{Generic HTML wxPrintout class
}
540 \twocolitem{\helpref{wxHtmlParser
}{wxhtmlparser
}}{Generic HTML parser class
}
541 \twocolitem{\helpref{wxHtmlTagHandler
}{wxhtmltaghandler
}}{HTML tag handler, pluginable into wxHtmlParser
}
542 \twocolitem{\helpref{wxHtmlWinParser
}{wxhtmlwinparser
}}{HTML parser class for wxHtmlWindow
}
543 \twocolitem{\helpref{wxHtmlWinTagHandler
}{wxhtmlwintaghandler
}}{HTML tag handler, pluginable into wxHtmlWinParser
}
546 {\large {\bf Virtual file system classes
}}
548 wxWidgets provides a set of classes that implement an extensible virtual file system,
549 used internally by the HTML classes.
552 \begin{twocollist
}\itemsep=
0pt
553 \twocolitem{\helpref{wxFSFile
}{wxfsfile
}}{Represents a file in the virtual file system
}
554 \twocolitem{\helpref{wxFileSystem
}{wxfilesystem
}}{Main interface for the virtual file system
}
555 \twocolitem{\helpref{wxFileSystemHandler
}{wxfilesystemhandler
}}{Class used to announce file system type
}
558 {\large {\bf XML-based resource system classes
}}
560 \overview{XML-based resource system (XRC) overview
}{xrcoverview
}
562 Resources allow your application to create controls and other user interface elements
563 from specifications stored in an XML format.
566 \begin{twocollist
}\itemsep=
0pt
567 \twocolitem{\helpref{wxXmlResource
}{wxxmlresource
}}{The main class for working with resources.
}
568 \twocolitem{\helpref{wxXmlResourceHandler
}{wxxmlresourcehandler
}}{The base class for XML resource handlers.
}
571 {\large {\bf Online help
}}
574 \begin{twocollist
}\itemsep=
0pt
575 \twocolitem{\helpref{wxHelpController
}{wxhelpcontroller
}}{Family of classes for controlling help windows
}
576 \twocolitem{\helpref{wxHtmlHelpController
}{wxhtmlhelpcontroller
}}{HTML help controller class
}
577 \twocolitem{\helpref{wxContextHelp
}{wxcontexthelp
}}{Class to put application into context-sensitive help mode
}
578 \twocolitem{\helpref{wxContextHelpButton
}{wxcontexthelpbutton
}}{Button class for putting application into context-sensitive help mode
}
579 \twocolitem{\helpref{wxHelpProvider
}{wxhelpprovider
}}{Abstract class for context-sensitive help provision
}
580 \twocolitem{\helpref{wxSimpleHelpProvider
}{wxsimplehelpprovider
}}{Class for simple context-sensitive help provision
}
581 \twocolitem{\helpref{wxHelpControllerHelpProvider
}{wxhelpcontrollerhelpprovider
}}{Class for context-sensitive help provision via a help controller
}
582 \twocolitem{\helpref{wxToolTip
}{wxtooltip
}}{Class implementing tooltips
}
585 {\large {\bf Database classes
}}
587 \overview{Database classes overview
}{odbcoverview
}
589 wxWidgets provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
590 product, donated by Remstar. This is known as wxODBC.
593 \begin{twocollist
}\itemsep=
0pt
594 \twocolitem{\helpref{wxDb
}{wxdb
}}{ODBC database connection
}
595 \twocolitem{\helpref{wxDbTable
}{wxdbtable
}}{Provides access to a database table
}
596 \twocolitem{\helpref{wxDbInf
}{wxdbinf
}}{}
597 \twocolitem{\helpref{wxDbTableInf
}{wxdbtableinf
}}{}
598 \twocolitem{\helpref{wxDbColDef
}{wxdbcoldef
}}{}
599 \twocolitem{\helpref{wxDbColInf
}{wxdbcolinf
}}{}
600 \twocolitem{\helpref{wxDbColDataPtr
}{wxdbcoldataptr
}}{}
601 \twocolitem{\helpref{wxDbColFor
}{wxdbcolfor
}}{}
602 \twocolitem{\helpref{wxDbConnectInf
}{wxdbconnectinf
}}{}
603 \twocolitem{\helpref{wxDbIdxDef
}{wxdbidxdef
}}{}
606 {\large {\bf Miscellaneous
}}
609 \begin{twocollist
}\itemsep=
0pt
610 \twocolitem{\helpref{wxApp
}{wxapp
}}{Application class
}
611 \twocolitem{\helpref{wxCaret
}{wxcaret
}}{A caret (cursor) object
}
612 \twocolitem{\helpref{wxCmdLineParser
}{wxcmdlineparser
}}{Command line parser class
}
613 \twocolitem{\helpref{wxConfig
}{wxconfigbase
}}{Classes for configuration reading/writing (using either INI files or registry)
}
614 \twocolitem{\helpref{wxDllLoader
}{wxdllloader
}}{Class to work with shared libraries.
}
615 \twocolitem{\helpref{wxGLCanvas
}{wxglcanvas
}}{Canvas that you can render opengl calls to.
}
616 \twocolitem{\helpref{wxGLContext
}{wxglcontext
}}{Class to ease sharing of opengl data resources.
}
617 \twocolitem{\helpref{wxLayoutAlgorithm
}{wxlayoutalgorithm
}}{An alternative window layout facility
}
618 \twocolitem{\helpref{wxProcess
}{wxprocess
}}{Process class
}
619 \twocolitem{\helpref{wxTimer
}{wxtimer
}}{Timer class
}
620 \twocolitem{\helpref{wxStopWatch
}{wxstopwatch
}}{Stop watch class
}
621 \twocolitem{\helpref{wxMimeTypesManager
}{wxmimetypesmanager
}}{MIME-types manager class
}
622 \twocolitem{\helpref{wxSystemSettings
}{wxsystemsettings
}}{System settings class for obtaining various global parameters
}
623 \twocolitem{\helpref{wxSystemOptions
}{wxsystemoptions
}}{System options class for run-time configuration
}
624 \twocolitem{\helpref{wxAcceleratorTable
}{wxacceleratortable
}}{Accelerator table
}
625 \twocolitem{\helpref{wxAutomationObject
}{wxautomationobject
}}{OLE automation class
}
626 \twocolitem{\helpref{wxFontMapper
}{wxfontmapper
}}{Font mapping, finding suitable font for given encoding
}
627 \twocolitem{\helpref{wxEncodingConverter
}{wxencodingconverter
}}{Encoding conversions
}
628 \twocolitem{\helpref{wxCalendarDateAttr
}{wxcalendardateattr
}}{Used with
\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}
629 \twocolitem{\helpref{wxQuantize
}{wxquantize
}}{Class to perform quantization, or colour reduction
}
630 \twocolitem{\helpref{wxSingleInstanceChecker
}{wxsingleinstancechecker
}}{Check that only single program instance is running
}
projects / wxWidgets.git / blob