X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/be4bd4636d8e7e06ad5728ff1b398fbd0ab74d93..e815120e412d91e79c98dd0afac2a1e399f10810:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 5cc2615cc3..c2f872f32d 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -2,21 +2,23 @@ \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage}% -A classification of wxWindows classes by category. +A classification of wxWidgets classes by category. {\large {\bf Managed windows}} There are several types of window that are directly controlled by the window manager (such as MS Windows, or the Motif Window Manager). -Frames may contain windows, and dialog boxes may directly contain controls. +Frames and dialogs are similar in wxWidgets, but only dialogs may be modal. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxTopLevelWindow}{wxtoplevelwindow}}{Any top level window, dialog or frame} \twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box} \twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame} \twocolitem{\helpref{wxMDIChildFrame}{wxmdichildframe}}{MDI child frame} \twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent frame} \twocolitem{\helpref{wxMiniFrame}{wxminiframe}}{A frame with a small title bar} +\twocolitem{\helpref{wxPropertySheetDialog}{wxpropertysheetdialog}}{Property sheet dialog} \twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class} %\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog %(deprecated, use wxNotebook instead)} @@ -41,7 +43,8 @@ The following are a variety of classes that are derived from wxWindow. %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} \twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} \twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control} -\twocolitem{\helpref{wxPlotWindow}{wxplotwindow}}{A class to display data.} +\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control} +\twocolitem{\helpref{wxTreebook}{wxtreebook}}{Similar to notebook but using tree control} \twocolitem{\helpref{wxSashWindow}{wxsashwindow}}{Window with four optional sashes that can be dragged} \twocolitem{\helpref{wxSashLayoutWindow}{wxsashlayoutwindow}}{Window that can be involved in an IDE-like layout arrangement} \twocolitem{\helpref{wxVScrolledWindow}{wxvscrolledwindow}}{As wxScrolledWindow but supports lines of variable height} @@ -63,14 +66,17 @@ in an application. \twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog} \twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog} \twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog} -\twocolitem{\helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}}{Dialog to get one or more selections from a list} +\twocolitem{\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}}{Dialog to get one or more selections from a list} \twocolitem{\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}}{Dialog to get a single selection from a list and return the string} \twocolitem{\helpref{wxTextEntryDialog}{wxtextentrydialog}}{Dialog to get a single line of text from the user} +\twocolitem{\helpref{wxPasswordEntryDialog}{wxpasswordentrydialog}}{Dialog to get a password from the user} \twocolitem{\helpref{wxFontDialog}{wxfontdialog}}{Font chooser dialog} \twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} -\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} +\twocolitem{\helpref{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog} \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog} +\twocolitem{\helpref{wxSymbolPickerDialog}{wxsymbolpickerdialog}}{Symbol selector dialog} +\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for formatting the content of a wxRichTextCtrl} \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.} \end{twocollist} @@ -81,29 +87,36 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAnimationCtrl}{wxanimationctrl}}{A control to display an animation} \twocolitem{\helpref{wxControl}{wxcontrol}}{The base class for controls} \twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text} \twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap} +\twocolitem{\helpref{wxBitmapComboBox}{wxbitmapcombobox}}{A combobox with bitmaps next to text items} \twocolitem{\helpref{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.} -\twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Date picker control} +\twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Control showing an entire calendar month} \twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control} \twocolitem{\helpref{wxCheckListBox}{wxchecklistbox}}{A listbox with a checkbox to the left of each item} \twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)} \twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area} +\twocolitem{\helpref{wxComboCtrl}{wxcomboctrl}}{A combobox with application defined popup} +\twocolitem{\helpref{wxDataViewCtrl}{wxdataviewctrl}}{A control to tabular or tree like data} \twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining} \twocolitem{\helpref{wxGenericDirCtrl}{wxgenericdirctrl}}{A control for displaying a directory tree} -\twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{A listbox showing HTML content} +\twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{An abstract class for creating listboxes showing HTML content} +\twocolitem{\helpref{wxSimpleHtmlListBox}{wxsimplehtmllistbox}}{A listbox showing HTML content} \twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls} \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} -\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode} -\twocolitem{\helpref{wxTabCtrl}{wxtabctrl}}{Manages several tabs} +\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade}) for wxListCtrl in report mode} +\twocolitem{\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}}{A combobox with owner-drawn list items} +\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{Generic rich text editing control} \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control} \twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control} \twocolitem{\helpref{wxSpinCtrl}{wxspinctrl}}{A spin control - i.e. spin button and text control} \twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text} +\twocolitem{\helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}{A static text which opens an URL when clicked} \twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap} \twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons} \twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way} @@ -111,6 +124,21 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows} \end{twocollist} + +{\large {\bf Miscellaneous pickers}} + +A picker control is a control whose appearance and behaviour is highly platform-dependent. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}}{A control which allows the user to choose a colour} +\twocolitem{\helpref{wxDirPickerCtrl}{wxdirpickerctrl}}{A control which allows the user to choose a directory} +\twocolitem{\helpref{wxFilePickerCtrl}{wxfilepickerctrl}}{A control which allows the user to choose a file} +\twocolitem{\helpref{wxFontPickerCtrl}{wxfontpickerctrl}}{A control which allows the user to choose a font} +\twocolitem{\helpref{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control} +\end{twocollist} + + {\large {\bf Menus}} \twocolwidtha{6cm} @@ -120,6 +148,23 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxMenuItem}{wxmenuitem}}{Represents a single menu item} \end{twocollist} +{\large {\bf wxAUI - advanced user interface}} + +This is a new set of classes for writing a customizable application +interface with built-in docking, floatable panes and a flexible +MDI-like interface. Further classes for custom notebooks with +draggable tabs etc. are in progress. See also \helpref{wxAUI overview}{wxauioverview}. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAuiManager}{wxauimanager}}{The central class for managing the interface} +\twocolitem{\helpref{wxAuiNotebook}{wxauinotebook}}{A replacement notebook class with extra features} +\twocolitem{\helpref{wxAuiPaneInfo}{wxauipaneinfo}}{Describes a single pane} +\twocolitem{\helpref{wxAuiDockArt}{wxauidockart}}{Art and metrics provider for customizing the docking user interface} +\twocolitem{\helpref{wxAuiTabArt}{wxauitabart}}{Art and metrics provider for customizing the notebook user interface} +\end{twocollist} + + {\large {\bf Window layout}} There are two different systems for laying out windows (and dialogs in particular). @@ -139,7 +184,6 @@ These are the classes relevant to sizer-based layout. \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.} \twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column} \twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box} -\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control} \end{twocollist} \overview{Constraints overview}{constraintsoverview} describes constraints-based layout. @@ -162,6 +206,9 @@ by passing different device contexts. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAutoBufferedPaintDC}{wxautobufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.} +\twocolitem{\helpref{wxBufferedDC}{wxbuffereddc}}{A helper device context for double buffered drawing.} +\twocolitem{\helpref{wxBufferedPaintDC}{wxbufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.} \twocolitem{\helpref{wxClientDC}{wxclientdc}}{A device context to access the client area outside {\bf OnPaint} events} \twocolitem{\helpref{wxPaintDC}{wxpaintdc}}{A device context to access the client area inside {\bf OnPaint} events} \twocolitem{\helpref{wxWindowDC}{wxwindowdc}}{A device context to access the non-client area} @@ -213,8 +260,12 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event} \twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} \twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout} +\twocolitem{\helpref{wxChildFocusEvent}{wxchildfocusevent}}{A child window focus event} +\twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event} \twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event} \twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls} +\twocolitem{\helpref{wxContextMenuEvent}{wxcontextmenuevent}}{An event generated when the user issues a context menu command} +\twocolitem{\helpref{wxDateEvent}{wxdateevent}}{Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}} \twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}} \twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event} \twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event} @@ -231,22 +282,29 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event} \twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event} \twocolitem{\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}}{A mouse capture changed event} +\twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event} \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event} \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event} +\twocolitem{\helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}}{An event set by navigation keys such as tab} \twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event} \twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed} \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event} \twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} \twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information} +\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event} \twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons} \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows} \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event} \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event} \twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}} +\twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{An event from \helpref{wxSplitterWindow}{wxsplitterwindow}} \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} -\twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event} +\twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event} +\twocolitem{\helpref{wxTreebookEvent}{wxtreebookevent}}{A treebook control event} \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} +\twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event} +\twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event} \twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event} \end{twocollist} @@ -266,41 +324,52 @@ user input. {\large {\bf Data structures}} -These are the data structure classes supported by wxWindows. +These are the data structure classes supported by wxWidgets. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class} \twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.} \twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations} -\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O} -\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O} -\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A simple hash map implementation} -\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)} -% \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data} -\twocolitem{\helpref{wxList}{wxlist}}{A simple linked list implementation} \twocolitem{\helpref{wxLongLong}{wxlonglong}}{A portable 64 bit integer type} -\twocolitem{\helpref{wxNode}{wxnode}}{Represents a node in the wxList implementation} -\twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWindows classes} +\twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWidgets classes} \twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths} \twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point} \twocolitem{\helpref{wxRect}{wxrect}}{A class representing a rectangle} \twocolitem{\helpref{wxRegEx}{wxregex}}{Regular expression support} \twocolitem{\helpref{wxRegion}{wxregion}}{A class representing a region} \twocolitem{\helpref{wxString}{wxstring}}{A string class} -\twocolitem{\helpref{wxStringList}{wxstringlist}}{A class representing a list of strings} \twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words} \twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers} \twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size} \twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.} +\twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier} \twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time} \end{twocollist} +{\large {\bf Container classes}} + +\overview{Overview}{wxcontaineroverview} + +These are classes, templates and class macros are used by wxWidgets. Most +of these classes provide a subset or almost complete STL API. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxArray}{wxarray}}{A type-safe dynamic array implementation (macro based)} +\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects} +\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A type-safe hash map implementation (macro based)} +\twocolitem{\helpref{wxHashSet}{wxhashset}}{A type-safe hash set implementation(macro based)} +\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)} +\twocolitem{\helpref{wxList}{wxlist}}{A type-safe linked list implementation (macro based)} +\twocolitem{\helpref{wxVector}{wxvector}}{Template base vector implementation} +\end{twocollist} + {\large {\bf Run-time class information system}} \overview{Overview}{runtimeclassoverview} -wxWindows supports run-time manipulation of class information, and dynamic +wxWidgets supports run-time manipulation of class information, and dynamic creation of objects given class names. \twocolwidtha{6cm} @@ -314,7 +383,7 @@ creation of objects given class names. \overview{Overview}{wxlogoverview} -wxWindows provides several classes and functions for message logging. +wxWidgets provides several classes and functions for message logging. Please see the \helpref{wxLog overview}{wxlogoverview} for more details. \twocolwidtha{6cm} @@ -327,7 +396,8 @@ Please see the \helpref{wxLog overview}{wxlogoverview} for more details. \twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs} \twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging} \twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets} -\twocolitem{\helpref{wxLogPassThrough}{wxlogpassthrough}}{Allows to filter the log messages} +\twocolitem{\helpref{wxLogInterposer}{wxloginterposer}}{Allows to filter the log messages} +\twocolitem{\helpref{wxLogInterposerTemp}{wxloginterposertemp}}{Allows to filter the log messages} \twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}} \twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions} @@ -337,22 +407,24 @@ to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}} \overview{Overview}{debuggingoverview} -wxWindows supports some aspects of debugging an application through +wxWidgets supports some aspects of debugging an application through classes, functions and macros. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities} -%\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream} \twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking} \twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information} -%\twocolitem{\helpref{WXTRACE}{trace}}{Trace macro} -%\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels} +\twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.} +\twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.} +\twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.} +\twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.} +\twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.} \end{twocollist} {\large {\bf Networking classes}} -wxWindows provides its own classes for socket based networking. +wxWidgets provides its own classes for socket based networking. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt @@ -373,14 +445,14 @@ wxWindows provides its own classes for socket based networking. \overview{Overview}{ipcoverview} -wxWindows provides simple interprocess communications facilities +wxWidgets provides simple interprocess communications facilities based on Windows DDE, but available on most platforms using TCP. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxClient}{wxddeclient}}{Represents a client} -\twocolitem{\helpref{wxConnection}{wxddeconnection}}{Represents the connection between a client and a server} -\twocolitem{\helpref{wxServer}{wxddeserver}}{Represents a server} +\twocolitem{\helpref{wxClient}{wxclient}, \helpref{wxDDEClient}{wxddeclient}}{Represents a client} +\twocolitem{\helpref{wxConnection}{wxconnection}, \helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server} +\twocolitem{\helpref{wxServer}{wxserver}, \helpref{wxDDEServer}{wxddeserver}}{Represents a server} %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} \end{twocollist} @@ -388,7 +460,7 @@ based on Windows DDE, but available on most platforms using TCP. \overview{Overview}{docviewoverview} -wxWindows supports a document/view framework which provides +wxWidgets supports a document/view framework which provides housekeeping for a document-centric application. \twocolwidtha{6cm} @@ -436,8 +508,9 @@ facilities. \twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class} \twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format} \twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class} -\twocolitem{\helpref{wxFileDataObject}{wxtextdataobject}}{File data object class} +\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class} \twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class} +\twocolitem{\helpref{wxURLDataObject}{wxurldataobject}}{URL data object class} \twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class} \twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class} \twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class} @@ -448,7 +521,7 @@ facilities. {\large {\bf File related classes}} -wxWindows has several small classes to work with disk files, see \helpref{file classes +wxWidgets has several small classes to work with disk files, see \helpref{file classes overview}{wxfileoverview} for more details. \twocolwidtha{6cm} @@ -460,11 +533,12 @@ overview}{wxfileoverview} for more details. \twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.} \twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file} \twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines} +\twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories} \end{twocollist} {\large {\bf Stream classes}} -wxWindows has its own set of stream classes, as an alternative to often buggy standard stream +wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream libraries, and to provide enhanced functionality. \twocolwidtha{6cm} @@ -488,9 +562,15 @@ libraries, and to provide enhanced functionality. \twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class} \twocolitem{\helpref{wxFFileInputStream}{wxffileinputstream}}{Another file input stream class} \twocolitem{\helpref{wxFFileOutputStream}{wxffileoutputstream}}{Another file output stream class} -\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib (compression) input stream class} -\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (compression) output stream class} +\twocolitem{\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}}{Stream to safely replace an existing file} +\twocolitem{\helpref{wxStringInputStream}{wxstringinputstream}}{String input stream class} +\twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class} +\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib and gzip (compression) input stream class} +\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib and gzip (compression) output stream class} \twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives} +\twocolitem{\helpref{wxZipOutputStream}{wxzipoutputstream}}{Output stream for writing from ZIP archives} +\twocolitem{\helpref{wxTarInputStream}{wxtarinputstream}}{Input stream for reading from tar archives} +\twocolitem{\helpref{wxTarOutputStream}{wxtaroutputstream}}{Output stream for writing from tar archives} \twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class} \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class} \end{twocollist} @@ -499,7 +579,7 @@ libraries, and to provide enhanced functionality. \overview{Multithreading overview}{wxthreadoverview} -wxWindows provides a set of classes to make use of the native thread +wxWidgets provides a set of classes to make use of the native thread capabilities of the various platforms. \twocolwidtha{6cm} @@ -516,7 +596,7 @@ capabilities of the various platforms. {\large {\bf HTML classes}} -wxWindows provides a set of classes to display text in HTML format. These +wxWidgets provides a set of classes to display text in HTML format. These class include a help system based on the HTML widget. \twocolwidtha{6cm} @@ -531,9 +611,36 @@ class include a help system based on the HTML widget. \twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser} \end{twocollist} +{\large {\bf Rich text classes}} + +wxWidgets provides a set of generic classes to edit and print simple rich text with character +and paragraph formatting. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{A rich text control.} +\twocolitem{\helpref{wxRichTextBuffer}{wxrichtextbuffer}}{The content of a rich text control.} +\twocolitem{\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.} +\twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.} +\twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.} +\twocolitem{\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}}{A set of style definitions.} +\twocolitem{\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}}{A drop-down control for applying styles.} +\twocolitem{\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}}{A listbox for applying styles.} +\twocolitem{\helpref{wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialog}}{A dialog that can be used for managing or browsing styles.} +\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text event.} +\twocolitem{\helpref{wxRichTextRange}{wxrichtextrange}}{Specification for ranges in a rich text control or buffer.} +\twocolitem{\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}}{File handler base class.} +\twocolitem{\helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}}{A handler for converting rich text to HTML.} +\twocolitem{\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler}}{A handler for loading and saving rich text XML.} +\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for rich text formatting.} +\twocolitem{\helpref{wxRichTextPrinting}{wxrichtextprinting}}{A class for easy printing of rich text buffers.} +\twocolitem{\helpref{wxRichTextPrintout}{wxrichtextprintout}}{A class used by wxRichTextPrinting.} +\twocolitem{\helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata}}{Header and footer data specification.} +\end{twocollist} + {\large {\bf Virtual file system classes}} -wxWindows provides a set of classes that implement an extensible virtual file system, +wxWidgets provides a set of classes that implement an extensible virtual file system, used internally by the HTML classes. \twocolwidtha{6cm} @@ -543,17 +650,26 @@ used internally by the HTML classes. \twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type} \end{twocollist} +{\large {\bf XML classes}} + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files} +\twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes} +\twocolitem{\helpref{wxXmlAttribute}{wxxmlattribute}}{A class which represent an XML attribute} +\end{twocollist} + {\large {\bf XML-based resource system classes}} -\overview{XML-based resource system overview}{xrcoverview} +\overview{XML-based resource system (XRC) overview}{xrcoverview} Resources allow your application to create controls and other user interface elements from specifications stored in an XML format. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources.} -\twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers.} +\twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources} +\twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers} \end{twocollist} {\large {\bf Online help}} @@ -570,27 +686,6 @@ from specifications stored in an XML format. \twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips} \end{twocollist} -{\large {\bf Database classes}} - -\overview{Database classes overview}{odbcoverview} - -wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity) -product, donated by Remstar. This is known as wxODBC. - -\twocolwidtha{6cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxDb}{wxdb}}{ODBC database connection} -\twocolitem{\helpref{wxDbTable}{wxdbtable}}{Provides access to a database table} -\twocolitem{\helpref{wxDbInf}{wxdbinf}}{} -\twocolitem{\helpref{wxDbTableInf}{wxdbtableinf}}{} -\twocolitem{\helpref{wxDbColDef}{wxdbcoldef}}{} -\twocolitem{\helpref{wxDbColInf}{wxdbcolinf}}{} -\twocolitem{\helpref{wxDbColDataPtr}{wxdbcoldataptr}}{} -\twocolitem{\helpref{wxDbColFor}{wxdbcolfor}}{} -\twocolitem{\helpref{wxDbConnectInf}{wxdbconnectinf}}{} -\twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{} -\end{twocollist} - {\large {\bf Miscellaneous}} \twocolwidtha{6cm} @@ -600,6 +695,8 @@ product, donated by Remstar. This is known as wxODBC. \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class} \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)} \twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.} +\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.} +\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.} \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} \twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}