]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/category.tex
define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...
[wxWidgets.git] / docs / latex / wx / category.tex
index 98e4f323fd7a85b768995cac2e01ecc47ae138d3..31a4d1311499503018c6bdbd0f4eee5be8974994 100644 (file)
@@ -2,22 +2,24 @@
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
-A classification of wxWindows classes by category.
+A classification of wxWidgets classes by category.
 
 {\large {\bf Managed windows}}
 
 There are several types of window that are directly controlled by the
 window manager (such as MS Windows, or the Motif Window Manager).
-Frames may contain windows, and dialog boxes may directly contain controls.
+Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxTopLevelWindow}{wxtoplevelwindow}}{Any top level window, dialog or frame}
 \twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box}
 \twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame}
 \twocolitem{\helpref{wxMDIChildFrame}{wxmdichildframe}}{MDI child frame}
 \twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent frame}
 \twocolitem{\helpref{wxMiniFrame}{wxminiframe}}{A frame with a small title bar}
 \twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class}
+\twocolitem{\helpref{wxPropertySheetDialog}{wxpropertysheetdialog}}{Property sheet dialog}
 %\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog
 %(deprecated, use wxNotebook instead)}
 \twocolitem{\helpref{wxTipWindow}{wxtipwindow}}{Shows text in a small window}
@@ -41,7 +43,7 @@ The following are a variety of classes that are derived from wxWindow.
 %\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
 \twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class}
 \twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control}
-\twocolitem{\helpref{wxPlotWindow}{wxplotwindow}}{A class to display data.}
+\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control}
 \twocolitem{\helpref{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}
@@ -66,9 +68,11 @@ in an application.
 \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{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog}
 \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog}
 \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.}
 \end{twocollist}
@@ -84,11 +88,12 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t
 \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{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{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control}
 \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}
@@ -96,7 +101,6 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t
 \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
 \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view}
 \twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode}
-\twocolitem{\helpref{wxTabCtrl}{wxtabctrl}}{Manages several tabs}
 \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control}
 \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control}
 \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control}
@@ -138,7 +142,6 @@ These are the classes relevant to sizer-based layout.
 \twocolitem{\helpref{wxGridBagSizer}{wxgridbagsizer}}{Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.}
 \twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
 \twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box}
-\twocolitem{\helpref{wxNotebookSizer}{wxnotebooksizer}}{Sizer to use with the wxNotebook control}
 \end{twocollist}
 
 \overview{Constraints overview}{constraintsoverview} describes constraints-based layout.
@@ -216,6 +219,8 @@ An event object contains information about a specific event. Event handlers
 \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{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}
@@ -244,10 +249,13 @@ An event object contains information about a specific event. Event handlers
 \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{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}
 
@@ -267,7 +275,7 @@ 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
@@ -276,24 +284,27 @@ These are the data structure classes supported by wxWindows.
 \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{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{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}
 
@@ -301,7 +312,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}
@@ -315,7 +326,7 @@ creation of objects given class names.
 
 \overview{Overview}{wxlogoverview}
 
-wxWindows provides several classes and functions for message logging.
+wxWidgets provides several classes and functions for message logging.
 Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
 
 \twocolwidtha{6cm}
@@ -338,22 +349,24 @@ to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
 
 \overview{Overview}{debuggingoverview}
 
-wxWindows supports some aspects of debugging an application through
+wxWidgets supports some aspects of debugging an application through
 classes, functions and macros.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities}
-%\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream}
 \twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking}
 \twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information}
-%\twocolitem{\helpref{WXTRACE}{trace}}{Trace macro}
-%\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels}
+\twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.}
+\twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.}
+\twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.}
+\twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.}
+\twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.}
 \end{twocollist}
 
 {\large {\bf Networking classes}}
 
-wxWindows provides its own classes for socket based networking.
+wxWidgets provides its own classes for socket based networking.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
@@ -374,14 +387,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}
 
@@ -389,7 +402,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}
@@ -437,7 +450,7 @@ facilities.
 \twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class}
 \twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format}
 \twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
-\twocolitem{\helpref{wxFileDataObject}{wxtextdataobject}}{File data object class}
+\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class}
 \twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
 \twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class}
 \twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
@@ -449,7 +462,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}
@@ -461,11 +474,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}
@@ -489,9 +503,13 @@ 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{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 (compression) input stream class}
 \twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (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{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class}
 \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
 \end{twocollist}
@@ -500,7 +518,7 @@ libraries, and to provide enhanced functionality.
 
 \overview{Multithreading overview}{wxthreadoverview}
 
-wxWindows provides a set of classes to make use of the native thread
+wxWidgets provides a set of classes to make use of the native thread
 capabilities of the various platforms.
 
 \twocolwidtha{6cm}
@@ -517,7 +535,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}
@@ -534,7 +552,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}
@@ -546,7 +564,7 @@ used internally by the HTML classes.
 
 {\large {\bf XML-based resource system classes}}
 
-\overview{XML-based resource system overview}{xrcoverview}
+\overview{XML-based resource system (XRC) overview}{xrcoverview}
 
 Resources allow your application to create controls and other user interface elements
 from specifications stored in an XML format.
@@ -575,7 +593,7 @@ from specifications stored in an XML format.
 
 \overview{Database classes overview}{odbcoverview}
 
-wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
+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}
@@ -601,6 +619,8 @@ product, donated by Remstar. This is known as wxODBC.
 \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
 \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)}
 \twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.}
+\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.}
+\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.}
 \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
 \twocolitem{\helpref{wxProcess}{wxprocess}}{Process class}
 \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}