X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0cbff1201aa47e2b73ec90a97886f18e88270ea6..75d9e502238df95fa53c0030b1fac0d4f43e4025:/docs/latex/wx/category.tex?ds=inline diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index afe09140fa..5607a41c74 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -2,24 +2,26 @@ \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage}% -A classification of wxWindows classes by category. -\twocolwidtha{5cm} +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)} +%\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog +%(deprecated, use wxNotebook instead)} \twocolitem{\helpref{wxTipWindow}{wxtipwindow}}{Shows text in a small window} \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog} \end{twocollist} @@ -30,6 +32,7 @@ See also {\bf Common dialogs}. The following are a variety of classes that are derived from wxWindow. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings} \twocolitem{\helpref{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars} @@ -39,9 +42,12 @@ The following are a variety of classes that are derived from wxWindow. \twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class} %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} \twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} -\twocolitem{\helpref{wxPlotWindow}{wxplotwindow}}{A class to display data.} +\twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control} +\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} \twocolitem{\helpref{wxWizardPage}{wxwizardpage}}{A base class for the page in wizard dialog.} \twocolitem{\helpref{wxWizardPageSimple}{wxwizardpagesimple}}{A page in wizard dialog.} \end{twocollist} @@ -53,19 +59,24 @@ The following are a variety of classes that are derived from wxWindow. Common dialogs are ready-made dialog classes which are frequently used in an application. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDialog}{wxdialog}}{Base class for common dialogs} \twocolitem{\helpref{wxColourDialog}{wxcolourdialog}}{Colour chooser dialog} \twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog} \twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog} -\twocolitem{\helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}}{Dialog to get one or more selections from a list} +\twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog} +\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} @@ -74,63 +85,112 @@ in an application. Typically, these are small windows which provide interaction with the user. Controls that are not static can have \helpref{validators}{wxvalidator} associated with them. +\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{wxCalendarCtrl}{wxcalendarctrl}}{Date picker control} +\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}}{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}}{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{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} \twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user} +\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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxMenu}{wxmenu}}{Displays a series of menu items for selection} \twocolitem{\helpref{wxMenuBar}{wxmenubar}}{Contains a series of menus for use with a frame} \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 layouting windows (and dialogs in particular). +There are two different systems for laying out windows (and dialogs in particular). One is based upon so-called sizers and it requires less typing, thinking and calculating and will in almost all cases produce dialogs looking equally well on all platforms, the -other is based on so-called constraints and allows for more detailed layouts. +other is based on so-called constraints and is deprecated, though still available. -These are the classes relevant to the sizer-based layout. +\overview{Sizer overview}{sizeroverview} describes sizer-based layout. +These are the classes relevant to sizer-based layout. + +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class} \twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size} \twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid} +\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 surrounding static box} -\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control.} +\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box} \end{twocollist} -\overview{Overview}{constraintsoverview} over the constraints-based layout. +\overview{Constraints overview}{constraintsoverview} describes constraints-based layout. These are the classes relevant to constraints-based window layout. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension} \twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class} @@ -144,7 +204,11 @@ Device contexts are surfaces that may be drawn on, and provide an abstraction that allows parameterisation of your drawing code 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} @@ -152,6 +216,7 @@ by passing different device contexts. \twocolitem{\helpref{wxDC}{wxdc}}{The device context base class} \twocolitem{\helpref{wxMemoryDC}{wxmemorydc}}{A device context for drawing into bitmaps} \twocolitem{\helpref{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles} +\twocolitem{\helpref{wxMirrorDC}{wxmirrordc}}{A proxy device context allowing for simple mirroring.} \twocolitem{\helpref{wxPostScriptDC}{wxpostscriptdc}}{A device context for drawing into PostScript files} \twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{A device context for drawing to printers} \end{twocollist} @@ -162,6 +227,7 @@ by passing different device contexts. These classes are related to drawing on device contexts and windows. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour} \twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region} @@ -179,6 +245,7 @@ These classes are related to drawing on device contexts and windows. \twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens} \twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values} \twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context} +\twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives} \end{twocollist} {\large {\bf Events}} @@ -188,16 +255,23 @@ These classes are related to drawing on device contexts and windows. An event object contains information about a specific event. Event handlers (usually member functions) have a single, event argument. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \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} \twocolitem{\helpref{wxEvent}{wxevent}}{The event base class} +\twocolitem{\helpref{wxFindDialogEvent}{wxfinddialogevent}}{Event sent by +\helpref{wxFindReplaceDialog}{wxfindreplacedialog}} \twocolitem{\helpref{wxFocusEvent}{wxfocusevent}}{A window focus event} \twocolitem{\helpref{wxKeyEvent}{wxkeyevent}}{A keypress event} \twocolitem{\helpref{wxIconizeEvent}{wxiconizeevent}}{An iconize/restore event} @@ -207,6 +281,8 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event} \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{wxNotebookEvent}{wxnotebookevent}}{A notebook control event} @@ -214,15 +290,20 @@ An event object contains information about a specific event. Event handlers \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} @@ -233,6 +314,7 @@ An event object contains information about a specific event. Event handlers These are the window validators, used for filtering and validating user input. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class} \twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class} @@ -241,32 +323,36 @@ 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{wxDate}{wxdate}}{A class for date manipulation (deprecated in favour of wxDateTime)} \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{wxHashTable}{wxhashtable}}{A simple hash table implementation} +%\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O} +%\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O} +\twocolitem{\helpref{wxArray}{wxarray}}{A dynamic array implementation} +\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects} +\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A simple hash map implementation} +\twocolitem{\helpref{wxHashSet}{wxhashset}}{A simple hash set 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{wxTime}{wxtime}}{A class for time manipulation (deprecated in favour of wxDateTime)} \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} @@ -274,42 +360,67 @@ These are the data structure classes supported by wxWindows. \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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxClassInfo}{wxclassinfo}}{Holds run-time class information} \twocolitem{\helpref{wxObject}{wxobject}}{Root class for classes with run-time information} -\twocolitem{\helpref{Macros}{macros}}{Macros for manipulating run-time information} +\twocolitem{\helpref{RTTI macros}{rttimacros}}{Macros for manipulating run-time information} +\end{twocollist} + +{\large {\bf Logging features}} + +\overview{Overview}{wxlogoverview} + +wxWidgets provides several classes and functions for message logging. +Please see the \helpref{wxLog overview}{wxlogoverview} for more details. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxLog}{wxlog}}{The base log class} +\twocolitem{\helpref{wxLogStderr}{wxlogstderr}}{Log messages to a C STDIO stream} +\twocolitem{\helpref{wxLogStream}{wxlogstream}}{Log messages to a C++ iostream} +\twocolitem{\helpref{wxLogTextCtrl}{wxlogtextctrl}}{Log messages to a \helpref{wxTextCtrl}{wxtextctrl}} +\twocolitem{\helpref{wxLogWindow}{wxlogwindow}}{Log messages to a log frame} +\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{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} \end{twocollist} {\large {\bf Debugging features}} \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{wxLog}{wxlog}}{Logging facility} -\twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions} \twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking} -%\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility} -%\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels} \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 \twocolitem{\helpref{wxDialUpManager}{wxdialupmanager}}{Provides functions to check the status of network connection and to establish one} \twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet address} +\twocolitem{\helpref{wxIPaddress}{wxipaddress}}{Represents an Internet address} \twocolitem{\helpref{wxSocketBase}{wxsocketbase}}{Represents a socket base object} \twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client} \twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} @@ -324,16 +435,14 @@ wxWindows provides its own classes for socket based networking. \overview{Overview}{ipcoverview} -wxWindows provides a simple interprocess communications facilities -based on DDE. +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{wxDDEClient}{wxddeclient}}{Represents a client} -\twocolitem{\helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server} -\twocolitem{\helpref{wxDDEServer}{wxddeserver}}{Represents a server} -\twocolitem{\helpref{wxTCPClient}{wxtcpclient}}{Represents a client} -\twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server} -\twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{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} @@ -341,9 +450,10 @@ based on DDE. \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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document} \twocolitem{\helpref{wxView}{wxview}}{Represents a view} @@ -363,6 +473,7 @@ A printing and previewing framework is implemented to make it relatively straightforward to provide document printing facilities. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview} \twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview} @@ -382,12 +493,14 @@ facilities. \overview{Drag and drop and clipboard overview}{wxdndoverview} +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \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} @@ -398,23 +511,27 @@ 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} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxFileName}{wxfilename}}{Operations with the file name and attributes} \twocolitem{\helpref{wxDir}{wxdir}}{Class for enumerating files/subdirectories.} \twocolitem{\helpref{wxDirTraverser}{wxdirtraverser}}{Class used together with wxDir for recursively enumerating the files/subdirectories} \twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output class.} \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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class} \twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class} @@ -435,9 +552,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} @@ -446,23 +569,27 @@ 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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxThread}{wxthread}}{Thread class} +\twocolitem{\helpref{wxThreadHelper}{wxthreadhelper}}{Manages background threads easily} \twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class} \twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class} \twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class} \twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class} \twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class} +\twocolitem{\helpref{wxSemaphore}{wxsemaphore}}{Semaphore class} \end{twocollist} {\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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class} \twocolitem{\helpref{wxHtmlWindow}{wxhtmlwindow}}{HTML window class} @@ -474,19 +601,71 @@ 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{wxRichTextAttr}{wxrichtextattr}}{Attributes specifying rich text styling.} +\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} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxFSFile}{wxfsfile}}{Represents a file in the virtual file system} \twocolitem{\helpref{wxFileSystem}{wxfilesystem}}{Main interface for the virtual file system} \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{wxXmlProperty}{wxxmlproperty}}{A class which represents XML properties.} +\end{twocollist} + +{\large {\bf XML-based resource system classes}} + +\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.} +\end{twocollist} + {\large {\bf Online help}} +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows} \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class} @@ -502,11 +681,10 @@ used internally by the HTML classes. \overview{Database classes overview}{odbcoverview} -wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity) -product. The new version by Remstar, known as wxODBC, is more powerful, -portable, flexible and better supported, so please use the classes below for -working with databases: +wxWidgets 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} @@ -520,24 +698,17 @@ working with databases: \twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{} \end{twocollist} -The documentation for the older classes is still included, but you should avoid -using any of them in the new programs: - -\begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class} -\twocolitem{\helpref{wxQueryCol}{wxquerycol}}{Class representing a column} -\twocolitem{\helpref{wxQueryField}{wxqueryfield}}{Class representing a field} -\twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record} -\end{twocollist} - {\large {\bf Miscellaneous}} +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxApp}{wxapp}}{Application class} \twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object} \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} @@ -553,4 +724,3 @@ using any of them in the new programs: \twocolitem{\helpref{wxQuantize}{wxquantize}}{Class to perform quantization, or colour reduction} \twocolitem{\helpref{wxSingleInstanceChecker}{wxsingleinstancechecker}}{Check that only single program instance is running} \end{twocollist} -