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{wxScrolledWindow
}{wxscrolledwindow
}}{Window with automatically managed scrollbars
}
33 \twocolitem{\helpref{wxSplitterWindow
}{wxsplitterwindow
}}{Window which can be split vertically or horizontally
}
34 \twocolitem{\helpref{wxStatusBar
}{wxstatusbar
}}{Implements the status bar on a frame
}
35 \twocolitem{\helpref{wxStatusBar95
}{wxstatusbar95
}}{Implements a Windows
95 status bar on a frame
}
36 \twocolitem{\helpref{wxTabbedPanel
}{wxtabbedpanel
}}{Tabbed panel
}
39 {\large {\bf Toolbar classes
}}
41 \overview{Overview
}{wxtoolbaroverview
}
43 These are the toolbar classes.
45 \begin{twocollist
}\itemsep=
0pt
46 \twocolitem{\helpref{wxToolBarBase
}{wxtoolbarbase
}}{Toolbar base class
}
47 \twocolitem{\helpref{wxToolBarSimple
}{wxtoolbarsimple
}}{A simple, cross-platform toolbar class
}
48 \twocolitem{\helpref{wxToolBarMSW
}{wxtoolbarmsw
}}{A Windows-only toolbar class
}
49 \twocolitem{\helpref{wxToolBar95
}{wxtoolbar95
}}{A Windows
95-only toolbar class
}
52 {\large {\bf Common dialogs
}}
54 \overview{Overview
}{commondialogsoverview
}
56 Common dialogs are ready-made dialog classes which are frequently used
59 \begin{twocollist
}\itemsep=
0pt
60 \twocolitem{\helpref{wxDialog
}{wxdialog
}}{Base class for common dialogs
}
61 \twocolitem{\helpref{wxColourDialog
}{wxcolourdialog
}}{Colour chooser dialog
}
62 \twocolitem{\helpref{wxDirDialog
}{wxdirdialog
}}{Directory selector dialog
}
63 \twocolitem{\helpref{wxFileDialog
}{wxfiledialog
}}{File selector 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{wxMessageDialog
}{wxmessagedialog
}}{Simple message box dialog
}
73 {\large {\bf Controls
}}
75 Typically, these are small windows which provide interaction with the user. Controls
76 that are not static can have
\helpref{validators
}{wxvalidator
} associated with them.
78 \begin{twocollist
}\itemsep=
0pt
79 \twocolitem{\helpref{wxControl
}{wxcontrol
}}{The base class for controls
}
80 \twocolitem{\helpref{wxButton
}{wxbutton
}}{Push button control, displaying text
}
81 \twocolitem{\helpref{wxBitmapButton
}{wxbitmapbutton
}}{Push button control, displaying a bitmap
}
82 \twocolitem{\helpref{wxCheckBox
}{wxcheckbox
}}{Checkbox control
}
83 \twocolitem{\helpref{wxCheckListBox
}{wxchecklistbox
}}{A listbox with a checkbox to the left of each item
}
84 \twocolitem{\helpref{wxChoice
}{wxchoice
}}{Choice control (a combobox without the editable area)
}
85 \twocolitem{\helpref{wxComboBox
}{wxcombobox
}}{A choice with an editable area
}
86 \twocolitem{\helpref{wxGauge
}{wxgauge
}}{A control to represent a varying quantity, such as time remaining
}
87 \twocolitem{\helpref{wxStaticBox
}{wxstaticbox
}}{A static, or group box for visually grouping related controls
}
88 \twocolitem{\helpref{wxListBox
}{wxlistbox
}}{A list of strings for single or multiple selection
}
89 \twocolitem{\helpref{wxListCtrl
}{wxlistctrl
}}{A control for displaying lists of strings and/or icons, plus a multicolumn
report view
}
90 \twocolitem{\helpref{wxTabCtrl
}{wxtabctrl
}}{Manages several tabs
}
91 \twocolitem{\helpref{wxTextCtrl
}{wxtextctrl
}}{Single or multline text editing control
}
92 \twocolitem{\helpref{wxTreeCtrl
}{wxtreectrl
}}{Tree (hierachy) control
}
93 \twocolitem{\helpref{wxScrollBar
}{wxscrollbar
}}{Scrollbar control
}
94 \twocolitem{\helpref{wxSpinButton
}{wxspinbutton
}}{A spin or `up-down' control
}
95 \twocolitem{\helpref{wxStaticText
}{wxstatictext
}}{One or more lines of non-editable text
}
96 \twocolitem{\helpref{wxStaticBitmap
}{wxstaticbitmap
}}{A control to display a bitmap
}
97 \twocolitem{\helpref{wxRadioBox
}{wxradiobox
}}{A group of radio buttons
}
98 \twocolitem{\helpref{wxRadioButton
}{wxradiobutton
}}{A round button to be used with others in a mutually exclusive way
}
99 \twocolitem{\helpref{wxSlider
}{wxslider
}}{A slider that can be dragged by the user
}
104 \begin{twocollist
}\itemsep=
0pt
105 \twocolitem{\helpref{wxMenu
}{wxmenu
}}{Displays a series of menu items for selection
}
106 \twocolitem{\helpref{wxMenuBar
}{wxmenubar
}}{Contains a series of menus for use with a frame
}
107 \twocolitem{\helpref{wxMenuItem
}{wxmenuitem
}}{Represents a single menu item
}
110 {\large {\bf Window layout
}}
112 \overview{Overview
}{constraintsoverview
}
114 These are the classes relevant to automated window layout.
116 \begin{twocollist
}\itemsep=
0pt
117 \twocolitem{\helpref{wxIndividualLayoutConstraint
}{wxindividuallayoutconstraint
}}{Represents a single constraint dimension
}
118 \twocolitem{\helpref{wxLayoutConstraints
}{wxlayoutconstraints
}}{Represents the constraints for a window class
}
121 {\large {\bf Device contexts
}}
123 \overview{Overview
}{dcoverview
}
125 Device contexts are surfaces that may be drawn on, and provide an
126 abstraction that allows parameterisation of your drawing code
127 by passing different device contexts.
129 \begin{twocollist
}\itemsep=
0pt
130 \twocolitem{\helpref{wxClientDC
}{wxclientdc
}}{A device context to access the client area outside
{\bf OnPaint
} events
}
131 \twocolitem{\helpref{wxPaintDC
}{wxpaintdc
}}{A device context to access the client area inside
{\bf OnPaint
} events
}
132 \twocolitem{\helpref{wxWindowDC
}{wxwindowdc
}}{A device context to access the non-client area
}
133 \twocolitem{\helpref{wxScreenDC
}{wxscreendc
}}{A device context to access the entire screen
}
134 \twocolitem{\helpref{wxDC
}{wxdc
}}{The device context base class
}
135 \twocolitem{\helpref{wxMemoryDC
}{wxmemorydc
}}{A device context for drawing into bitmaps
}
136 \twocolitem{\helpref{wxMetaFileDC
}{wxmetafiledc
}}{A device context for drawing into metafiles
}
137 \twocolitem{\helpref{wxPostScriptDC
}{wxpostscriptdc
}}{A device context for drawing into PostScript files
}
138 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{A device context for drawing to printers
}
141 {\large {\bf Graphics device interface
}}
143 \overview{Bitmaps overview
}{wxbitmapoverview
}
145 These classes are related to drawing on device contexts and windows.
147 \begin{twocollist
}\itemsep=
0pt
148 \twocolitem{\helpref{wxColour
}{wxcolour
}}{Represents the red, blue and green elements of a colour
}
149 \twocolitem{\helpref{wxBitmap
}{wxbitmap
}}{Represents a bitmap
}
150 \twocolitem{\helpref{wxBrush
}{wxbrush
}}{Used for filling areas on a device context
}
151 \twocolitem{\helpref{wxBrushList
}{wxbrushlist
}}{The list of previously-created brushes
}
152 \twocolitem{\helpref{wxCursor
}{wxcursor
}}{A small, transparent bitmap representing the cursor
}
153 \twocolitem{\helpref{wxFont
}{wxfont
}}{Represents fonts
}
154 \twocolitem{\helpref{wxFontList
}{wxfontlist
}}{The list of previously-created fonts
}
155 \twocolitem{\helpref{wxIcon
}{wxicon
}}{A small, transparent bitmap for assigning to frames and drawing on device contexts
}
156 \twocolitem{\helpref{wxImageList
}{wximagelist
}}{A list of images, used with some controls
}
157 \twocolitem{\helpref{wxMask
}{wxmask
}}{Represents a mask to be used with a bitmap for transparent drawing
}
158 \twocolitem{\helpref{wxPen
}{wxpen
}}{Used for drawing lines on a device context
}
159 \twocolitem{\helpref{wxPenList
}{wxpenlist
}}{The list of previously-created pens
}
160 \twocolitem{\helpref{wxPalette
}{wxpalette
}}{Represents a table of indices into RGB values
}
161 \twocolitem{\helpref{wxRegion
}{wxregion
}}{Represents a simple or complex region on a window or device context
}
164 {\large {\bf Events
}}
166 \overview{Overview
}{eventhandlingoverview
}
168 An event object contains information about a specific event. Event handlers
169 (usually member functions) have a single, event argument.
171 \begin{twocollist
}\itemsep=
0pt
172 \twocolitem{\helpref{wxActivateEvent
}{wxactivateevent
}}{A window or application activation event
}
173 \twocolitem{\helpref{wxCloseEvent
}{wxcloseevent
}}{A close window or end session event
}
174 \twocolitem{\helpref{wxCommandEvent
}{wxcommandevent
}}{An event from a variety of standard controls
}
175 \twocolitem{\helpref{wxDropFilesEvent
}{wxdropfilesevent
}}{A drop files event
}
176 \twocolitem{\helpref{wxEraseEvent
}{wxeraseevent
}}{An erase background event
}
177 \twocolitem{\helpref{wxEvent
}{wxevent
}}{The event base class
}
178 \twocolitem{\helpref{wxFocusEvent
}{wxfocusevent
}}{A window focus event
}
179 \twocolitem{\helpref{wxKeyEvent
}{wxkeyevent
}}{A keypress event
}
180 \twocolitem{\helpref{wxIdleEvent
}{wxidleevent
}}{An idle event
}
181 \twocolitem{\helpref{wxInitDialogEvent
}{wxinitdialogevent
}}{A dialog initialisation event
}
182 \twocolitem{\helpref{wxJoystickEvent
}{wxjoystickevent
}}{A joystick event
}
183 \twocolitem{\helpref{wxListEvent
}{wxlistevent
}}{A list control event
}
184 \twocolitem{\helpref{wxMenuEvent
}{wxmenuevent
}}{A menu event
}
185 \twocolitem{\helpref{wxMouseEvent
}{wxmouseevent
}}{A mouse event
}
186 \twocolitem{\helpref{wxMoveEvent
}{wxmoveevent
}}{A move event
}
187 \twocolitem{\helpref{wxPaintEvent
}{wxpaintevent
}}{A paint event
}
188 %\twocolitem{\helpref{wxSessionEvent}{wxsessionevent}}{A session ending event}
189 \twocolitem{\helpref{wxSizeEvent
}{wxsizeevent
}}{A size event
}
190 \twocolitem{\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}}{A system colour change event
}
191 \twocolitem{\helpref{wxTreeEvent
}{wxtreeevent
}}{A tree control event
}
192 \twocolitem{\helpref{wxUpdateUIEvent
}{wxupdateuievent
}}{A user interface update event
}
195 {\large {\bf Validators
}}
197 These are the window validators, used for filtering and validating
200 \begin{twocollist
}\itemsep=
0pt
201 \twocolitem{\helpref{wxValidator
}{wxvalidator
}}{Base validator class.
}
202 \twocolitem{\helpref{wxTextValidator
}{wxtextvalidator
}}{Text control validator class.
}
205 {\large {\bf Data structures
}}
207 These are the data structure classes supported by wxWindows.
209 \begin{twocollist
}\itemsep=
0pt
210 \twocolitem{\helpref{wxExpr
}{wxexpr
}}{A class for flexible I/O
}
211 \twocolitem{\helpref{wxExprDatabase
}{wxexprdatabase
}}{A class for flexible I/O
}
212 \twocolitem{\helpref{wxDate
}{wxdate
}}{A class for date manipulation
}
213 \twocolitem{\helpref{wxHashTable
}{wxhashtable
}}{A simple hash table implementation
}
214 \twocolitem{\helpref{wxList
}{wxlist
}}{A simple linked list implementation
}
215 \twocolitem{\helpref{wxNode
}{wxnode
}}{Represents a node in the wxList implementation
}
216 \twocolitem{\helpref{wxObject
}{wxobject
}}{The root class for most wxWindows classes
}
217 \twocolitem{\helpref{wxPathList
}{wxpathlist
}}{A class to help search multiple paths
}
218 \twocolitem{\helpref{wxPoint
}{wxpoint
}}{Representation of a point
}
219 \twocolitem{\helpref{wxRect
}{wxrect
}}{A class representing a rectangle
}
220 \twocolitem{\helpref{wxRegion
}{wxregion
}}{A class representing a region
}
221 \twocolitem{\helpref{wxString
}{wxstring
}}{A string class
}
222 \twocolitem{\helpref{wxStringList
}{wxstringlist
}}{A class representing a list of strings
}
223 \twocolitem{\helpref{wxRealPoint
}{wxrealpoint
}}{Representation of a point using floating point numbers
}
224 \twocolitem{\helpref{wxSize
}{wxsize
}}{Representation of a size
}
225 \twocolitem{\helpref{wxTime
}{wxtime
}}{A class for time manipulation
}
228 {\large {\bf Run-time class information system
}}
230 \overview{Overview
}{runtimeclassoverview
}
232 wxWindows supports run-time manipulation of class information, and dynamic
233 creation of objects given class names.
235 \begin{twocollist
}\itemsep=
0pt
236 \twocolitem{\helpref{wxClassInfo
}{wxclassinfo
}}{Holds run-time class information
}
237 \twocolitem{\helpref{wxObject
}{wxobject
}}{Root class for classes with run-time information
}
238 \twocolitem{\helpref{Macros
}{macros
}}{Macros for manipulating run-time information
}
241 {\large {\bf Debugging features
}}
243 \overview{Overview
}{debuggingoverview
}
245 wxWindows supports some aspects of debugging an application through
246 classes, functions and macros.
248 \begin{twocollist
}\itemsep=
0pt
249 \twocolitem{\helpref{wxDebugContext
}{wxdebugcontext
}}{Provides various debugging facilities
}
250 \twocolitem{\helpref{wxDebugStreamBuf
}{wxdebugstreambuf
}}{A stream buffer writing to the debug stream
}
251 \twocolitem{\helpref{wxObject
}{wxobject
}}{Provides optional debugging versions of
{\bf new
} and
{\bf delete
}}
252 \twocolitem{\helpref{wxTrace
}{wxtrace
}}{Tracing facility
}
253 \twocolitem{\helpref{wxTraceLevel
}{wxtracelevel
}}{Tracing facility with levels
}
254 \twocolitem{\helpref{WXDEBUG
\_NEW}{debugnew
}}{Use this macro to give further debugging information
}
255 \twocolitem{\helpref{WXTRACE
}{trace
}}{Trace macro
}
256 \twocolitem{\helpref{WXTRACELEVEL
}{tracelevel
}}{Trace macro with levels
}
259 {\large {\bf Interprocess communication
}}
261 \overview{Overview
}{ipcoverview
}
263 wxWindows provides a simple interprocess communications facilities
266 \begin{twocollist
}\itemsep=
0pt
267 \twocolitem{\helpref{wxDDEClient
}{wxddeclient
}}{Represents a client
}
268 \twocolitem{\helpref{wxDDEConnection
}{wxddeconnection
}}{Represents the connection between a client and a server
}
269 \twocolitem{\helpref{wxDDEServer
}{wxddeserver
}}{Represents a server
}
270 %TODO: put this somewhere \twocolitem{\helpref{wxHelpInstance}{wxhelpinstance}}{A specialised client}
273 {\large {\bf Document/view framework
}}
275 \overview{Overview
}{docviewoverview
}
277 wxWindows supports a
document/view framework which provides
278 housekeeping for a
document-centric application.
280 TODO: MDI frame classes for documents; make it unnecessary to convert
281 between streams and files (overridable method that uses filenames instead of streams).
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
}
292 {\large {\bf Printing framework
}}
294 \overview{Overview
}{printingoverview
}
296 A printing and previewing framework is implemented to
297 make it relatively straighforward to provide
document printing
300 \begin{twocollist
}\itemsep=
0pt
301 \twocolitem{\helpref{wxPreviewFrame
}{wxpreviewframe
}}{Frame for displaying a print preview
}
302 \twocolitem{\helpref{wxPreviewCanvas
}{wxpreviewcanvas
}}{Canvas for displaying a print preview
}
303 \twocolitem{\helpref{wxPreviewControlBar
}{wxpreviewcontrolbar
}}{Standard control bar for a print preview
}
304 \twocolitem{\helpref{wxPrintData
}{wxprintdata
}}{Represents information about the
document being printed
}
305 \twocolitem{\helpref{wxPrintDialog
}{wxprintdialog
}}{Standard print dialog
}
306 \twocolitem{\helpref{wxPrinter
}{wxprinter
}}{Class representing the printer
}
307 \twocolitem{\helpref{wxPrinterDC
}{wxprinterdc
}}{Printer device context
}
308 \twocolitem{\helpref{wxPrintout
}{wxprintout
}}{Class representing a particular printout
}
309 \twocolitem{\helpref{wxPrintPreview
}{wxprintpreview
}}{Class representing a print preview
}
312 {\large {\bf Database classes
}}
314 \overview{Database classes overview
}{odbcoverview
}
316 wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
319 \begin{twocollist
}\itemsep=
0pt
320 \twocolitem{\helpref{wxDatabase
}{wxdatabase
}}{Database class
}
321 \twocolitem{\helpref{wxQueryCol
}{wxquerycol
}}{Class representing a column
}
322 \twocolitem{\helpref{wxQueryField
}{wxqueryfield
}}{Class representing a field
}
323 \twocolitem{\helpref{wxRecordSet
}{wxrecordset
}}{Class representing one or more record
}
326 {\large {\bf Miscellaneous
}}
328 \begin{twocollist
}\itemsep=
0pt
329 \twocolitem{\helpref{wxApp
}{wxapp
}}{Application class
}
330 \twocolitem{\helpref{wxTimer
}{wxtimer
}}{Timer class
}
331 \twocolitem{\helpref{wxSystemSettings
}{wxsystemsettings
}}{System settings class
}
projects / wxWidgets.git / blob