X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/672186efa8a6f6a2f6d38acea4efaf3849cbcf93..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index d6c9061649..9a4cc3ca86 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -14,11 +14,14 @@ Frames may contain windows, and dialog boxes may directly contain controls. \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{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}. @@ -39,6 +42,8 @@ The following are a variety of classes that are derived from wxWindow. \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}} @@ -61,6 +66,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}} @@ -72,17 +78,19 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \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{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} @@ -103,7 +111,7 @@ 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 layouting 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. @@ -112,6 +120,8 @@ These are the classes relevant to the sizer-based layout. \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.} @@ -179,9 +189,11 @@ An event object contains information about a specific event. Event handlers \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} @@ -203,10 +215,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}} @@ -227,10 +241,12 @@ user input. These are the data structure classes supported by wxWindows. \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O} -\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O} +\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{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data} \twocolitem{\helpref{wxList}{wxlist}}{A simple linked list implementation} @@ -247,6 +263,7 @@ These are the data structure classes supported by wxWindows. \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{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time} \end{twocollist} @@ -288,7 +305,8 @@ classes, functions and macros. wxWindows provides its own classes for socket based networking. \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet adress} +\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} @@ -326,7 +344,7 @@ housekeeping for a document-centric application. \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} @@ -339,7 +357,7 @@ 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. \begin{twocollist}\itemsep=0pt @@ -382,6 +400,7 @@ overview}{wxfileoverview} for more details. \begin{twocollist}\itemsep=0pt \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} @@ -432,7 +451,7 @@ capabilities of the various platforms. \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} @@ -463,22 +482,17 @@ used internally by the HTML classes. \twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type} \end{twocollist} -{\large {\bf Miscellaneous}} +{\large {\bf Online help}} \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{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding} -\twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions} +\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}} @@ -486,8 +500,25 @@ 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: + +\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: \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class} @@ -496,3 +527,25 @@ The older classes are as follows: \twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record} \end{twocollist} +{\large {\bf Miscellaneous}} + +\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} +\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} +\end{twocollist} +