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.
8 {\large {\bf Managed windows
}}
10 There are several types of window that are directly controlled by the
11 window manager (such as MS Windows, or the Motif Window Manager).
12 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{wxMDIParentFrame
}{wxmdiparentframe
}}{MDI parent frame
}
18 \twocolitem{\helpref{wxMDIChildFrame
}{wxmdichildframe
}}{MDI child frame
}
19 \twocolitem{\helpref{wxMiniFrame
}{wxminiframe
}}{A frame with a small title bar
}
20 \twocolitem{\helpref{wxTabbedDialog
}{wxtabbeddialog
}}{Tabbed dialog
}
23 See also
{\bf Common dialogs
}.
25 {\large {\bf Miscellaneous windows
}}
27 The following are a variety of windows that are derived from wxWindow.
29 \begin{twocollist
}\itemsep=
0pt
30 \twocolitem{\helpref{wxGrid
}{wxgrid
}}{A grid (table) window
}
31 \twocolitem{\helpref{wxPanel
}{wxpanel
}}{A window whose colour changes according to current user settings
}
32 \twocolitem{\helpref{wxSashWindow
}{wxsashwindow
}}{Window with four optional sashes that can be dragged
}
33 \twocolitem{\helpref{wxSashLayoutWindow
}{wxsashlayoutwindow
}}{Window that can be involved in an IDE-like layout arrangement
}
34 \twocolitem{\helpref{wxScrolledWindow
}{wxscrolledwindow
}}{Window with automatically managed scrollbars
}
35 \twocolitem{\helpref{wxSplitterWindow
}{wxsplitterwindow
}}{Window which can be split vertically or horizontally
}
36 \twocolitem{\helpref{wxStatusBar
}{wxstatusbar
}}{Implements the status bar on a frame
}
37 \twocolitem{\helpref{wxToolBar
}{wxtoolbar
}}{Toolbar class
}
38 %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
39 \twocolitem{\helpref{wxNotebook
}{wxnotebook
}}{Notebook class
}
42 {\large {\bf Common dialogs
}}
44 \overview{Overview
}{commondialogsoverview
}
46 Common dialogs are ready-made dialog classes which are frequently used
49 \begin{twocollist
}\itemsep=
0pt
50 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Base class for common dialogs
}
51 \twocolitem{\helpref{wxColourDialog
}{wxcolourdialog
}}{Colour chooser dialog
}
52 \twocolitem{\helpref{wxDirDialog
}{wxdirdialog
}}{Directory selector dialog
}
53 \twocolitem{\helpref{wxFileDialog
}{wxfiledialog
}}{File selector dialog
}
54 \twocolitem{\helpref{wxMultipleChoiceDialog
}{wxmultiplechoicedialog
}}{Dialog to get one or more selections from a list
}
55 \twocolitem{\helpref{wxSingleChoiceDialog
}{wxsinglechoicedialog
}}{Dialog to get a single selection from a list and return the string
}
56 \twocolitem{\helpref{wxTextEntryDialog
}{wxtextentrydialog
}}{Dialog to get a single line of text from the user
}
57 \twocolitem{\helpref{wxFontDialog
}{wxfontdialog
}}{Font chooser dialog
}
58 \twocolitem{\helpref{wxPageSetupDialog
}{wxpagesetupdialog
}}{Standard page setup dialog
}
59 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
60 \twocolitem{\helpref{wxMessageDialog
}{wxmessagedialog
}}{Simple message box dialog
}
63 {\large {\bf Controls
}}
65 Typically, these are small windows which provide interaction with the user. Controls
66 that are not static can have
\helpref{validators
}{wxvalidator
} associated with them.
68 \begin{twocollist
}\itemsep=
0pt
69 \twocolitem{\helpref{wxControl
}{wxcontrol
}}{The base class for controls
}
70 \twocolitem{\helpref{wxButton
}{wxbutton
}}{Push button control, displaying text
}
71 \twocolitem{\helpref{wxBitmapButton
}{wxbitmapbutton
}}{Push button control, displaying a bitmap
}
72 \twocolitem{\helpref{wxCheckBox
}{wxcheckbox
}}{Checkbox control
}
73 \twocolitem{\helpref{wxCheckListBox
}{wxchecklistbox
}}{A listbox with a checkbox to the left of each item
}
74 \twocolitem{\helpref{wxChoice
}{wxchoice
}}{Choice control (a combobox without the editable area)
}
75 \twocolitem{\helpref{wxComboBox
}{wxcombobox
}}{A choice with an editable area
}
76 \twocolitem{\helpref{wxGauge
}{wxgauge
}}{A control to represent a varying quantity, such as time remaining
}
77 \twocolitem{\helpref{wxStaticBox
}{wxstaticbox
}}{A static, or group box for visually grouping related controls
}
78 \twocolitem{\helpref{wxListBox
}{wxlistbox
}}{A list of strings for single or multiple selection
}
79 \twocolitem{\helpref{wxListCtrl
}{wxlistctrl
}}{A control for displaying lists of strings and/or icons, plus a multicolumn
report view
}
80 \twocolitem{\helpref{wxTabCtrl
}{wxtabctrl
}}{Manages several tabs
}
81 \twocolitem{\helpref{wxTextCtrl
}{wxtextctrl
}}{Single or multline text editing control
}
82 \twocolitem{\helpref{wxTreeCtrl
}{wxtreectrl
}}{Tree (hierachy) control
}
83 \twocolitem{\helpref{wxScrollBar
}{wxscrollbar
}}{Scrollbar control
}
84 \twocolitem{\helpref{wxSpinButton
}{wxspinbutton
}}{A spin or `up-down' control
}
85 \twocolitem{\helpref{wxStaticText
}{wxstatictext
}}{One or more lines of non-editable text
}
86 \twocolitem{\helpref{wxStaticBitmap
}{wxstaticbitmap
}}{A control to display a bitmap
}
87 \twocolitem{\helpref{wxRadioBox
}{wxradiobox
}}{A group of radio buttons
}
88 \twocolitem{\helpref{wxRadioButton
}{wxradiobutton
}}{A round button to be used with others in a mutually exclusive way
}
89 \twocolitem{\helpref{wxSlider
}{wxslider
}}{A slider that can be dragged by the user
}
94 \begin{twocollist
}\itemsep=
0pt
95 \twocolitem{\helpref{wxMenu
}{wxmenu
}}{Displays a series of menu items for selection
}
96 \twocolitem{\helpref{wxMenuBar
}{wxmenubar
}}{Contains a series of menus for use with a frame
}
97 \twocolitem{\helpref{wxMenuItem
}{wxmenuitem
}}{Represents a single menu item
}
100 {\large {\bf Window layout
}}
102 \overview{Overview
}{constraintsoverview
}
104 These are the classes relevant to automated window layout.
106 \begin{twocollist
}\itemsep=
0pt
107 \twocolitem{\helpref{wxIndividualLayoutConstraint
}{wxindividuallayoutconstraint
}}{Represents a single constraint dimension
}
108 \twocolitem{\helpref{wxLayoutConstraints
}{wxlayoutconstraints
}}{Represents the constraints for a window class
}
111 {\large {\bf Device contexts
}}
113 \overview{Overview
}{dcoverview
}
115 Device contexts are surfaces that may be drawn on, and provide an
116 abstraction that allows parameterisation of your drawing code
117 by passing different device contexts.
119 \begin{twocollist
}\itemsep=
0pt
120 \twocolitem{\helpref{wxClientDC
}{wxclientdc
}}{A device context to access the client area outside
{\bf OnPaint
} events
}
121 \twocolitem{\helpref{wxPaintDC
}{wxpaintdc
}}{A device context to access the client area inside
{\bf OnPaint
} events
}
122 \twocolitem{\helpref{wxWindowDC
}{wxwindowdc
}}{A device context to access the non-client area
}
123 \twocolitem{\helpref{wxScreenDC
}{wxscreendc
}}{A device context to access the entire screen
}
124 \twocolitem{\helpref{wxDC
}{wxdc
}}{The device context base class
}
125 \twocolitem{\helpref{wxMemoryDC
}{wxmemorydc
}}{A device context for drawing into bitmaps
}
126 \twocolitem{\helpref{wxMetaFileDC
}{wxmetafiledc
}}{A device context for drawing into metafiles
}
127 \twocolitem{\helpref{wxPostScriptDC
}{wxpostscriptdc
}}{A device context for drawing into PostScript files
}
128 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{A device context for drawing to printers
}
131 {\large {\bf Graphics device interface
}}
133 \overview{Bitmaps overview
}{wxbitmapoverview
}
135 These classes are related to drawing on device contexts and windows.
137 \begin{twocollist
}\itemsep=
0pt
138 \twocolitem{\helpref{wxColour
}{wxcolour
}}{Represents the red, blue and green elements of a colour
}
139 \twocolitem{\helpref{wxBitmap
}{wxbitmap
}}{Represents a bitmap
}
140 \twocolitem{\helpref{wxBrush
}{wxbrush
}}{Used for filling areas on a device context
}
141 \twocolitem{\helpref{wxBrushList
}{wxbrushlist
}}{The list of previously-created brushes
}
142 \twocolitem{\helpref{wxCursor
}{wxcursor
}}{A small, transparent bitmap representing the cursor
}
143 \twocolitem{\helpref{wxFont
}{wxfont
}}{Represents fonts
}
144 \twocolitem{\helpref{wxFontList
}{wxfontlist
}}{The list of previously-created fonts
}
145 \twocolitem{\helpref{wxIcon
}{wxicon
}}{A small, transparent bitmap for assigning to frames and drawing on device contexts
}
146 \twocolitem{\helpref{wxImageList
}{wximagelist
}}{A list of images, used with some controls
}
147 \twocolitem{\helpref{wxMask
}{wxmask
}}{Represents a mask to be used with a bitmap for transparent drawing
}
148 \twocolitem{\helpref{wxPen
}{wxpen
}}{Used for drawing lines on a device context
}
149 \twocolitem{\helpref{wxPenList
}{wxpenlist
}}{The list of previously-created pens
}
150 \twocolitem{\helpref{wxPalette
}{wxpalette
}}{Represents a table of indices into RGB values
}
151 \twocolitem{\helpref{wxRegion
}{wxregion
}}{Represents a simple or complex region on a window or device context
}
154 {\large {\bf Events
}}
156 \overview{Overview
}{eventhandlingoverview
}
158 An event object contains information about a specific event. Event handlers
159 (usually member functions) have a single, event argument.
161 \begin{twocollist
}\itemsep=
0pt
162 \twocolitem{\helpref{wxActivateEvent
}{wxactivateevent
}}{A window or application activation event
}
163 \twocolitem{\helpref{wxCalculateLayoutEvent
}{wxcalculatelayoutevent
}}{Used to calculate window layout
}
164 \twocolitem{\helpref{wxCloseEvent
}{wxcloseevent
}}{A close window or end session event
}
165 \twocolitem{\helpref{wxCommandEvent
}{wxcommandevent
}}{An event from a variety of standard controls
}
166 \twocolitem{\helpref{wxDropFilesEvent
}{wxdropfilesevent
}}{A drop files event
}
167 \twocolitem{\helpref{wxEraseEvent
}{wxeraseevent
}}{An erase background event
}
168 \twocolitem{\helpref{wxEvent
}{wxevent
}}{The event base class
}
169 \twocolitem{\helpref{wxFocusEvent
}{wxfocusevent
}}{A window focus event
}
170 \twocolitem{\helpref{wxKeyEvent
}{wxkeyevent
}}{A keypress event
}
171 \twocolitem{\helpref{wxIdleEvent
}{wxidleevent
}}{An idle event
}
172 \twocolitem{\helpref{wxInitDialogEvent
}{wxinitdialogevent
}}{A dialog initialisation event
}
173 \twocolitem{\helpref{wxJoystickEvent
}{wxjoystickevent
}}{A joystick event
}
174 \twocolitem{\helpref{wxListEvent
}{wxlistevent
}}{A list control event
}
175 \twocolitem{\helpref{wxMenuEvent
}{wxmenuevent
}}{A menu event
}
176 \twocolitem{\helpref{wxMouseEvent
}{wxmouseevent
}}{A mouse event
}
177 \twocolitem{\helpref{wxMoveEvent
}{wxmoveevent
}}{A move event
}
178 \twocolitem{\helpref{wxNotebookEvent
}{wxnotebookevent
}}{A notebook control event
}
179 \twocolitem{\helpref{wxPaintEvent
}{wxpaintevent
}}{A paint event
}
180 \twocolitem{\helpref{wxProcessEvent
}{wxprocessevent
}}{A process ending event
}
181 \twocolitem{\helpref{wxQueryLayoutInfoEvent
}{wxquerylayoutinfoevent
}}{Used to query layout information
}
182 \twocolitem{\helpref{wxSizeEvent
}{wxsizeevent
}}{A size event
}
183 \twocolitem{\helpref{wxSocketEvent
}{wxsocketevent
}}{A socket event
}
184 \twocolitem{\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}}{A system colour change event
}
185 \twocolitem{\helpref{wxTabEvent
}{wxtabevent
}}{A tab control event
}
186 \twocolitem{\helpref{wxTreeEvent
}{wxtreeevent
}}{A tree control event
}
187 \twocolitem{\helpref{wxUpdateUIEvent
}{wxupdateuievent
}}{A user interface update event
}
190 {\large {\bf Validators
}}
192 \overview{Overview
}{validatoroverview
}
194 These are the window validators, used for filtering and validating
197 \begin{twocollist
}\itemsep=
0pt
198 \twocolitem{\helpref{wxValidator
}{wxvalidator
}}{Base validator class.
}
199 \twocolitem{\helpref{wxTextValidator
}{wxtextvalidator
}}{Text control validator class.
}
202 {\large {\bf Data structures
}}
204 These are the data structure classes supported by wxWindows.
206 \begin{twocollist
}\itemsep=
0pt
207 \twocolitem{\helpref{wxExpr
}{wxexpr
}}{A class for flexible I/O
}
208 \twocolitem{\helpref{wxExprDatabase
}{wxexprdatabase
}}{A class for flexible I/O
}
209 \twocolitem{\helpref{wxDate
}{wxdate
}}{A class for date manipulation
}
210 \twocolitem{\helpref{wxHashTable
}{wxhashtable
}}{A simple hash table implementation
}
211 \twocolitem{\helpref{wxList
}{wxlist
}}{A simple linked list implementation
}
212 \twocolitem{\helpref{wxNode
}{wxnode
}}{Represents a node in the wxList implementation
}
213 \twocolitem{\helpref{wxObject
}{wxobject
}}{The root class for most wxWindows classes
}
214 \twocolitem{\helpref{wxPathList
}{wxpathlist
}}{A class to help search multiple paths
}
215 \twocolitem{\helpref{wxPoint
}{wxpoint
}}{Representation of a point
}
216 \twocolitem{\helpref{wxRect
}{wxrect
}}{A class representing a rectangle
}
217 \twocolitem{\helpref{wxRegion
}{wxregion
}}{A class representing a region
}
218 \twocolitem{\helpref{wxString
}{wxstring
}}{A string class
}
219 \twocolitem{\helpref{wxStringList
}{wxstringlist
}}{A class representing a list of strings
}
220 \twocolitem{\helpref{wxRealPoint
}{wxrealpoint
}}{Representation of a point using floating point numbers
}
221 \twocolitem{\helpref{wxSize
}{wxsize
}}{Representation of a size
}
222 \twocolitem{\helpref{wxTime
}{wxtime
}}{A class for time manipulation
}
223 \twocolitem{\helpref{wxVariant
}{wxvariant
}}{A class for storing arbitrary types
224 that may change at run-time.
}
227 {\large {\bf Run-time class information system
}}
229 \overview{Overview
}{runtimeclassoverview
}
231 wxWindows supports run-time manipulation of class information, and dynamic
232 creation of objects given class names.
234 \begin{twocollist
}\itemsep=
0pt
235 \twocolitem{\helpref{wxClassInfo
}{wxclassinfo
}}{Holds run-time class information
}
236 \twocolitem{\helpref{wxObject
}{wxobject
}}{Root class for classes with run-time information
}
237 \twocolitem{\helpref{Macros
}{macros
}}{Macros for manipulating run-time information
}
240 {\large {\bf Debugging features
}}
242 \overview{Overview
}{debuggingoverview
}
244 wxWindows supports some aspects of debugging an application through
245 classes, functions and macros.
247 \begin{twocollist
}\itemsep=
0pt
248 \twocolitem{\helpref{wxDebugContext
}{wxdebugcontext
}}{Provides memory-checking facilities
}
249 %\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream}
250 \twocolitem{\helpref{wxLog
}{wxlog
}}{Logging facility
}
251 \twocolitem{\helpref{Log functions
}{logfunctions
}}{Error and warning logging functions
}
252 \twocolitem{\helpref{Debugging macros
}{debugmacros
}}{Debug macros for assertion and checking
}
253 %\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility}
254 %\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels}
255 \twocolitem{\helpref{WXDEBUG
\_NEW}{debugnew
}}{Use this macro to give further debugging information
}
256 %\twocolitem{\helpref{WXTRACE}{trace}}{Trace macro}
257 %\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels}
260 {\large {\bf Interprocess communication
}}
262 \overview{Overview
}{ipcoverview
}
264 wxWindows provides a simple interprocess communications facilities
267 \begin{twocollist
}\itemsep=
0pt
268 \twocolitem{\helpref{wxDDEClient
}{wxddeclient
}}{Represents a client
}
269 \twocolitem{\helpref{wxDDEConnection
}{wxddeconnection
}}{Represents the connection between a client and a server
}
270 \twocolitem{\helpref{wxDDEServer
}{wxddeserver
}}{Represents a server
}
271 \twocolitem{\helpref{wxSocketClient
}{wxsocketclient
}}{Represents a socket client
}
272 \twocolitem{\helpref{wxSocketHandler
}{wxsockethandler
}}{Represents a socket handler
}
273 \twocolitem{\helpref{wxSocketServer
}{wxsocketserver
}}{Represents a socket server
}
276 {\large {\bf Document/view framework
}}
278 \overview{Overview
}{docviewoverview
}
280 wxWindows supports a
document/view framework which provides
281 housekeeping for a
document-centric application.
283 \begin{twocollist
}\itemsep=
0pt
284 \twocolitem{\helpref{wxDocument
}{wxdocument
}}{Represents a
document}
285 \twocolitem{\helpref{wxView
}{wxview
}}{Represents a view
}
286 \twocolitem{\helpref{wxDocTemplate
}{wxdoctemplate
}}{Manages the relationship between a
document class and a veiw class
}
287 \twocolitem{\helpref{wxDocManager
}{wxdocmanager
}}{Manages the documents and views in an application
}
288 \twocolitem{\helpref{wxDocChildFrame
}{wxdocchildframe
}}{A child frame for showing a
document view
}
289 \twocolitem{\helpref{wxDocParentFrame
}{wxdocparentframe
}}{A parent frame to contain views
}
290 %\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
291 %\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
294 {\large {\bf Printing framework
}}
296 \overview{Overview
}{printingoverview
}
298 A printing and previewing framework is implemented to
299 make it relatively straighforward to provide
document printing
302 \begin{twocollist
}\itemsep=
0pt
303 \twocolitem{\helpref{wxPreviewFrame
}{wxpreviewframe
}}{Frame for displaying a print preview
}
304 \twocolitem{\helpref{wxPreviewCanvas
}{wxpreviewcanvas
}}{Canvas for displaying a print preview
}
305 \twocolitem{\helpref{wxPreviewControlBar
}{wxpreviewcontrolbar
}}{Standard control bar for a print preview
}
306 \twocolitem{\helpref{wxPrintData
}{wxprintdata
}}{Represents information about the
document being printed
}
307 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
308 \twocolitem{\helpref{wxPrinter
}{wxprinter
}}{Class representing the printer
}
309 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{Printer device context
}
310 \twocolitem{\helpref{wxPrintout
}{wxprintout
}}{Class representing a particular printout
}
311 \twocolitem{\helpref{wxPrintPreview
}{wxprintpreview
}}{Class representing a print preview
}
314 {\large {\bf Database classes
}}
316 \overview{Database classes overview
}{odbcoverview
}
318 wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
321 \begin{twocollist
}\itemsep=
0pt
322 \twocolitem{\helpref{wxDatabase
}{wxdatabase
}}{Database class
}
323 \twocolitem{\helpref{wxQueryCol
}{wxquerycol
}}{Class representing a column
}
324 \twocolitem{\helpref{wxQueryField
}{wxqueryfield
}}{Class representing a field
}
325 \twocolitem{\helpref{wxRecordSet
}{wxrecordset
}}{Class representing one or more record
}
328 {\large {\bf Miscellaneous
}}
330 \begin{twocollist
}\itemsep=
0pt
331 \twocolitem{\helpref{wxAcceleratorTable
}{wxacceleratortable
}}{Accelerator table
}
332 \twocolitem{\helpref{wxApp
}{wxapp
}}{Application class
}
333 \twocolitem{\helpref{wxConfig
}{wxconfigbase
}}{Classes for configuration reading/writing
}
334 \twocolitem{\helpref{wxHelpController
}{wxhelpcontroller
}}{Family of classes for controlling help windows
}
335 \twocolitem{\helpref{wxLayoutAlgorithm
}{wxlayoutalgorithm
}}{An alternative window layout facility
}
336 \twocolitem{\helpref{wxProcess
}{wxprocess
}}{Process class
}
337 \twocolitem{\helpref{wxTimer
}{wxtimer
}}{Timer class
}
338 \twocolitem{\helpref{wxSystemSettings
}{wxsystemsettings
}}{System settings class
}
projects / wxWidgets.git / blob