X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2fda2145700445519a0ce539b04dc72bae180124..917be7ed065337e8a7a67615969ecaade9eea809:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index c7c0e0478a..517185ec06 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -2,16 +2,17 @@ \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} @@ -40,9 +41,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{wxListbook}{wxlistbook}}{Similar to notebook but using list control} +\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control} \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{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} @@ -61,13 +65,13 @@ 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{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog} \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.} \end{twocollist} @@ -90,6 +94,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \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{wxHtmlListBox}{wxhtmllistbox}}{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} @@ -105,6 +110,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \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 Menus}} @@ -132,9 +138,9 @@ These are the classes relevant to sizer-based layout. \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 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. @@ -157,6 +163,8 @@ by passing different device contexts. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt +\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} @@ -164,6 +172,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} @@ -192,6 +201,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}} @@ -238,6 +248,7 @@ An event object contains information about a specific event. Event handlers \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{wxTimerEvent}{wxtimerevent}}{A timer expiration 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} @@ -259,23 +270,22 @@ 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{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} @@ -286,8 +296,8 @@ These are the data structure classes supported by wxWindows. \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} @@ -295,7 +305,7 @@ 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} @@ -309,7 +319,7 @@ creation of objects given class names. \overview{Overview}{wxlogoverview} -wxWindows provides several classes and functions for the message logging. +wxWidgets provides several classes and functions for message logging. Please see the \helpref{wxLog overview}{wxlogoverview} for more details. \twocolwidtha{6cm} @@ -332,7 +342,7 @@ 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} @@ -347,12 +357,13 @@ classes, functions and macros. {\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} @@ -367,14 +378,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} @@ -382,7 +393,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} @@ -442,7 +453,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} @@ -454,11 +465,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} @@ -482,6 +494,8 @@ 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{wxStringInputStream}{wxstringinputstream}}{String input stream class} +\twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class} \twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib (compression) input stream class} \twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (compression) output stream class} \twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives} @@ -493,12 +507,13 @@ 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} @@ -509,7 +524,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} @@ -526,7 +541,7 @@ class include a help system based on the HTML widget. {\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} @@ -567,10 +582,8 @@ from specifications stored in an XML format. \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 @@ -586,17 +599,6 @@ 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 new programs: - -\twocolwidtha{6cm} -\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} @@ -606,6 +608,8 @@ using any of them in new programs: \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}