]>
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 | ||
fc2171bd | 5 | A classification of wxWidgets 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). | |
834ed994 | 11 | Frames and dialogs are similar in wxWidgets, but only dialogs may be modal. |
a660d684 | 12 | |
1c0c339c | 13 | \twocolwidtha{6cm} |
a660d684 | 14 | \begin{twocollist}\itemsep=0pt |
834ed994 | 15 | \twocolitem{\helpref{wxTopLevelWindow}{wxtoplevelwindow}}{Any top level window, dialog or frame} |
a660d684 KB |
16 | \twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box} |
17 | \twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame} | |
a660d684 | 18 | \twocolitem{\helpref{wxMDIChildFrame}{wxmdichildframe}}{MDI child frame} |
e3c10211 | 19 | \twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent frame} |
a660d684 | 20 | \twocolitem{\helpref{wxMiniFrame}{wxminiframe}}{A frame with a small title bar} |
3c9287bb | 21 | \twocolitem{\helpref{wxPropertySheetDialog}{wxpropertysheetdialog}}{Property sheet dialog} |
62a268cc | 22 | \twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class} |
bd330a69 JS |
23 | %\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog |
24 | %(deprecated, use wxNotebook instead)} | |
e3c10211 JS |
25 | \twocolitem{\helpref{wxTipWindow}{wxtipwindow}}{Shows text in a small window} |
26 | \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog} | |
a660d684 KB |
27 | \end{twocollist} |
28 | ||
29 | See also {\bf Common dialogs}. | |
30 | ||
31 | {\large {\bf Miscellaneous windows}} | |
32 | ||
d7da9756 | 33 | The following are a variety of classes that are derived from wxWindow. |
a660d684 | 34 | |
1c0c339c | 35 | \twocolwidtha{6cm} |
a660d684 | 36 | \begin{twocollist}\itemsep=0pt |
a660d684 KB |
37 | \twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings} |
38 | \twocolitem{\helpref{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars} | |
a5a0dd06 | 39 | \twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window} |
a660d684 KB |
40 | \twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally} |
41 | \twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame} | |
81d66cf3 | 42 | \twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class} |
3972fb49 JS |
43 | %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} |
44 | \twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} | |
c16b8e18 | 45 | \twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control} |
f5e0b4bc | 46 | \twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control} |
eca15c0d | 47 | \twocolitem{\helpref{wxTreebook}{wxtreebook}}{Similar to notebook but using tree control} |
a5a0dd06 RR |
48 | \twocolitem{\helpref{wxSashWindow}{wxsashwindow}}{Window with four optional sashes that can be dragged} |
49 | \twocolitem{\helpref{wxSashLayoutWindow}{wxsashlayoutwindow}}{Window that can be involved in an IDE-like layout arrangement} | |
cf7d6329 | 50 | \twocolitem{\helpref{wxVScrolledWindow}{wxvscrolledwindow}}{As wxScrolledWindow but supports lines of variable height} |
f6bcfd97 BP |
51 | \twocolitem{\helpref{wxWizardPage}{wxwizardpage}}{A base class for the page in wizard dialog.} |
52 | \twocolitem{\helpref{wxWizardPageSimple}{wxwizardpagesimple}}{A page in wizard dialog.} | |
a660d684 KB |
53 | \end{twocollist} |
54 | ||
55 | {\large {\bf Common dialogs}} | |
56 | ||
57 | \overview{Overview}{commondialogsoverview} | |
58 | ||
59 | Common dialogs are ready-made dialog classes which are frequently used | |
60 | in an application. | |
61 | ||
1c0c339c | 62 | \twocolwidtha{6cm} |
a660d684 KB |
63 | \begin{twocollist}\itemsep=0pt |
64 | \twocolitem{\helpref{wxDialog}{wxdialog}}{Base class for common dialogs} | |
65 | \twocolitem{\helpref{wxColourDialog}{wxcolourdialog}}{Colour chooser dialog} | |
66 | \twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog} | |
67 | \twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog} | |
8db37e06 | 68 | \twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog} |
04bf08b7 | 69 | \twocolitem{\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}}{Dialog to get one or more selections from a list} |
a660d684 KB |
70 | \twocolitem{\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}}{Dialog to get a single selection from a list and return the string} |
71 | \twocolitem{\helpref{wxTextEntryDialog}{wxtextentrydialog}}{Dialog to get a single line of text from the user} | |
55b46fd1 | 72 | \twocolitem{\helpref{wxPasswordEntryDialog}{wxpasswordentrydialog}}{Dialog to get a password from the user} |
a660d684 KB |
73 | \twocolitem{\helpref{wxFontDialog}{wxfontdialog}}{Font chooser dialog} |
74 | \twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} | |
75 | \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} | |
74d88854 | 76 | \twocolitem{\helpref{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog} |
a660d684 | 77 | \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog} |
62a268cc JS |
78 | \twocolitem{\helpref{wxSymbolPickerDialog}{wxsymbolpickerdialog}}{Symbol selector dialog} |
79 | \twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for formatting the content of a wxRichTextCtrl} | |
f6bcfd97 | 80 | \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.} |
a660d684 KB |
81 | \end{twocollist} |
82 | ||
83 | {\large {\bf Controls}} | |
84 | ||
85 | Typically, these are small windows which provide interaction with the user. Controls | |
86 | that are not static can have \helpref{validators}{wxvalidator} associated with them. | |
87 | ||
1c0c339c | 88 | \twocolwidtha{6cm} |
a660d684 | 89 | \begin{twocollist}\itemsep=0pt |
72045d57 | 90 | \twocolitem{\helpref{wxAnimationCtrl}{wxanimationctrl}}{A control to display an animation} |
a660d684 KB |
91 | \twocolitem{\helpref{wxControl}{wxcontrol}}{The base class for controls} |
92 | \twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text} | |
93 | \twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap} | |
95a46303 | 94 | \twocolitem{\helpref{wxBitmapComboBox}{wxbitmapcombobox}}{A combobox with bitmaps next to text items} |
ecdba0d1 | 95 | \twocolitem{\helpref{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.} |
feb72429 | 96 | \twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Control showing an entire calendar month} |
a660d684 KB |
97 | \twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control} |
98 | \twocolitem{\helpref{wxCheckListBox}{wxchecklistbox}}{A listbox with a checkbox to the left of each item} | |
99 | \twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)} | |
100 | \twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area} | |
0dfff674 | 101 | \twocolitem{\helpref{wxComboCtrl}{wxcomboctrl}}{A combobox with application defined popup} |
91506eb0 | 102 | \twocolitem{\helpref{wxDataViewCtrl}{wxdataviewctrl}}{A control to tabular or tree like data} |
a660d684 | 103 | \twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining} |
2f3ebe4c | 104 | \twocolitem{\helpref{wxGenericDirCtrl}{wxgenericdirctrl}}{A control for displaying a directory tree} |
9ebb7cad VZ |
105 | \twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{An abstract class for creating listboxes showing HTML content} |
106 | \twocolitem{\helpref{wxSimpleHtmlListBox}{wxsimplehtmllistbox}}{A listbox showing HTML content} | |
a660d684 KB |
107 | \twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls} |
108 | \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} | |
109 | \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} | |
913c8465 | 110 | \twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade}) for wxListCtrl in report mode} |
0dfff674 | 111 | \twocolitem{\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}}{A combobox with owner-drawn list items} |
5f35b46a | 112 | \twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{Generic rich text editing control} |
f6bcfd97 BP |
113 | \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} |
114 | \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} | |
a660d684 KB |
115 | \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control} |
116 | \twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control} | |
5d9dba5b | 117 | \twocolitem{\helpref{wxSpinCtrl}{wxspinctrl}}{A spin control - i.e. spin button and text control} |
a660d684 | 118 | \twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text} |
17e91437 | 119 | \twocolitem{\helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}{A static text which opens an URL when clicked} |
a660d684 KB |
120 | \twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap} |
121 | \twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons} | |
122 | \twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way} | |
123 | \twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user} | |
e0c6027b | 124 | \twocolitem{\helpref{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows} |
a660d684 KB |
125 | \end{twocollist} |
126 | ||
ec376c8f VZ |
127 | |
128 | {\large {\bf Miscellaneous pickers}} | |
129 | ||
130 | A picker control is a control whose appearance and behaviour is highly platform-dependent. | |
131 | ||
132 | \twocolwidtha{6cm} | |
133 | \begin{twocollist}\itemsep=0pt | |
134 | \twocolitem{\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}}{A control which allows the user to choose a colour} | |
135 | \twocolitem{\helpref{wxDirPickerCtrl}{wxdirpickerctrl}}{A control which allows the user to choose a directory} | |
136 | \twocolitem{\helpref{wxFilePickerCtrl}{wxfilepickerctrl}}{A control which allows the user to choose a file} | |
137 | \twocolitem{\helpref{wxFontPickerCtrl}{wxfontpickerctrl}}{A control which allows the user to choose a font} | |
138 | \twocolitem{\helpref{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control} | |
139 | \end{twocollist} | |
140 | ||
141 | ||
a660d684 KB |
142 | {\large {\bf Menus}} |
143 | ||
1c0c339c | 144 | \twocolwidtha{6cm} |
a660d684 KB |
145 | \begin{twocollist}\itemsep=0pt |
146 | \twocolitem{\helpref{wxMenu}{wxmenu}}{Displays a series of menu items for selection} | |
147 | \twocolitem{\helpref{wxMenuBar}{wxmenubar}}{Contains a series of menus for use with a frame} | |
148 | \twocolitem{\helpref{wxMenuItem}{wxmenuitem}}{Represents a single menu item} | |
149 | \end{twocollist} | |
150 | ||
1fdd3f34 RR |
151 | {\large {\bf wxAUI - advanced user interface}} |
152 | ||
153 | This is a new set of classes for writing a customizable application | |
154 | interface with built-in docking, floatable panes and a flexible | |
155 | MDI-like interface. Further classes for custom notebooks with | |
156 | draggable tabs etc. are in progress. See also \helpref{wxAUI overview}{wxauioverview}. | |
157 | ||
158 | \twocolwidtha{6cm} | |
159 | \begin{twocollist}\itemsep=0pt | |
160 | \twocolitem{\helpref{wxAuiManager}{wxauimanager}}{The central class for managing the interface} | |
fa2aeeb5 | 161 | \twocolitem{\helpref{wxAuiNotebook}{wxauinotebook}}{A replacement notebook class with extra features} |
1fdd3f34 | 162 | \twocolitem{\helpref{wxAuiPaneInfo}{wxauipaneinfo}}{Describes a single pane} |
fa2aeeb5 BW |
163 | \twocolitem{\helpref{wxAuiDockArt}{wxauidockart}}{Art and metrics provider for customizing the docking user interface} |
164 | \twocolitem{\helpref{wxAuiTabArt}{wxauitabart}}{Art and metrics provider for customizing the notebook user interface} | |
1fdd3f34 RR |
165 | \end{twocollist} |
166 | ||
167 | ||
a660d684 KB |
168 | {\large {\bf Window layout}} |
169 | ||
1c0c339c | 170 | There are two different systems for laying out windows (and dialogs in particular). |
515da557 RR |
171 | One is based upon so-called sizers and it requires less typing, thinking and calculating |
172 | and will in almost all cases produce dialogs looking equally well on all platforms, the | |
1c0c339c | 173 | other is based on so-called constraints and is deprecated, though still available. |
a660d684 | 174 | |
1c0c339c | 175 | \overview{Sizer overview}{sizeroverview} describes sizer-based layout. |
515da557 | 176 | |
1c0c339c JS |
177 | These are the classes relevant to sizer-based layout. |
178 | ||
179 | \twocolwidtha{6cm} | |
515da557 RR |
180 | \begin{twocollist}\itemsep=0pt |
181 | \twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class} | |
f6bcfd97 BP |
182 | \twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size} |
183 | \twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid} | |
20b35a69 | 184 | \twocolitem{\helpref{wxGridBagSizer}{wxgridbagsizer}}{Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.} |
515da557 | 185 | \twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column} |
1c0c339c | 186 | \twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box} |
515da557 RR |
187 | \end{twocollist} |
188 | ||
1c0c339c | 189 | \overview{Constraints overview}{constraintsoverview} describes constraints-based layout. |
515da557 RR |
190 | |
191 | These are the classes relevant to constraints-based window layout. | |
a660d684 | 192 | |
1c0c339c | 193 | \twocolwidtha{6cm} |
a660d684 KB |
194 | \begin{twocollist}\itemsep=0pt |
195 | \twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension} | |
196 | \twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class} | |
197 | \end{twocollist} | |
198 | ||
199 | {\large {\bf Device contexts}} | |
200 | ||
201 | \overview{Overview}{dcoverview} | |
202 | ||
203 | Device contexts are surfaces that may be drawn on, and provide an | |
204 | abstraction that allows parameterisation of your drawing code | |
205 | by passing different device contexts. | |
206 | ||
1c0c339c | 207 | \twocolwidtha{6cm} |
a660d684 | 208 | \begin{twocollist}\itemsep=0pt |
3dfd8daf | 209 | \twocolitem{\helpref{wxAutoBufferedPaintDC}{wxautobufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.} |
d6af57d4 VZ |
210 | \twocolitem{\helpref{wxBufferedDC}{wxbuffereddc}}{A helper device context for double buffered drawing.} |
211 | \twocolitem{\helpref{wxBufferedPaintDC}{wxbufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.} | |
a660d684 KB |
212 | \twocolitem{\helpref{wxClientDC}{wxclientdc}}{A device context to access the client area outside {\bf OnPaint} events} |
213 | \twocolitem{\helpref{wxPaintDC}{wxpaintdc}}{A device context to access the client area inside {\bf OnPaint} events} | |
214 | \twocolitem{\helpref{wxWindowDC}{wxwindowdc}}{A device context to access the non-client area} | |
215 | \twocolitem{\helpref{wxScreenDC}{wxscreendc}}{A device context to access the entire screen} | |
216 | \twocolitem{\helpref{wxDC}{wxdc}}{The device context base class} | |
217 | \twocolitem{\helpref{wxMemoryDC}{wxmemorydc}}{A device context for drawing into bitmaps} | |
e2a6f233 | 218 | \twocolitem{\helpref{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles} |
8f20ea03 | 219 | \twocolitem{\helpref{wxMirrorDC}{wxmirrordc}}{A proxy device context allowing for simple mirroring.} |
a660d684 KB |
220 | \twocolitem{\helpref{wxPostScriptDC}{wxpostscriptdc}}{A device context for drawing into PostScript files} |
221 | \twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{A device context for drawing to printers} | |
222 | \end{twocollist} | |
223 | ||
224 | {\large {\bf Graphics device interface}} | |
225 | ||
226 | \overview{Bitmaps overview}{wxbitmapoverview} | |
227 | ||
228 | These classes are related to drawing on device contexts and windows. | |
229 | ||
1c0c339c | 230 | \twocolwidtha{6cm} |
a660d684 KB |
231 | \begin{twocollist}\itemsep=0pt |
232 | \twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour} | |
6c975af1 | 233 | \twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region} |
a660d684 KB |
234 | \twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap} |
235 | \twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context} | |
236 | \twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes} | |
237 | \twocolitem{\helpref{wxCursor}{wxcursor}}{A small, transparent bitmap representing the cursor} | |
238 | \twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts} | |
239 | \twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts} | |
240 | \twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts} | |
89c684ef | 241 | \twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class} |
a660d684 KB |
242 | \twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls} |
243 | \twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing} | |
244 | \twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context} | |
245 | \twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens} | |
246 | \twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values} | |
247 | \twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context} | |
684761db | 248 | \twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives} |
a660d684 KB |
249 | \end{twocollist} |
250 | ||
251 | {\large {\bf Events}} | |
252 | ||
253 | \overview{Overview}{eventhandlingoverview} | |
254 | ||
255 | An event object contains information about a specific event. Event handlers | |
256 | (usually member functions) have a single, event argument. | |
257 | ||
1c0c339c | 258 | \twocolwidtha{6cm} |
a660d684 KB |
259 | \begin{twocollist}\itemsep=0pt |
260 | \twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event} | |
f6bcfd97 | 261 | \twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} |
6fb26ea3 | 262 | \twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout} |
66ad556c | 263 | \twocolitem{\helpref{wxChildFocusEvent}{wxchildfocusevent}}{A child window focus event} |
78c91815 | 264 | \twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event} |
a660d684 KB |
265 | \twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event} |
266 | \twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls} | |
5cb1ae8b | 267 | \twocolitem{\helpref{wxContextMenuEvent}{wxcontextmenuevent}}{An event generated when the user issues a context menu command} |
e6e86d52 | 268 | \twocolitem{\helpref{wxDateEvent}{wxdateevent}}{Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}} |
f6bcfd97 | 269 | \twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}} |
a660d684 KB |
270 | \twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event} |
271 | \twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event} | |
272 | \twocolitem{\helpref{wxEvent}{wxevent}}{The event base class} | |
f010ad48 | 273 | \twocolitem{\helpref{wxFindDialogEvent}{wxfinddialogevent}}{Event sent by |
8db37e06 | 274 | \helpref{wxFindReplaceDialog}{wxfindreplacedialog}} |
a660d684 KB |
275 | \twocolitem{\helpref{wxFocusEvent}{wxfocusevent}}{A window focus event} |
276 | \twocolitem{\helpref{wxKeyEvent}{wxkeyevent}}{A keypress event} | |
3dd9b88a | 277 | \twocolitem{\helpref{wxIconizeEvent}{wxiconizeevent}}{An iconize/restore event} |
a660d684 KB |
278 | \twocolitem{\helpref{wxIdleEvent}{wxidleevent}}{An idle event} |
279 | \twocolitem{\helpref{wxInitDialogEvent}{wxinitdialogevent}}{A dialog initialisation event} | |
280 | \twocolitem{\helpref{wxJoystickEvent}{wxjoystickevent}}{A joystick event} | |
281 | \twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event} | |
3dd9b88a | 282 | \twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event} |
a660d684 | 283 | \twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event} |
a5e84126 | 284 | \twocolitem{\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}}{A mouse capture changed event} |
63e819f2 | 285 | \twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event} |
a660d684 KB |
286 | \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event} |
287 | \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event} | |
a701b455 | 288 | \twocolitem{\helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}}{An event set by navigation keys such as tab} |
3972fb49 | 289 | \twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event} |
fd128b0c | 290 | \twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed} |
a660d684 | 291 | \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event} |
3972fb49 | 292 | \twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} |
6fb26ea3 | 293 | \twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information} |
5f35b46a | 294 | \twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event} |
fd128b0c RR |
295 | \twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons} |
296 | \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows} | |
a660d684 | 297 | \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event} |
42ff6409 | 298 | \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event} |
f6bcfd97 | 299 | \twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}} |
e6e86d52 | 300 | \twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{An event from \helpref{wxSplitterWindow}{wxsplitterwindow}} |
a660d684 | 301 | \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} |
e3f17fc8 | 302 | \twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event} |
eca15c0d | 303 | \twocolitem{\helpref{wxTreebookEvent}{wxtreebookevent}}{A treebook control event} |
a660d684 KB |
304 | \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} |
305 | \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} | |
4acaa5e2 JS |
306 | \twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event} |
307 | \twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event} | |
f6bcfd97 | 308 | \twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event} |
a660d684 KB |
309 | \end{twocollist} |
310 | ||
311 | {\large {\bf Validators}} | |
312 | ||
6b037754 JS |
313 | \overview{Overview}{validatoroverview} |
314 | ||
a660d684 KB |
315 | These are the window validators, used for filtering and validating |
316 | user input. | |
317 | ||
1c0c339c | 318 | \twocolwidtha{6cm} |
a660d684 | 319 | \begin{twocollist}\itemsep=0pt |
89c684ef JS |
320 | \twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class} |
321 | \twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class} | |
322 | \twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class} | |
a660d684 KB |
323 | \end{twocollist} |
324 | ||
325 | {\large {\bf Data structures}} | |
326 | ||
fc2171bd | 327 | These are the data structure classes supported by wxWidgets. |
a660d684 | 328 | |
1c0c339c | 329 | \twocolwidtha{6cm} |
a660d684 | 330 | \begin{twocollist}\itemsep=0pt |
f6bcfd97 | 331 | \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class} |
f6bcfd97 | 332 | \twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.} |
d7da9756 | 333 | \twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations} |
d7da9756 | 334 | \twocolitem{\helpref{wxLongLong}{wxlonglong}}{A portable 64 bit integer type} |
fc2171bd | 335 | \twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWidgets classes} |
a660d684 KB |
336 | \twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths} |
337 | \twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point} | |
338 | \twocolitem{\helpref{wxRect}{wxrect}}{A class representing a rectangle} | |
8fb2999a | 339 | \twocolitem{\helpref{wxRegEx}{wxregex}}{Regular expression support} |
a660d684 KB |
340 | \twocolitem{\helpref{wxRegion}{wxregion}}{A class representing a region} |
341 | \twocolitem{\helpref{wxString}{wxstring}}{A string class} | |
9c884972 | 342 | \twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words} |
a660d684 KB |
343 | \twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers} |
344 | \twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size} | |
f6bcfd97 | 345 | \twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.} |
86470d43 | 346 | \twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier} |
d7da9756 | 347 | \twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time} |
a660d684 KB |
348 | \end{twocollist} |
349 | ||
44f2a3d1 RR |
350 | {\large {\bf Container classes}} |
351 | ||
352 | \overview{Overview}{wxcontaineroverview} | |
353 | ||
354 | These are classes, templates and class macros are used by wxWidgets. Most | |
355 | of these classes provide a subset or almost complete STL API. | |
356 | ||
357 | \twocolwidtha{6cm} | |
358 | \begin{twocollist}\itemsep=0pt | |
359 | \twocolitem{\helpref{wxArray<T>}{wxarray}}{A type-safe dynamic array implementation (macro based)} | |
360 | \twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects} | |
361 | \twocolitem{\helpref{wxHashMap<T>}{wxhashmap}}{A type-safe hash map implementation (macro based)} | |
362 | \twocolitem{\helpref{wxHashSet<T>}{wxhashset}}{A type-safe hash set implementation(macro based)} | |
363 | \twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)} | |
364 | \twocolitem{\helpref{wxList<T>}{wxlist}}{A type-safe linked list implementation (macro based)} | |
365 | \twocolitem{\helpref{wxVector<T>}{wxvector}}{Template base vector implementation} | |
366 | \end{twocollist} | |
367 | ||
a660d684 KB |
368 | {\large {\bf Run-time class information system}} |
369 | ||
370 | \overview{Overview}{runtimeclassoverview} | |
371 | ||
fc2171bd | 372 | wxWidgets supports run-time manipulation of class information, and dynamic |
a660d684 KB |
373 | creation of objects given class names. |
374 | ||
1c0c339c | 375 | \twocolwidtha{6cm} |
a660d684 KB |
376 | \begin{twocollist}\itemsep=0pt |
377 | \twocolitem{\helpref{wxClassInfo}{wxclassinfo}}{Holds run-time class information} | |
378 | \twocolitem{\helpref{wxObject}{wxobject}}{Root class for classes with run-time information} | |
f4fcc291 | 379 | \twocolitem{\helpref{RTTI macros}{rttimacros}}{Macros for manipulating run-time information} |
a660d684 KB |
380 | \end{twocollist} |
381 | ||
2fda2145 | 382 | {\large {\bf Logging features}} |
a660d684 | 383 | |
30fc2c8e | 384 | \overview{Overview}{wxlogoverview} |
f1fa9adc | 385 | |
fc2171bd | 386 | wxWidgets provides several classes and functions for message logging. |
f1fa9adc VZ |
387 | Please see the \helpref{wxLog overview}{wxlogoverview} for more details. |
388 | ||
1c0c339c | 389 | \twocolwidtha{6cm} |
f1fa9adc VZ |
390 | \begin{twocollist}\itemsep=0pt |
391 | \twocolitem{\helpref{wxLog}{wxlog}}{The base log class} | |
392 | \twocolitem{\helpref{wxLogStderr}{wxlogstderr}}{Log messages to a C STDIO stream} | |
393 | \twocolitem{\helpref{wxLogStream}{wxlogstream}}{Log messages to a C++ iostream} | |
394 | \twocolitem{\helpref{wxLogTextCtrl}{wxlogtextctrl}}{Log messages to a \helpref{wxTextCtrl}{wxtextctrl}} | |
395 | \twocolitem{\helpref{wxLogWindow}{wxlogwindow}}{Log messages to a log frame} | |
396 | \twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs} | |
397 | \twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging} | |
398 | \twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets} | |
7ffc857f VZ |
399 | \twocolitem{\helpref{wxLogInterposer}{wxloginterposer}}{Allows to filter the log messages} |
400 | \twocolitem{\helpref{wxLogInterposerTemp}{wxloginterposertemp}}{Allows to filter the log messages} | |
f1fa9adc VZ |
401 | \twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows |
402 | to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}} | |
403 | \twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions} | |
404 | \end{twocollist} | |
405 | ||
406 | {\large {\bf Debugging features}} | |
407 | ||
a660d684 KB |
408 | \overview{Overview}{debuggingoverview} |
409 | ||
fc2171bd | 410 | wxWidgets supports some aspects of debugging an application through |
a660d684 KB |
411 | classes, functions and macros. |
412 | ||
1c0c339c | 413 | \twocolwidtha{6cm} |
a660d684 | 414 | \begin{twocollist}\itemsep=0pt |
6b037754 | 415 | \twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities} |
6b037754 | 416 | \twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking} |
a660d684 | 417 | \twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information} |
af127680 VZ |
418 | \twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.} |
419 | \twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.} | |
420 | \twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.} | |
421 | \twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.} | |
422 | \twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.} | |
a660d684 KB |
423 | \end{twocollist} |
424 | ||
238ddd26 RR |
425 | {\large {\bf Networking classes}} |
426 | ||
fc2171bd | 427 | wxWidgets provides its own classes for socket based networking. |
238ddd26 | 428 | |
1c0c339c | 429 | \twocolwidtha{6cm} |
238ddd26 | 430 | \begin{twocollist}\itemsep=0pt |
f6bcfd97 BP |
431 | \twocolitem{\helpref{wxDialUpManager}{wxdialupmanager}}{Provides functions to check the status of network connection and to establish one} |
432 | \twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet address} | |
be4bd463 | 433 | \twocolitem{\helpref{wxIPaddress}{wxipaddress}}{Represents an Internet address} |
672186ef | 434 | \twocolitem{\helpref{wxSocketBase}{wxsocketbase}}{Represents a socket base object} |
238ddd26 RR |
435 | \twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client} |
436 | \twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} | |
238ddd26 | 437 | \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event} |
672186ef GRG |
438 | \twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class} |
439 | \twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class} | |
440 | \twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator} | |
238ddd26 RR |
441 | \end{twocollist} |
442 | ||
443 | ||
a660d684 KB |
444 | {\large {\bf Interprocess communication}} |
445 | ||
446 | \overview{Overview}{ipcoverview} | |
447 | ||
fc2171bd | 448 | wxWidgets provides simple interprocess communications facilities |
f010ad48 | 449 | based on Windows DDE, but available on most platforms using TCP. |
a660d684 | 450 | |
1c0c339c | 451 | \twocolwidtha{6cm} |
a660d684 | 452 | \begin{twocollist}\itemsep=0pt |
f510b7b2 WS |
453 | \twocolitem{\helpref{wxClient}{wxclient}, \helpref{wxDDEClient}{wxddeclient}}{Represents a client} |
454 | \twocolitem{\helpref{wxConnection}{wxconnection}, \helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server} | |
455 | \twocolitem{\helpref{wxServer}{wxserver}, \helpref{wxDDEServer}{wxddeserver}}{Represents a server} | |
d7cb14ce | 456 | %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} |
a660d684 KB |
457 | \end{twocollist} |
458 | ||
459 | {\large {\bf Document/view framework}} | |
460 | ||
461 | \overview{Overview}{docviewoverview} | |
462 | ||
fc2171bd | 463 | wxWidgets supports a document/view framework which provides |
a660d684 KB |
464 | housekeeping for a document-centric application. |
465 | ||
1c0c339c | 466 | \twocolwidtha{6cm} |
a660d684 KB |
467 | \begin{twocollist}\itemsep=0pt |
468 | \twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document} | |
469 | \twocolitem{\helpref{wxView}{wxview}}{Represents a view} | |
f6bcfd97 | 470 | \twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a view class} |
a660d684 KB |
471 | \twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application} |
472 | \twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view} | |
473 | \twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views} | |
6fb26ea3 JS |
474 | %\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view} |
475 | %\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views} | |
a660d684 KB |
476 | \end{twocollist} |
477 | ||
478 | {\large {\bf Printing framework}} | |
479 | ||
480 | \overview{Overview}{printingoverview} | |
481 | ||
482 | A printing and previewing framework is implemented to | |
f6bcfd97 | 483 | make it relatively straightforward to provide document printing |
a660d684 KB |
484 | facilities. |
485 | ||
1c0c339c | 486 | \twocolwidtha{6cm} |
a660d684 KB |
487 | \begin{twocollist}\itemsep=0pt |
488 | \twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview} | |
489 | \twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview} | |
490 | \twocolitem{\helpref{wxPreviewControlBar}{wxpreviewcontrolbar}}{Standard control bar for a print preview} | |
a660d684 | 491 | \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} |
7bcb11d3 | 492 | \twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} |
a660d684 KB |
493 | \twocolitem{\helpref{wxPrinter}{wxprinter}}{Class representing the printer} |
494 | \twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{Printer device context} | |
495 | \twocolitem{\helpref{wxPrintout}{wxprintout}}{Class representing a particular printout} | |
496 | \twocolitem{\helpref{wxPrintPreview}{wxprintpreview}}{Class representing a print preview} | |
7bcb11d3 JS |
497 | \twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed} |
498 | \twocolitem{\helpref{wxPrintDialogData}{wxprintdialogdata}}{Represents information about the print dialog} | |
499 | \twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog} | |
a660d684 KB |
500 | \end{twocollist} |
501 | ||
dface61c JS |
502 | {\large {\bf Drag and drop and clipboard classes}} |
503 | ||
504 | \overview{Drag and drop and clipboard overview}{wxdndoverview} | |
505 | ||
1c0c339c | 506 | \twocolwidtha{6cm} |
dface61c | 507 | \begin{twocollist}\itemsep=0pt |
dface61c | 508 | \twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class} |
c03648c2 | 509 | \twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format} |
dface61c | 510 | \twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class} |
5ab2950d | 511 | \twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class} |
dface61c | 512 | \twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class} |
c959d912 | 513 | \twocolitem{\helpref{wxURLDataObject}{wxurldataobject}}{URL data object class} |
0a2017e0 | 514 | \twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class} |
dface61c | 515 | \twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class} |
5aa5e35a RR |
516 | \twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class} |
517 | \twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class} | |
518 | \twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class} | |
519 | \twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class} | |
dface61c JS |
520 | \end{twocollist} |
521 | ||
247aba10 VZ |
522 | {\large {\bf File related classes}} |
523 | ||
fc2171bd | 524 | wxWidgets has several small classes to work with disk files, see \helpref{file classes |
247aba10 VZ |
525 | overview}{wxfileoverview} for more details. |
526 | ||
1c0c339c | 527 | \twocolwidtha{6cm} |
247aba10 | 528 | \begin{twocollist}\itemsep=0pt |
2569938d | 529 | \twocolitem{\helpref{wxFileName}{wxfilename}}{Operations with the file name and attributes} |
4afd7529 | 530 | \twocolitem{\helpref{wxDir}{wxdir}}{Class for enumerating files/subdirectories.} |
509cd921 | 531 | \twocolitem{\helpref{wxDirTraverser}{wxdirtraverser}}{Class used together with wxDir for recursively enumerating the files/subdirectories} |
842d6c94 RR |
532 | \twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output class.} |
533 | \twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.} | |
247aba10 VZ |
534 | \twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file} |
535 | \twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines} | |
a8d08dbd | 536 | \twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories} |
247aba10 VZ |
537 | \end{twocollist} |
538 | ||
631f1bfe JS |
539 | {\large {\bf Stream classes}} |
540 | ||
fc2171bd | 541 | wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream |
631f1bfe JS |
542 | libraries, and to provide enhanced functionality. |
543 | ||
1c0c339c | 544 | \twocolwidtha{6cm} |
631f1bfe JS |
545 | \begin{twocollist}\itemsep=0pt |
546 | \twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class} | |
547 | \twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class} | |
548 | \twocolitem{\helpref{wxInputStream}{wxinputstream}}{Input stream class} | |
549 | \twocolitem{\helpref{wxOutputStream}{wxoutputstream}}{Output stream class} | |
d984207c | 550 | \twocolitem{\helpref{wxCountingOutputStream}{wxcountingoutputstream}}{Stream class for querying what size a stream would have.} |
631f1bfe JS |
551 | \twocolitem{\helpref{wxFilterInputStream}{wxfilterinputstream}}{Filtered input stream class} |
552 | \twocolitem{\helpref{wxFilterOutputStream}{wxfilteroutputstream}}{Filtered output stream class} | |
d984207c RR |
553 | \twocolitem{\helpref{wxBufferedInputStream}{wxbufferedinputstream}}{Buffered input stream class} |
554 | \twocolitem{\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}}{Buffered output stream class} | |
2bf8e4eb RR |
555 | \twocolitem{\helpref{wxMemoryInputStream}{wxmeminputstream}}{Memory input stream class} |
556 | \twocolitem{\helpref{wxMemoryOutputStream}{wxmemoutputstream}}{Memory output stream class} | |
7ff14117 RR |
557 | \twocolitem{\helpref{wxDataInputStream}{wxdatainputstream}}{Platform-independent binary data input stream class} |
558 | \twocolitem{\helpref{wxDataOutputStream}{wxdataoutputstream}}{Platform-independent binary data output stream class} | |
559 | \twocolitem{\helpref{wxTextInputStream}{wxtextinputstream}}{Platform-independent text data input stream class} | |
560 | \twocolitem{\helpref{wxTextOutputStream}{wxtextoutputstream}}{Platform-independent text data output stream class} | |
631f1bfe JS |
561 | \twocolitem{\helpref{wxFileInputStream}{wxfileinputstream}}{File input stream class} |
562 | \twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class} | |
842d6c94 RR |
563 | \twocolitem{\helpref{wxFFileInputStream}{wxffileinputstream}}{Another file input stream class} |
564 | \twocolitem{\helpref{wxFFileOutputStream}{wxffileoutputstream}}{Another file output stream class} | |
e1265174 | 565 | \twocolitem{\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}}{Stream to safely replace an existing file} |
121fa06a VZ |
566 | \twocolitem{\helpref{wxStringInputStream}{wxstringinputstream}}{String input stream class} |
567 | \twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class} | |
b34c7f3c MW |
568 | \twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib and gzip (compression) input stream class} |
569 | \twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib and gzip (compression) output stream class} | |
738bfca9 | 570 | \twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives} |
df467a9d | 571 | \twocolitem{\helpref{wxZipOutputStream}{wxzipoutputstream}}{Output stream for writing from ZIP archives} |
b34c7f3c MW |
572 | \twocolitem{\helpref{wxTarInputStream}{wxtarinputstream}}{Input stream for reading from tar archives} |
573 | \twocolitem{\helpref{wxTarOutputStream}{wxtaroutputstream}}{Output stream for writing from tar archives} | |
631f1bfe JS |
574 | \twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class} |
575 | \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class} | |
576 | \end{twocollist} | |
577 | ||
238ddd26 RR |
578 | {\large {\bf Threading classes}} |
579 | ||
580 | \overview{Multithreading overview}{wxthreadoverview} | |
738bfca9 | 581 | |
fc2171bd | 582 | wxWidgets provides a set of classes to make use of the native thread |
238ddd26 RR |
583 | capabilities of the various platforms. |
584 | ||
1c0c339c | 585 | \twocolwidtha{6cm} |
238ddd26 RR |
586 | \begin{twocollist}\itemsep=0pt |
587 | \twocolitem{\helpref{wxThread}{wxthread}}{Thread class} | |
78ee6a47 | 588 | \twocolitem{\helpref{wxThreadHelper}{wxthreadhelper}}{Manages background threads easily} |
238ddd26 RR |
589 | \twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class} |
590 | \twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class} | |
591 | \twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class} | |
f6bcfd97 | 592 | \twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class} |
88413fec | 593 | \twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class} |
be809868 | 594 | \twocolitem{\helpref{wxSemaphore}{wxsemaphore}}{Semaphore class} |
238ddd26 RR |
595 | \end{twocollist} |
596 | ||
597 | {\large {\bf HTML classes}} | |
598 | ||
fc2171bd | 599 | wxWidgets provides a set of classes to display text in HTML format. These |
238ddd26 | 600 | class include a help system based on the HTML widget. |
738bfca9 | 601 | |
1c0c339c | 602 | \twocolwidtha{6cm} |
738bfca9 VS |
603 | \begin{twocollist}\itemsep=0pt |
604 | \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class} | |
605 | \twocolitem{\helpref{wxHtmlWindow}{wxhtmlwindow}}{HTML window class} | |
e5436d59 VS |
606 | \twocolitem{\helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}}{Simple class for printing HTML} |
607 | \twocolitem{\helpref{wxHtmlPrintout}{wxhtmlprintout}}{Generic HTML wxPrintout class} | |
738bfca9 VS |
608 | \twocolitem{\helpref{wxHtmlParser}{wxhtmlparser}}{Generic HTML parser class} |
609 | \twocolitem{\helpref{wxHtmlTagHandler}{wxhtmltaghandler}}{HTML tag handler, pluginable into wxHtmlParser} | |
610 | \twocolitem{\helpref{wxHtmlWinParser}{wxhtmlwinparser}}{HTML parser class for wxHtmlWindow} | |
611 | \twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser} | |
612 | \end{twocollist} | |
613 | ||
4aeaf419 JS |
614 | {\large {\bf Rich text classes}} |
615 | ||
616 | wxWidgets provides a set of generic classes to edit and print simple rich text with character | |
617 | and paragraph formatting. | |
618 | ||
619 | \twocolwidtha{6cm} | |
620 | \begin{twocollist}\itemsep=0pt | |
621 | \twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{A rich text control.} | |
622 | \twocolitem{\helpref{wxRichTextBuffer}{wxrichtextbuffer}}{The content of a rich text control.} | |
4aeaf419 JS |
623 | \twocolitem{\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.} |
624 | \twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.} | |
625 | \twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.} | |
626 | \twocolitem{\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}}{A set of style definitions.} | |
627 | \twocolitem{\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}}{A drop-down control for applying styles.} | |
628 | \twocolitem{\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}}{A listbox for applying styles.} | |
21fae46d | 629 | \twocolitem{\helpref{wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialog}}{A dialog that can be used for managing or browsing styles.} |
4aeaf419 JS |
630 | \twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text event.} |
631 | \twocolitem{\helpref{wxRichTextRange}{wxrichtextrange}}{Specification for ranges in a rich text control or buffer.} | |
632 | \twocolitem{\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}}{File handler base class.} | |
633 | \twocolitem{\helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}}{A handler for converting rich text to HTML.} | |
634 | \twocolitem{\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler}}{A handler for loading and saving rich text XML.} | |
635 | \twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for rich text formatting.} | |
636 | \twocolitem{\helpref{wxRichTextPrinting}{wxrichtextprinting}}{A class for easy printing of rich text buffers.} | |
637 | \twocolitem{\helpref{wxRichTextPrintout}{wxrichtextprintout}}{A class used by wxRichTextPrinting.} | |
638 | \twocolitem{\helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata}}{Header and footer data specification.} | |
639 | \end{twocollist} | |
640 | ||
88413fec RR |
641 | {\large {\bf Virtual file system classes}} |
642 | ||
fc2171bd | 643 | wxWidgets provides a set of classes that implement an extensible virtual file system, |
88413fec RR |
644 | used internally by the HTML classes. |
645 | ||
1c0c339c | 646 | \twocolwidtha{6cm} |
88413fec RR |
647 | \begin{twocollist}\itemsep=0pt |
648 | \twocolitem{\helpref{wxFSFile}{wxfsfile}}{Represents a file in the virtual file system} | |
649 | \twocolitem{\helpref{wxFileSystem}{wxfilesystem}}{Main interface for the virtual file system} | |
650 | \twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type} | |
651 | \end{twocollist} | |
652 | ||
3193b86f VZ |
653 | {\large {\bf XML classes}} |
654 | ||
655 | \twocolwidtha{6cm} | |
656 | \begin{twocollist}\itemsep=0pt | |
44f2a3d1 RR |
657 | \twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files} |
658 | \twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes} | |
659 | \twocolitem{\helpref{wxXmlAttribute}{wxxmlattribute}}{A class which represent an XML attribute} | |
3193b86f VZ |
660 | \end{twocollist} |
661 | ||
d958c9bd JS |
662 | {\large {\bf XML-based resource system classes}} |
663 | ||
3980000c | 664 | \overview{XML-based resource system (XRC) overview}{xrcoverview} |
d958c9bd JS |
665 | |
666 | Resources allow your application to create controls and other user interface elements | |
667 | from specifications stored in an XML format. | |
668 | ||
1c0c339c | 669 | \twocolwidtha{6cm} |
d958c9bd | 670 | \begin{twocollist}\itemsep=0pt |
44f2a3d1 RR |
671 | \twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources} |
672 | \twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers} | |
d958c9bd JS |
673 | \end{twocollist} |
674 | ||
7cb74906 JS |
675 | {\large {\bf Online help}} |
676 | ||
1c0c339c | 677 | \twocolwidtha{6cm} |
7cb74906 JS |
678 | \begin{twocollist}\itemsep=0pt |
679 | \twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows} | |
680 | \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class} | |
681 | \twocolitem{\helpref{wxContextHelp}{wxcontexthelp}}{Class to put application into context-sensitive help mode} | |
682 | \twocolitem{\helpref{wxContextHelpButton}{wxcontexthelpbutton}}{Button class for putting application into context-sensitive help mode} | |
683 | \twocolitem{\helpref{wxHelpProvider}{wxhelpprovider}}{Abstract class for context-sensitive help provision} | |
684 | \twocolitem{\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}}{Class for simple context-sensitive help provision} | |
685 | \twocolitem{\helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}}{Class for context-sensitive help provision via a help controller} | |
686 | \twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips} | |
687 | \end{twocollist} | |
688 | ||
a660d684 KB |
689 | {\large {\bf Miscellaneous}} |
690 | ||
1c0c339c | 691 | \twocolwidtha{6cm} |
a660d684 KB |
692 | \begin{twocollist}\itemsep=0pt |
693 | \twocolitem{\helpref{wxApp}{wxapp}}{Application class} | |
f6bcfd97 BP |
694 | \twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object} |
695 | \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class} | |
696 | \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)} | |
697 | \twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.} | |
43e8916f MW |
698 | \twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.} |
699 | \twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.} | |
6fb26ea3 | 700 | \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} |
3972fb49 | 701 | \twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} |
a660d684 | 702 | \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} |
5f445b31 | 703 | \twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class} |
88413fec | 704 | \twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class} |
0cbff120 JS |
705 | \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class for obtaining various global parameters} |
706 | \twocolitem{\helpref{wxSystemOptions}{wxsystemoptions}}{System options class for run-time configuration} | |
238ddd26 RR |
707 | \twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table} |
708 | \twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class} | |
5d9dba5b VS |
709 | \twocolitem{\helpref{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding} |
710 | \twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions} | |
f6bcfd97 | 711 | \twocolitem{\helpref{wxCalendarDateAttr}{wxcalendardateattr}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} |
e3c10211 | 712 | \twocolitem{\helpref{wxQuantize}{wxquantize}}{Class to perform quantization, or colour reduction} |
68a602fc | 713 | \twocolitem{\helpref{wxSingleInstanceChecker}{wxsingleinstancechecker}}{Check that only single program instance is running} |
238ddd26 | 714 | \end{twocollist} |