1 \chapter{Classes by category
}\label{classesbycat
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}%
5 A classification of wxWindows 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 may contain windows, and dialog boxes may directly contain controls.
14 \begin{twocollist
}\itemsep=
0pt
15 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Dialog box
}
16 \twocolitem{\helpref{wxFrame
}{wxframe
}}{Normal frame
}
17 \twocolitem{\helpref{wxMDIChildFrame
}{wxmdichildframe
}}{MDI child frame
}
18 \twocolitem{\helpref{wxMDIParentFrame
}{wxmdiparentframe
}}{MDI parent frame
}
19 \twocolitem{\helpref{wxMiniFrame
}{wxminiframe
}}{A frame with a small title bar
}
20 \twocolitem{\helpref{wxSplashScreen
}{wxsplashscreen
}}{Splash screen class
}
21 %\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog
22 %(deprecated, use wxNotebook instead)}
23 \twocolitem{\helpref{wxTipWindow
}{wxtipwindow
}}{Shows text in a small window
}
24 \twocolitem{\helpref{wxWizard
}{wxwizard
}}{A wizard dialog
}
27 See also
{\bf Common dialogs
}.
29 {\large {\bf Miscellaneous windows
}}
31 The following are a variety of classes that are derived from wxWindow.
34 \begin{twocollist
}\itemsep=
0pt
35 \twocolitem{\helpref{wxPanel
}{wxpanel
}}{A window whose colour changes according to current user settings
}
36 \twocolitem{\helpref{wxScrolledWindow
}{wxscrolledwindow
}}{Window with automatically managed scrollbars
}
37 \twocolitem{\helpref{wxGrid
}{wxgrid
}}{A grid (table) window
}
38 \twocolitem{\helpref{wxSplitterWindow
}{wxsplitterwindow
}}{Window which can be split vertically or horizontally
}
39 \twocolitem{\helpref{wxStatusBar
}{wxstatusbar
}}{Implements the status bar on a frame
}
40 \twocolitem{\helpref{wxToolBar
}{wxtoolbar
}}{Toolbar class
}
41 %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
42 \twocolitem{\helpref{wxNotebook
}{wxnotebook
}}{Notebook class
}
43 \twocolitem{\helpref{wxPlotWindow
}{wxplotwindow
}}{A class to display data.
}
44 \twocolitem{\helpref{wxSashWindow
}{wxsashwindow
}}{Window with four optional sashes that can be dragged
}
45 \twocolitem{\helpref{wxSashLayoutWindow
}{wxsashlayoutwindow
}}{Window that can be involved in an IDE-like layout arrangement
}
46 \twocolitem{\helpref{wxWizardPage
}{wxwizardpage
}}{A base class for the page in wizard dialog.
}
47 \twocolitem{\helpref{wxWizardPageSimple
}{wxwizardpagesimple
}}{A page in wizard dialog.
}
50 {\large {\bf Common dialogs
}}
52 \overview{Overview
}{commondialogsoverview
}
54 Common dialogs are ready-made dialog classes which are frequently used
58 \begin{twocollist
}\itemsep=
0pt
59 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Base class for common dialogs
}
60 \twocolitem{\helpref{wxColourDialog
}{wxcolourdialog
}}{Colour chooser dialog
}
61 \twocolitem{\helpref{wxDirDialog
}{wxdirdialog
}}{Directory selector dialog
}
62 \twocolitem{\helpref{wxFileDialog
}{wxfiledialog
}}{File selector dialog
}
63 \twocolitem{\helpref{wxFindReplaceDialog
}{wxfindreplacedialog
}}{Text search/replace dialog
}
64 \twocolitem{\helpref{wxMultipleChoiceDialog
}{wxmultiplechoicedialog
}}{Dialog to get one or more selections from a list
}
65 \twocolitem{\helpref{wxSingleChoiceDialog
}{wxsinglechoicedialog
}}{Dialog to get a single selection from a list and return the string
}
66 \twocolitem{\helpref{wxTextEntryDialog
}{wxtextentrydialog
}}{Dialog to get a single line of text from the user
}
67 \twocolitem{\helpref{wxFontDialog
}{wxfontdialog
}}{Font chooser dialog
}
68 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
69 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
70 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
71 \twocolitem{\helpref{wxMessageDialog
}{wxmessagedialog
}}{Simple message box dialog
}
72 \twocolitem{\helpref{wxWizard
}{wxwizard
}}{A wizard dialog.
}
75 {\large {\bf Controls
}}
77 Typically, these are small windows which provide interaction with the user. Controls
78 that are not static can have
\helpref{validators
}{wxvalidator
} associated with them.
81 \begin{twocollist
}\itemsep=
0pt
82 \twocolitem{\helpref{wxControl
}{wxcontrol
}}{The base class for controls
}
83 \twocolitem{\helpref{wxButton
}{wxbutton
}}{Push button control, displaying text
}
84 \twocolitem{\helpref{wxBitmapButton
}{wxbitmapbutton
}}{Push button control, displaying a bitmap
}
85 \twocolitem{\helpref{wxToggleButton
}{wxtogglebutton
}}{A button which stays pressed when clicked by user.
}
86 \twocolitem{\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}{Date picker control
}
87 \twocolitem{\helpref{wxCheckBox
}{wxcheckbox
}}{Checkbox control
}
88 \twocolitem{\helpref{wxCheckListBox
}{wxchecklistbox
}}{A listbox with a checkbox to the left of each item
}
89 \twocolitem{\helpref{wxChoice
}{wxchoice
}}{Choice control (a combobox without the editable area)
}
90 \twocolitem{\helpref{wxComboBox
}{wxcombobox
}}{A choice with an editable area
}
91 \twocolitem{\helpref{wxGauge
}{wxgauge
}}{A control to represent a varying quantity, such as time remaining
}
92 \twocolitem{\helpref{wxGenericDirCtrl
}{wxgenericdirctrl
}}{A control for displaying a directory tree
}
93 \twocolitem{\helpref{wxStaticBox
}{wxstaticbox
}}{A static, or group box for visually grouping related controls
}
94 \twocolitem{\helpref{wxListBox
}{wxlistbox
}}{A list of strings for single or multiple selection
}
95 \twocolitem{\helpref{wxListCtrl
}{wxlistctrl
}}{A control for displaying lists of strings and/or icons, plus a multicolumn
report view
}
96 \twocolitem{\helpref{wxListView
}{wxlistview
}}{A simpler interface (
{\it fa
\c{c
}ade
} for wxListCtrl in
report mode
}
97 \twocolitem{\helpref{wxTabCtrl
}{wxtabctrl
}}{Manages several tabs
}
98 \twocolitem{\helpref{wxTextCtrl
}{wxtextctrl
}}{Single or multiline text editing control
}
99 \twocolitem{\helpref{wxTreeCtrl
}{wxtreectrl
}}{Tree (hierarchy) control
}
100 \twocolitem{\helpref{wxScrollBar
}{wxscrollbar
}}{Scrollbar control
}
101 \twocolitem{\helpref{wxSpinButton
}{wxspinbutton
}}{A spin or `up-down' control
}
102 \twocolitem{\helpref{wxSpinCtrl
}{wxspinctrl
}}{A spin control - i.e. spin button and text control
}
103 \twocolitem{\helpref{wxStaticText
}{wxstatictext
}}{One or more lines of non-editable text
}
104 \twocolitem{\helpref{wxStaticBitmap
}{wxstaticbitmap
}}{A control to display a bitmap
}
105 \twocolitem{\helpref{wxRadioBox
}{wxradiobox
}}{A group of radio buttons
}
106 \twocolitem{\helpref{wxRadioButton
}{wxradiobutton
}}{A round button to be used with others in a mutually exclusive way
}
107 \twocolitem{\helpref{wxSlider
}{wxslider
}}{A slider that can be dragged by the user
}
113 \begin{twocollist
}\itemsep=
0pt
114 \twocolitem{\helpref{wxMenu
}{wxmenu
}}{Displays a series of menu items for selection
}
115 \twocolitem{\helpref{wxMenuBar
}{wxmenubar
}}{Contains a series of menus for use with a frame
}
116 \twocolitem{\helpref{wxMenuItem
}{wxmenuitem
}}{Represents a single menu item
}
119 {\large {\bf Window layout
}}
121 There are two different systems for laying out windows (and dialogs in particular).
122 One is based upon so-called sizers and it requires less typing, thinking and calculating
123 and will in almost all cases produce dialogs looking equally well on all platforms, the
124 other is based on so-called constraints and is deprecated, though still available.
126 \overview{Sizer overview
}{sizeroverview
} describes sizer-based layout.
128 These are the classes relevant to sizer-based layout.
131 \begin{twocollist
}\itemsep=
0pt
132 \twocolitem{\helpref{wxSizer
}{wxsizer
}}{Abstract base class
}
133 \twocolitem{\helpref{wxGridSizer
}{wxgridsizer
}}{A sizer for laying out windows in a grid with all fields having the same size
}
134 \twocolitem{\helpref{wxFlexGridSizer
}{wxflexgridsizer
}}{A sizer for laying out windows in a flexible grid
}
135 \twocolitem{\helpref{wxBoxSizer
}{wxboxsizer
}}{A sizer for laying out windows in a row or column
}
136 \twocolitem{\helpref{wxStaticBoxSizer
}{wxstaticboxsizer
}}{Same as wxBoxSizer, but with a surrounding static box
}
137 \twocolitem{\helpref{wxNotebookSizer
}{wxnotebooksizer
}}{Sizer to use with the wxNotebook control
}
140 \overview{Constraints overview
}{constraintsoverview
} describes constraints-based layout.
142 These are the classes relevant to constraints-based window layout.
145 \begin{twocollist
}\itemsep=
0pt
146 \twocolitem{\helpref{wxIndividualLayoutConstraint
}{wxindividuallayoutconstraint
}}{Represents a single constraint dimension
}
147 \twocolitem{\helpref{wxLayoutConstraints
}{wxlayoutconstraints
}}{Represents the constraints for a window class
}
150 {\large {\bf Device contexts
}}
152 \overview{Overview
}{dcoverview
}
154 Device contexts are surfaces that may be drawn on, and provide an
155 abstraction that allows parameterisation of your drawing code
156 by passing different device contexts.
159 \begin{twocollist
}\itemsep=
0pt
160 \twocolitem{\helpref{wxClientDC
}{wxclientdc
}}{A device context to access the client area outside
{\bf OnPaint
} events
}
161 \twocolitem{\helpref{wxPaintDC
}{wxpaintdc
}}{A device context to access the client area inside
{\bf OnPaint
} events
}
162 \twocolitem{\helpref{wxWindowDC
}{wxwindowdc
}}{A device context to access the non-client area
}
163 \twocolitem{\helpref{wxScreenDC
}{wxscreendc
}}{A device context to access the entire screen
}
164 \twocolitem{\helpref{wxDC
}{wxdc
}}{The device context base class
}
165 \twocolitem{\helpref{wxMemoryDC
}{wxmemorydc
}}{A device context for drawing into bitmaps
}
166 \twocolitem{\helpref{wxMetafileDC
}{wxmetafiledc
}}{A device context for drawing into metafiles
}
167 \twocolitem{\helpref{wxPostScriptDC
}{wxpostscriptdc
}}{A device context for drawing into PostScript files
}
168 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{A device context for drawing to printers
}
171 {\large {\bf Graphics device interface
}}
173 \overview{Bitmaps overview
}{wxbitmapoverview
}
175 These classes are related to drawing on device contexts and windows.
178 \begin{twocollist
}\itemsep=
0pt
179 \twocolitem{\helpref{wxColour
}{wxcolour
}}{Represents the red, blue and green elements of a colour
}
180 \twocolitem{\helpref{wxDCClipper
}{wxdcclipper
}}{Wraps the operations of setting and destroying the clipping region
}
181 \twocolitem{\helpref{wxBitmap
}{wxbitmap
}}{Represents a bitmap
}
182 \twocolitem{\helpref{wxBrush
}{wxbrush
}}{Used for filling areas on a device context
}
183 \twocolitem{\helpref{wxBrushList
}{wxbrushlist
}}{The list of previously-created brushes
}
184 \twocolitem{\helpref{wxCursor
}{wxcursor
}}{A small, transparent bitmap representing the cursor
}
185 \twocolitem{\helpref{wxFont
}{wxfont
}}{Represents fonts
}
186 \twocolitem{\helpref{wxFontList
}{wxfontlist
}}{The list of previously-created fonts
}
187 \twocolitem{\helpref{wxIcon
}{wxicon
}}{A small, transparent bitmap for assigning to frames and drawing on device contexts
}
188 \twocolitem{\helpref{wxImage
}{wximage
}}{A platform-independent image class
}
189 \twocolitem{\helpref{wxImageList
}{wximagelist
}}{A list of images, used with some controls
}
190 \twocolitem{\helpref{wxMask
}{wxmask
}}{Represents a mask to be used with a bitmap for transparent drawing
}
191 \twocolitem{\helpref{wxPen
}{wxpen
}}{Used for drawing lines on a device context
}
192 \twocolitem{\helpref{wxPenList
}{wxpenlist
}}{The list of previously-created pens
}
193 \twocolitem{\helpref{wxPalette
}{wxpalette
}}{Represents a table of indices into RGB values
}
194 \twocolitem{\helpref{wxRegion
}{wxregion
}}{Represents a simple or complex region on a window or device context
}
197 {\large {\bf Events
}}
199 \overview{Overview
}{eventhandlingoverview
}
201 An event object contains information about a specific event. Event handlers
202 (usually member functions) have a single, event argument.
205 \begin{twocollist
}\itemsep=
0pt
206 \twocolitem{\helpref{wxActivateEvent
}{wxactivateevent
}}{A window or application activation event
}
207 \twocolitem{\helpref{wxCalendarEvent
}{wxcalendarevent
}}{Used with
\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}
208 \twocolitem{\helpref{wxCalculateLayoutEvent
}{wxcalculatelayoutevent
}}{Used to calculate window layout
}
209 \twocolitem{\helpref{wxCloseEvent
}{wxcloseevent
}}{A close window or end session event
}
210 \twocolitem{\helpref{wxCommandEvent
}{wxcommandevent
}}{An event from a variety of standard controls
}
211 \twocolitem{\helpref{wxDialUpEvent
}{wxdialupevent
}}{Event send by
\helpref{wxDialUpManager
}{wxdialupmanager
}}
212 \twocolitem{\helpref{wxDropFilesEvent
}{wxdropfilesevent
}}{A drop files event
}
213 \twocolitem{\helpref{wxEraseEvent
}{wxeraseevent
}}{An erase background event
}
214 \twocolitem{\helpref{wxEvent
}{wxevent
}}{The event base class
}
215 \twocolitem{\helpref{wxFindDialogEvent
}{wxfinddialogevent
}}{Event sent by
216 \helpref{wxFindReplaceDialog
}{wxfindreplacedialog
}}
217 \twocolitem{\helpref{wxFocusEvent
}{wxfocusevent
}}{A window focus event
}
218 \twocolitem{\helpref{wxKeyEvent
}{wxkeyevent
}}{A keypress event
}
219 \twocolitem{\helpref{wxIconizeEvent
}{wxiconizeevent
}}{An iconize/restore event
}
220 \twocolitem{\helpref{wxIdleEvent
}{wxidleevent
}}{An idle event
}
221 \twocolitem{\helpref{wxInitDialogEvent
}{wxinitdialogevent
}}{A dialog initialisation event
}
222 \twocolitem{\helpref{wxJoystickEvent
}{wxjoystickevent
}}{A joystick event
}
223 \twocolitem{\helpref{wxListEvent
}{wxlistevent
}}{A list control event
}
224 \twocolitem{\helpref{wxMaximizeEvent
}{wxmaximizeevent
}}{A maximize event
}
225 \twocolitem{\helpref{wxMenuEvent
}{wxmenuevent
}}{A menu event
}
226 \twocolitem{\helpref{wxMouseCaptureChangedEvent
}{wxmousecapturechangedevent
}}{A mouse capture changed event
}
227 \twocolitem{\helpref{wxMouseEvent
}{wxmouseevent
}}{A mouse event
}
228 \twocolitem{\helpref{wxMoveEvent
}{wxmoveevent
}}{A move event
}
229 \twocolitem{\helpref{wxNotebookEvent
}{wxnotebookevent
}}{A notebook control event
}
230 \twocolitem{\helpref{wxNotifyEvent
}{wxnotifyevent
}}{A notification event, which can be vetoed
}
231 \twocolitem{\helpref{wxPaintEvent
}{wxpaintevent
}}{A paint event
}
232 \twocolitem{\helpref{wxProcessEvent
}{wxprocessevent
}}{A process ending event
}
233 \twocolitem{\helpref{wxQueryLayoutInfoEvent
}{wxquerylayoutinfoevent
}}{Used to query layout information
}
234 \twocolitem{\helpref{wxScrollEvent
}{wxscrollevent
}}{A scroll event from sliders, stand-alone scrollbars and spin buttons
}
235 \twocolitem{\helpref{wxScrollWinEvent
}{wxscrollwinevent
}}{A scroll event from scrolled windows
}
236 \twocolitem{\helpref{wxSizeEvent
}{wxsizeevent
}}{A size event
}
237 \twocolitem{\helpref{wxSocketEvent
}{wxsocketevent
}}{A socket event
}
238 \twocolitem{\helpref{wxSpinEvent
}{wxspinevent
}}{An event from
\helpref{wxSpinButton
}{wxspinbutton
}}
239 \twocolitem{\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}}{A system colour change event
}
240 \twocolitem{\helpref{wxTabEvent
}{wxtabevent
}}{A tab control event
}
241 \twocolitem{\helpref{wxTreeEvent
}{wxtreeevent
}}{A tree control event
}
242 \twocolitem{\helpref{wxUpdateUIEvent
}{wxupdateuievent
}}{A user interface update event
}
243 \twocolitem{\helpref{wxWizardEvent
}{wxwizardevent
}}{A wizard event
}
246 {\large {\bf Validators
}}
248 \overview{Overview
}{validatoroverview
}
250 These are the window validators, used for filtering and validating
254 \begin{twocollist
}\itemsep=
0pt
255 \twocolitem{\helpref{wxValidator
}{wxvalidator
}}{Base validator class
}
256 \twocolitem{\helpref{wxTextValidator
}{wxtextvalidator
}}{Text control validator class
}
257 \twocolitem{\helpref{wxGenericValidator
}{wxgenericvalidator
}}{Generic control validator class
}
260 {\large {\bf Data structures
}}
262 These are the data structure classes supported by wxWindows.
265 \begin{twocollist
}\itemsep=
0pt
266 \twocolitem{\helpref{wxCmdLineParser
}{wxcmdlineparser
}}{Command line parser class
}
267 \twocolitem{\helpref{wxDate
}{wxdate
}}{A class for date manipulation (deprecated in favour of wxDateTime)
}
268 \twocolitem{\helpref{wxDateSpan
}{wxdatespan
}}{A logical time interval.
}
269 \twocolitem{\helpref{wxDateTime
}{wxdatetime
}}{A class for date/time manipulations
}
270 \twocolitem{\helpref{wxExpr
}{wxexpr
}}{A class for flexible I/O
}
271 \twocolitem{\helpref{wxExprDatabase
}{wxexprdatabase
}}{A class for flexible I/O
}
272 \twocolitem{\helpref{wxHashMap
}{wxhashmap
}}{A simple hash map implementation
}
273 \twocolitem{\helpref{wxHashTable
}{wxhashtable
}}{A simple hash table implementation (deprecated, use wxHashMap)
}
274 % \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data}
275 \twocolitem{\helpref{wxList
}{wxlist
}}{A simple linked list implementation
}
276 \twocolitem{\helpref{wxLongLong
}{wxlonglong
}}{A portable
64 bit integer type
}
277 \twocolitem{\helpref{wxNode
}{wxnode
}}{Represents a node in the wxList implementation
}
278 \twocolitem{\helpref{wxObject
}{wxobject
}}{The root class for most wxWindows classes
}
279 \twocolitem{\helpref{wxPathList
}{wxpathlist
}}{A class to help search multiple paths
}
280 \twocolitem{\helpref{wxPoint
}{wxpoint
}}{Representation of a point
}
281 \twocolitem{\helpref{wxRect
}{wxrect
}}{A class representing a rectangle
}
282 \twocolitem{\helpref{wxRegEx
}{wxregex
}}{Regular expression support
}
283 \twocolitem{\helpref{wxRegion
}{wxregion
}}{A class representing a region
}
284 \twocolitem{\helpref{wxString
}{wxstring
}}{A string class
}
285 \twocolitem{\helpref{wxStringList
}{wxstringlist
}}{A class representing a list of strings
}
286 \twocolitem{\helpref{wxStringTokenizer
}{wxstringtokenizer
}}{A class for interpreting a string as a list of tokens or words
}
287 \twocolitem{\helpref{wxRealPoint
}{wxrealpoint
}}{Representation of a point using floating point numbers
}
288 \twocolitem{\helpref{wxSize
}{wxsize
}}{Representation of a size
}
289 \twocolitem{\helpref{wxTime
}{wxtime
}}{A class for time manipulation (deprecated in favour of wxDateTime)
}
290 \twocolitem{\helpref{wxTimeSpan
}{wxtimespan
}}{A time interval.
}
291 \twocolitem{\helpref{wxVariant
}{wxvariant
}}{A class for storing arbitrary types that may change at run-time
}
294 {\large {\bf Run-time class information system
}}
296 \overview{Overview
}{runtimeclassoverview
}
298 wxWindows supports run-time manipulation of class information, and dynamic
299 creation of objects given class names.
302 \begin{twocollist
}\itemsep=
0pt
303 \twocolitem{\helpref{wxClassInfo
}{wxclassinfo
}}{Holds run-time class information
}
304 \twocolitem{\helpref{wxObject
}{wxobject
}}{Root class for classes with run-time information
}
305 \twocolitem{\helpref{RTTI macros
}{rttimacros
}}{Macros for manipulating run-time information
}
308 {\large {\bf Logging features
}}
310 \overview{Overview
}{wxlogoverview
}
312 wxWindows provides several classes and functions for the message logging.
313 Please see the
\helpref{wxLog overview
}{wxlogoverview
} for more details.
316 \begin{twocollist
}\itemsep=
0pt
317 \twocolitem{\helpref{wxLog
}{wxlog
}}{The base log class
}
318 \twocolitem{\helpref{wxLogStderr
}{wxlogstderr
}}{Log messages to a C STDIO stream
}
319 \twocolitem{\helpref{wxLogStream
}{wxlogstream
}}{Log messages to a C++ iostream
}
320 \twocolitem{\helpref{wxLogTextCtrl
}{wxlogtextctrl
}}{Log messages to a
\helpref{wxTextCtrl
}{wxtextctrl
}}
321 \twocolitem{\helpref{wxLogWindow
}{wxlogwindow
}}{Log messages to a log frame
}
322 \twocolitem{\helpref{wxLogGui
}{wxloggui
}}{Default log target for GUI programs
}
323 \twocolitem{\helpref{wxLogNull
}{wxlognull
}}{Temporarily suppress message logging
}
324 \twocolitem{\helpref{wxLogChain
}{wxlogchain
}}{Allows to chain two log targets
}
325 \twocolitem{\helpref{wxLogPassThrough
}{wxlogpassthrough
}}{Allows to filter the log messages
}
326 \twocolitem{\helpref{wxStreamToTextRedirector
}{wxstreamtotextredirector
}}{Allows
327 to redirect output sent to
{\tt cout
} to a
\helpref{wxTextCtrl
}{wxtextctrl
}}
328 \twocolitem{\helpref{Log functions
}{logfunctions
}}{Error and warning logging functions
}
331 {\large {\bf Debugging features
}}
333 \overview{Overview
}{debuggingoverview
}
335 wxWindows supports some aspects of debugging an application through
336 classes, functions and macros.
339 \begin{twocollist
}\itemsep=
0pt
340 \twocolitem{\helpref{wxDebugContext
}{wxdebugcontext
}}{Provides memory-checking facilities
}
341 %\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream}
342 \twocolitem{\helpref{Debugging macros
}{debugmacros
}}{Debug macros for assertion and checking
}
343 \twocolitem{\helpref{WXDEBUG
\_NEW}{debugnew
}}{Use this macro to give further debugging information
}
344 %\twocolitem{\helpref{WXTRACE}{trace}}{Trace macro}
345 %\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels}
348 {\large {\bf Networking classes
}}
350 wxWindows provides its own classes for socket based networking.
353 \begin{twocollist
}\itemsep=
0pt
354 \twocolitem{\helpref{wxDialUpManager
}{wxdialupmanager
}}{Provides functions to check the status of network connection and to establish one
}
355 \twocolitem{\helpref{wxIPV4address
}{wxipv4address
}}{Represents an Internet address
}
356 \twocolitem{\helpref{wxSocketBase
}{wxsocketbase
}}{Represents a socket base object
}
357 \twocolitem{\helpref{wxSocketClient
}{wxsocketclient
}}{Represents a socket client
}
358 \twocolitem{\helpref{wxSocketServer
}{wxsocketserver
}}{Represents a socket server
}
359 \twocolitem{\helpref{wxSocketEvent
}{wxsocketevent
}}{A socket event
}
360 \twocolitem{\helpref{wxFTP
}{wxftp
}}{FTP protocol class
}
361 \twocolitem{\helpref{wxHTTP
}{wxhttp
}}{HTTP protocol class
}
362 \twocolitem{\helpref{wxURL
}{wxurl
}}{Represents a Universal Resource Locator
}
366 {\large {\bf Interprocess communication
}}
368 \overview{Overview
}{ipcoverview
}
370 wxWindows provides simple interprocess communications facilities
371 based on Windows DDE, but available on most platforms using TCP.
374 \begin{twocollist
}\itemsep=
0pt
375 \twocolitem{\helpref{wxClient
}{wxddeclient
}}{Represents a client
}
376 \twocolitem{\helpref{wxConnection
}{wxddeconnection
}}{Represents the connection between a client and a server
}
377 \twocolitem{\helpref{wxServer
}{wxddeserver
}}{Represents a server
}
378 %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
381 {\large {\bf Document/view framework
}}
383 \overview{Overview
}{docviewoverview
}
385 wxWindows supports a
document/view framework which provides
386 housekeeping for a
document-centric application.
389 \begin{twocollist
}\itemsep=
0pt
390 \twocolitem{\helpref{wxDocument
}{wxdocument
}}{Represents a
document}
391 \twocolitem{\helpref{wxView
}{wxview
}}{Represents a view
}
392 \twocolitem{\helpref{wxDocTemplate
}{wxdoctemplate
}}{Manages the relationship between a
document class and a view class
}
393 \twocolitem{\helpref{wxDocManager
}{wxdocmanager
}}{Manages the documents and views in an application
}
394 \twocolitem{\helpref{wxDocChildFrame
}{wxdocchildframe
}}{A child frame for showing a
document view
}
395 \twocolitem{\helpref{wxDocParentFrame
}{wxdocparentframe
}}{A parent frame to contain views
}
396 %\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
397 %\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
400 {\large {\bf Printing framework
}}
402 \overview{Overview
}{printingoverview
}
404 A printing and previewing framework is implemented to
405 make it relatively straightforward to provide
document printing
409 \begin{twocollist
}\itemsep=
0pt
410 \twocolitem{\helpref{wxPreviewFrame
}{wxpreviewframe
}}{Frame for displaying a print preview
}
411 \twocolitem{\helpref{wxPreviewCanvas
}{wxpreviewcanvas
}}{Canvas for displaying a print preview
}
412 \twocolitem{\helpref{wxPreviewControlBar
}{wxpreviewcontrolbar
}}{Standard control bar for a print preview
}
413 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
414 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
415 \twocolitem{\helpref{wxPrinter
}{wxprinter
}}{Class representing the printer
}
416 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{Printer device context
}
417 \twocolitem{\helpref{wxPrintout
}{wxprintout
}}{Class representing a particular printout
}
418 \twocolitem{\helpref{wxPrintPreview
}{wxprintpreview
}}{Class representing a print preview
}
419 \twocolitem{\helpref{wxPrintData
}{wxprintdata
}}{Represents information about the
document being printed
}
420 \twocolitem{\helpref{wxPrintDialogData
}{wxprintdialogdata
}}{Represents information about the print dialog
}
421 \twocolitem{\helpref{wxPageSetupDialogData
}{wxpagesetupdialogdata
}}{Represents information about the page setup dialog
}
424 {\large {\bf Drag and drop and clipboard classes
}}
426 \overview{Drag and drop and clipboard overview
}{wxdndoverview
}
429 \begin{twocollist
}\itemsep=
0pt
430 \twocolitem{\helpref{wxDataObject
}{wxdataobject
}}{Data object class
}
431 \twocolitem{\helpref{wxDataFormat
}{wxdataformat
}}{Represents a data format
}
432 \twocolitem{\helpref{wxTextDataObject
}{wxtextdataobject
}}{Text data object class
}
433 \twocolitem{\helpref{wxFileDataObject
}{wxtextdataobject
}}{File data object class
}
434 \twocolitem{\helpref{wxBitmapDataObject
}{wxbitmapdataobject
}}{Bitmap data object class
}
435 \twocolitem{\helpref{wxCustomDataObject
}{wxcustomdataobject
}}{Custom data object class
}
436 \twocolitem{\helpref{wxClipboard
}{wxclipboard
}}{Clipboard class
}
437 \twocolitem{\helpref{wxDropTarget
}{wxdroptarget
}}{Drop target class
}
438 \twocolitem{\helpref{wxFileDropTarget
}{wxfiledroptarget
}}{File drop target class
}
439 \twocolitem{\helpref{wxTextDropTarget
}{wxtextdroptarget
}}{Text drop target class
}
440 \twocolitem{\helpref{wxDropSource
}{wxdropsource
}}{Drop source class
}
443 {\large {\bf File related classes
}}
445 wxWindows has several small classes to work with disk files, see
\helpref{file classes
446 overview
}{wxfileoverview
} for more details.
449 \begin{twocollist
}\itemsep=
0pt
450 \twocolitem{\helpref{wxFileName
}{wxfilename
}}{Operations with the file name and attributes
}
451 \twocolitem{\helpref{wxDir
}{wxdir
}}{Class for enumerating files/subdirectories.
}
452 \twocolitem{\helpref{wxDirTraverser
}{wxdirtraverser
}}{Class used together with wxDir for recursively enumerating the files/subdirectories
}
453 \twocolitem{\helpref{wxFile
}{wxfile
}}{Low-level file input/output class.
}
454 \twocolitem{\helpref{wxFFile
}{wxffile
}}{Another low-level file input/output class.
}
455 \twocolitem{\helpref{wxTempFile
}{wxtempfile
}}{Class to safely replace an existing file
}
456 \twocolitem{\helpref{wxTextFile
}{wxtextfile
}}{Class for working with text files as with arrays of lines
}
459 {\large {\bf Stream classes
}}
461 wxWindows has its own set of stream classes, as an alternative to often buggy standard stream
462 libraries, and to provide enhanced functionality.
465 \begin{twocollist
}\itemsep=
0pt
466 \twocolitem{\helpref{wxStreamBase
}{wxstreambase
}}{Stream base class
}
467 \twocolitem{\helpref{wxStreamBuffer
}{wxstreambuffer
}}{Stream buffer class
}
468 \twocolitem{\helpref{wxInputStream
}{wxinputstream
}}{Input stream class
}
469 \twocolitem{\helpref{wxOutputStream
}{wxoutputstream
}}{Output stream class
}
470 \twocolitem{\helpref{wxCountingOutputStream
}{wxcountingoutputstream
}}{Stream class for querying what size a stream would have.
}
471 \twocolitem{\helpref{wxFilterInputStream
}{wxfilterinputstream
}}{Filtered input stream class
}
472 \twocolitem{\helpref{wxFilterOutputStream
}{wxfilteroutputstream
}}{Filtered output stream class
}
473 \twocolitem{\helpref{wxBufferedInputStream
}{wxbufferedinputstream
}}{Buffered input stream class
}
474 \twocolitem{\helpref{wxBufferedOutputStream
}{wxbufferedoutputstream
}}{Buffered output stream class
}
475 \twocolitem{\helpref{wxMemoryInputStream
}{wxmeminputstream
}}{Memory input stream class
}
476 \twocolitem{\helpref{wxMemoryOutputStream
}{wxmemoutputstream
}}{Memory output stream class
}
477 \twocolitem{\helpref{wxDataInputStream
}{wxdatainputstream
}}{Platform-independent binary data input stream class
}
478 \twocolitem{\helpref{wxDataOutputStream
}{wxdataoutputstream
}}{Platform-independent binary data output stream class
}
479 \twocolitem{\helpref{wxTextInputStream
}{wxtextinputstream
}}{Platform-independent text data input stream class
}
480 \twocolitem{\helpref{wxTextOutputStream
}{wxtextoutputstream
}}{Platform-independent text data output stream class
}
481 \twocolitem{\helpref{wxFileInputStream
}{wxfileinputstream
}}{File input stream class
}
482 \twocolitem{\helpref{wxFileOutputStream
}{wxfileoutputstream
}}{File output stream class
}
483 \twocolitem{\helpref{wxFFileInputStream
}{wxffileinputstream
}}{Another file input stream class
}
484 \twocolitem{\helpref{wxFFileOutputStream
}{wxffileoutputstream
}}{Another file output stream class
}
485 \twocolitem{\helpref{wxZlibInputStream
}{wxzlibinputstream
}}{Zlib (compression) input stream class
}
486 \twocolitem{\helpref{wxZlibOutputStream
}{wxzliboutputstream
}}{Zlib (compression) output stream class
}
487 \twocolitem{\helpref{wxZipInputStream
}{wxzipinputstream
}}{Input stream for reading from ZIP archives
}
488 \twocolitem{\helpref{wxSocketInputStream
}{wxsocketinputstream
}}{Socket input stream class
}
489 \twocolitem{\helpref{wxSocketOutputStream
}{wxsocketoutputstream
}}{Socket output stream class
}
492 {\large {\bf Threading classes
}}
494 \overview{Multithreading overview
}{wxthreadoverview
}
496 wxWindows provides a set of classes to make use of the native thread
497 capabilities of the various platforms.
500 \begin{twocollist
}\itemsep=
0pt
501 \twocolitem{\helpref{wxThread
}{wxthread
}}{Thread class
}
502 \twocolitem{\helpref{wxMutex
}{wxmutex
}}{Mutex class
}
503 \twocolitem{\helpref{wxMutexLocker
}{wxmutexlocker
}}{Mutex locker utility class
}
504 \twocolitem{\helpref{wxCriticalSection
}{wxcriticalsection
}}{Critical section class
}
505 \twocolitem{\helpref{wxCriticalSectionLocker
}{wxcriticalsectionlocker
}}{Critical section locker utility class
}
506 \twocolitem{\helpref{wxCondition
}{wxcondition
}}{Condition class
}
507 \twocolitem{\helpref{wxSemaphore
}{wxsemaphore
}}{Semaphore class
}
510 {\large {\bf HTML classes
}}
512 wxWindows provides a set of classes to display text in HTML format. These
513 class include a help system based on the HTML widget.
516 \begin{twocollist
}\itemsep=
0pt
517 \twocolitem{\helpref{wxHtmlHelpController
}{wxhtmlhelpcontroller
}}{HTML help controller class
}
518 \twocolitem{\helpref{wxHtmlWindow
}{wxhtmlwindow
}}{HTML window class
}
519 \twocolitem{\helpref{wxHtmlEasyPrinting
}{wxhtmleasyprinting
}}{Simple class for printing HTML
}
520 \twocolitem{\helpref{wxHtmlPrintout
}{wxhtmlprintout
}}{Generic HTML wxPrintout class
}
521 \twocolitem{\helpref{wxHtmlParser
}{wxhtmlparser
}}{Generic HTML parser class
}
522 \twocolitem{\helpref{wxHtmlTagHandler
}{wxhtmltaghandler
}}{HTML tag handler, pluginable into wxHtmlParser
}
523 \twocolitem{\helpref{wxHtmlWinParser
}{wxhtmlwinparser
}}{HTML parser class for wxHtmlWindow
}
524 \twocolitem{\helpref{wxHtmlWinTagHandler
}{wxhtmlwintaghandler
}}{HTML tag handler, pluginable into wxHtmlWinParser
}
527 {\large {\bf Virtual file system classes
}}
529 wxWindows provides a set of classes that implement an extensible virtual file system,
530 used internally by the HTML classes.
533 \begin{twocollist
}\itemsep=
0pt
534 \twocolitem{\helpref{wxFSFile
}{wxfsfile
}}{Represents a file in the virtual file system
}
535 \twocolitem{\helpref{wxFileSystem
}{wxfilesystem
}}{Main interface for the virtual file system
}
536 \twocolitem{\helpref{wxFileSystemHandler
}{wxfilesystemhandler
}}{Class used to announce file system type
}
539 {\large {\bf XML-based resource system classes
}}
541 \overview{XML-based resource system overview
}{xrcoverview
}
543 Resources allow your application to create controls and other user interface elements
544 from specifications stored in an XML format.
547 \begin{twocollist
}\itemsep=
0pt
548 \twocolitem{\helpref{wxXmlResource
}{wxxmlresource
}}{The main class for working with resources.
}
549 \twocolitem{\helpref{wxXmlResourceHandler
}{wxxmlresourcehandler
}}{The base class for XML resource handlers.
}
552 {\large {\bf Online help
}}
555 \begin{twocollist
}\itemsep=
0pt
556 \twocolitem{\helpref{wxHelpController
}{wxhelpcontroller
}}{Family of classes for controlling help windows
}
557 \twocolitem{\helpref{wxHtmlHelpController
}{wxhtmlhelpcontroller
}}{HTML help controller class
}
558 \twocolitem{\helpref{wxContextHelp
}{wxcontexthelp
}}{Class to put application into context-sensitive help mode
}
559 \twocolitem{\helpref{wxContextHelpButton
}{wxcontexthelpbutton
}}{Button class for putting application into context-sensitive help mode
}
560 \twocolitem{\helpref{wxHelpProvider
}{wxhelpprovider
}}{Abstract class for context-sensitive help provision
}
561 \twocolitem{\helpref{wxSimpleHelpProvider
}{wxsimplehelpprovider
}}{Class for simple context-sensitive help provision
}
562 \twocolitem{\helpref{wxHelpControllerHelpProvider
}{wxhelpcontrollerhelpprovider
}}{Class for context-sensitive help provision via a help controller
}
563 \twocolitem{\helpref{wxToolTip
}{wxtooltip
}}{Class implementing tooltips
}
566 {\large {\bf Database classes
}}
568 \overview{Database classes overview
}{odbcoverview
}
570 wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity)
571 product. The new version by Remstar, known as wxODBC, is more powerful,
572 portable, flexible and better supported, so please use the classes below for
573 working with databases:
576 \begin{twocollist
}\itemsep=
0pt
577 \twocolitem{\helpref{wxDb
}{wxdb
}}{ODBC database connection
}
578 \twocolitem{\helpref{wxDbTable
}{wxdbtable
}}{Provides access to a database table
}
579 \twocolitem{\helpref{wxDbInf
}{wxdbinf
}}{}
580 \twocolitem{\helpref{wxDbTableInf
}{wxdbtableinf
}}{}
581 \twocolitem{\helpref{wxDbColDef
}{wxdbcoldef
}}{}
582 \twocolitem{\helpref{wxDbColInf
}{wxdbcolinf
}}{}
583 \twocolitem{\helpref{wxDbColDataPtr
}{wxdbcoldataptr
}}{}
584 \twocolitem{\helpref{wxDbColFor
}{wxdbcolfor
}}{}
585 \twocolitem{\helpref{wxDbConnectInf
}{wxdbconnectinf
}}{}
586 \twocolitem{\helpref{wxDbIdxDef
}{wxdbidxdef
}}{}
589 The documentation for the older classes is still included, but you should avoid
590 using any of them in new programs:
593 \begin{twocollist
}\itemsep=
0pt
594 \twocolitem{\helpref{wxDatabase
}{wxdatabase
}}{Database class
}
595 \twocolitem{\helpref{wxQueryCol
}{wxquerycol
}}{Class representing a column
}
596 \twocolitem{\helpref{wxQueryField
}{wxqueryfield
}}{Class representing a field
}
597 \twocolitem{\helpref{wxRecordSet
}{wxrecordset
}}{Class representing one or more record
}
600 {\large {\bf Miscellaneous
}}
603 \begin{twocollist
}\itemsep=
0pt
604 \twocolitem{\helpref{wxApp
}{wxapp
}}{Application class
}
605 \twocolitem{\helpref{wxCaret
}{wxcaret
}}{A caret (cursor) object
}
606 \twocolitem{\helpref{wxCmdLineParser
}{wxcmdlineparser
}}{Command line parser class
}
607 \twocolitem{\helpref{wxConfig
}{wxconfigbase
}}{Classes for configuration reading/writing (using either INI files or registry)
}
608 \twocolitem{\helpref{wxDllLoader
}{wxdllloader
}}{Class to work with shared libraries.
}
609 \twocolitem{\helpref{wxLayoutAlgorithm
}{wxlayoutalgorithm
}}{An alternative window layout facility
}
610 \twocolitem{\helpref{wxProcess
}{wxprocess
}}{Process class
}
611 \twocolitem{\helpref{wxTimer
}{wxtimer
}}{Timer class
}
612 \twocolitem{\helpref{wxStopWatch
}{wxstopwatch
}}{Stop watch class
}
613 \twocolitem{\helpref{wxMimeTypesManager
}{wxmimetypesmanager
}}{MIME-types manager class
}
614 \twocolitem{\helpref{wxSystemSettings
}{wxsystemsettings
}}{System settings class for obtaining various global parameters
}
615 \twocolitem{\helpref{wxSystemOptions
}{wxsystemoptions
}}{System options class for run-time configuration
}
616 \twocolitem{\helpref{wxAcceleratorTable
}{wxacceleratortable
}}{Accelerator table
}
617 \twocolitem{\helpref{wxAutomationObject
}{wxautomationobject
}}{OLE automation class
}
618 \twocolitem{\helpref{wxFontMapper
}{wxfontmapper
}}{Font mapping, finding suitable font for given encoding
}
619 \twocolitem{\helpref{wxEncodingConverter
}{wxencodingconverter
}}{Encoding conversions
}
620 \twocolitem{\helpref{wxCalendarDateAttr
}{wxcalendardateattr
}}{Used with
\helpref{wxCalendarCtrl
}{wxcalendarctrl
}}
621 \twocolitem{\helpref{wxQuantize
}{wxquantize
}}{Class to perform quantization, or colour reduction
}
622 \twocolitem{\helpref{wxSingleInstanceChecker
}{wxsingleinstancechecker
}}{Check that only single program instance is running
}
projects / wxWidgets.git / blob