]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/category.tex
Doc corrections
[wxWidgets.git] / docs / latex / wx / category.tex
index 323f67c04f6a2eb6a7b5d42801f61f47453c5288..dba0aa01a0daa7532d7f254a670d3835ee16b9a9 100644 (file)
@@ -3,7 +3,6 @@
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 A classification of wxWindows classes by category.
-\twocolwidtha{5cm}
 
 {\large {\bf Managed windows}}
 
@@ -11,6 +10,7 @@ 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}
@@ -18,8 +18,8 @@ Frames may contain windows, and dialog boxes may directly contain controls.
 \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{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 +30,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}
@@ -53,6 +54,7 @@ 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}
@@ -75,6 +77,7 @@ 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}
@@ -90,6 +93,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t
 \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{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}
@@ -105,6 +109,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}
@@ -113,26 +118,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 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{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 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}
@@ -146,6 +155,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}
@@ -164,6 +174,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}
@@ -190,6 +201,7 @@ 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}}
@@ -200,7 +212,7 @@ An event object contains information about a specific event. Event handlers
 \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 
+\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}
@@ -211,6 +223,7 @@ 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{wxMouseEvent}{wxmouseevent}}{A mouse event}
 \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
 \twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
@@ -237,6 +250,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}
@@ -247,6 +261,7 @@ 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)}
@@ -254,7 +269,8 @@ 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{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}
@@ -282,19 +298,21 @@ These are the data structure classes supported by wxWindows.
 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}
-\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 Debugging features}}
 
-\overview{Overview}{loggingoverview}
+\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}
@@ -317,6 +335,7 @@ to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
 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}
@@ -330,6 +349,7 @@ 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}
@@ -347,16 +367,14 @@ wxWindows provides its own classes for socket based networking.
 
 \overview{Overview}{ipcoverview}
 
-wxWindows provides simple interprocess communications facilities
-based on DDE.
+wxWindows 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}{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{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
 \end{twocollist}
 
@@ -367,6 +385,7 @@ based on DDE.
 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}
@@ -386,6 +405,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}
@@ -405,6 +425,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}
@@ -424,7 +445,9 @@ 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.}
@@ -438,6 +461,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}
@@ -472,6 +496,7 @@ 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}
@@ -479,6 +504,7 @@ capabilities of the various platforms.
 \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}}
@@ -486,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}
@@ -502,14 +529,29 @@ 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 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{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
 \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
@@ -530,6 +572,7 @@ 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}
@@ -544,8 +587,9 @@ working with databases:
 \end{twocollist}
 
 The documentation for the older classes is still included, but you should avoid
-using any of them in the new programs:
+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}
@@ -555,6 +599,7 @@ using any of them in the new programs:
 
 {\large {\bf Miscellaneous}}
 
+\twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxApp}{wxapp}}{Application class}
 \twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object}
@@ -576,4 +621,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}
-