X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/88413fec06d896eb4499b7e2ecf7940b15ea9175..5230934a95bf9b3112ec2a7e070e8cbb4cea7f55:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 0165609898..a3d8afe9a2 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -3,7 +3,6 @@ \setfooter{\thepage}{}{}{}{}{\thepage}% A classification of wxWindows classes by category. -\twocolwidtha{5cm} {\large {\bf Managed windows}} @@ -11,32 +10,41 @@ 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. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box} \twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame} -\twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent 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{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog} +\twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class} +%\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} See also {\bf Common dialogs}. {\large {\bf Miscellaneous windows}} -The following are a variety of windows that are derived from wxWindow. +The following are a variety of classes that are derived from wxWindow. +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window} \twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings} -\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{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars} +\twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window} \twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally} \twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame} \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{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{wxWizardPage}{wxwizardpage}}{A base class for the page in wizard dialog.} +\twocolitem{\helpref{wxWizardPageSimple}{wxwizardpagesimple}}{A page in wizard dialog.} \end{twocollist} {\large {\bf Common dialogs}} @@ -46,11 +54,13 @@ The following are a variety of windows 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{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog} \twocolitem{\helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}}{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} @@ -59,6 +69,7 @@ in an application. \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} \twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog} +\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.} \end{twocollist} {\large {\bf Controls}} @@ -66,23 +77,28 @@ 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{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{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.} +\twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Date picker control} \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{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{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{wxTextCtrl}{wxtextctrl}}{Single or multline text editing control} -\twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierachy) 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{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap} \twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons} @@ -92,6 +108,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t {\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} @@ -100,24 +117,30 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t {\large {\bf Window layout}} -There are two different systems for layouting windows (and dialogs in particluar). +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{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} +\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control} \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} @@ -131,6 +154,7 @@ 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{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} @@ -149,8 +173,10 @@ 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} \twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap} \twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context} \twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes} @@ -174,20 +200,27 @@ 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{wxCloseEvent}{wxcloseevent}}{A close window or end session event} \twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls} +\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} \twocolitem{\helpref{wxIdleEvent}{wxidleevent}}{An idle event} \twocolitem{\helpref{wxInitDialogEvent}{wxinitdialogevent}}{A dialog initialisation event} \twocolitem{\helpref{wxJoystickEvent}{wxjoystickevent}}{A joystick event} \twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event} +\twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event} \twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event} \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event} \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event} @@ -200,10 +233,12 @@ An event object contains information about a specific event. Event handlers \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{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} \twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event} \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} +\twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event} \end{twocollist} {\large {\bf Validators}} @@ -213,6 +248,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} @@ -223,26 +259,34 @@ user input. These are the data structure classes supported by wxWindows. +\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{wxDate}{wxdate}}{A class for date manipulation} -\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation} +\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{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} -\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types -that may change at run-time} +\twocolitem{\helpref{wxTime}{wxtime}}{A class for time manipulation (deprecated in favour of wxDateTime)} +\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.} +\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time} \end{twocollist} {\large {\bf Run-time class information system}} @@ -252,6 +296,7 @@ that may change at run-time} wxWindows 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} @@ -260,19 +305,39 @@ creation of objects given class names. {\large {\bf Debugging features}} +\overview{Overview}{wxlogoverview} + +wxWindows provides several classes and functions for the 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 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} @@ -282,14 +347,17 @@ classes, functions and macros. wxWindows 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{wxSocketBase}{wxsocketbase}}{Represents a socket base object} \twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client} \twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} -\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator} -\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class} -\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class} \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event} -\twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents in Internet adress} +\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class} +\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class} +\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator} \end{twocollist} @@ -298,9 +366,9 @@ wxWindows provides its own classes for socket based networking. \overview{Overview}{ipcoverview} wxWindows provides a simple interprocess communications facilities -based on DDE. [Note that this is currently work in progress and may not -function properly.] +based on DDE. +\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} @@ -318,10 +386,11 @@ function properly.] wxWindows 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} -\twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a veiw class} +\twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a view class} \twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application} \twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view} \twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views} @@ -334,9 +403,10 @@ housekeeping for a document-centric application. \overview{Overview}{printingoverview} A printing and previewing framework is implemented to -make it relatively straighforward to provide document printing +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} @@ -356,6 +426,7 @@ 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} @@ -375,8 +446,11 @@ facilities. wxWindows 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} @@ -388,6 +462,7 @@ overview}{wxfileoverview} for more details. wxWindows 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} @@ -422,12 +497,13 @@ libraries, and to provide enhanced functionality. wxWindows 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{wxMutex}{wxmutex}}{Mutex class} \twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class} \twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class} -\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{ritical section locker utility class} +\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class} \twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class} \end{twocollist} @@ -436,6 +512,7 @@ capabilities of the various platforms. wxWindows 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} @@ -452,26 +529,38 @@ class include a help system based on the HTML widget. wxWindows 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 Miscellaneous}} +{\large {\bf XML-based resource system classes}} + +\overview{XML-based resource system 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{wxApp}{wxapp}}{Application class} -\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing} \twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows} -\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} -\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} -\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} -\twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class} -\twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class} -\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class} -\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table} -\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class} +\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class} +\twocolitem{\helpref{wxContextHelp}{wxcontexthelp}}{Class to put application into context-sensitive help mode} +\twocolitem{\helpref{wxContextHelpButton}{wxcontexthelpbutton}}{Button class for putting application into context-sensitive help mode} +\twocolitem{\helpref{wxHelpProvider}{wxhelpprovider}}{Abstract class for context-sensitive help provision} +\twocolitem{\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}}{Class for simple context-sensitive help provision} +\twocolitem{\helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}}{Class for context-sensitive help provision via a help controller} +\twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips} \end{twocollist} {\large {\bf Database classes}} @@ -479,9 +568,28 @@ 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 is documented in a separate manual. -The older classes are as follows: +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: + +\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} +The documentation for the older classes is still included, but you should avoid +using any of them in the new programs: + +\twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class} \twocolitem{\helpref{wxQueryCol}{wxquerycol}}{Class representing a column} @@ -489,3 +597,28 @@ The older classes are as follows: \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{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} +\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} +\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} +\twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class} +\twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class} +\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class for obtaining various global parameters} +\twocolitem{\helpref{wxSystemOptions}{wxsystemoptions}}{System options class for run-time configuration} +\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table} +\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class} +\twocolitem{\helpref{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding} +\twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions} +\twocolitem{\helpref{wxCalendarDateAttr}{wxcalendardateattr}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} +\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} +