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