classic/carbon split

[wxWidgets.git] / docs / latex / wx / category.tex

diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex
index c7c0e0478a3b13f2e37fda4592bffa84e249dd1b..98e4f323fd7a85b768995cac2e01ecc47ae138d3 100644 (file)
--- a/docs/latex/wx/category.tex
+++ b/docs/latex/wx/category.tex
@@ -40,9 +40,11 @@ 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{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{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{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}
 \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 +63,12 @@ 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{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{wxFontDialog}{wxfontdialog}}{Font chooser dialog}
 \twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
 \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
 \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{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}
 \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog}
 \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.}
 \end{twocollist}


@@ -90,6 +91,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{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}
 \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 +107,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{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}}
 \end{twocollist}
 
 {\large {\bf Menus}}


@@ -132,6 +135,7 @@ 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{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}
 \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}


@@ -157,6 +161,8 @@ by passing different device contexts.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 
 \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}
 \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 +170,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{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}
 \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 +199,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{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}}
 \end{twocollist}
 
 {\large {\bf Events}}


@@ -264,11 +272,10 @@ These are the data structure classes supported by wxWindows.
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
 \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{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{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}


@@ -286,7 +293,6 @@ 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{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{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
 \end{twocollist}
 \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}


@@ -309,7 +315,7 @@ creation of objects given class names.
 
 \overview{Overview}{wxlogoverview}
 
 
 \overview{Overview}{wxlogoverview}
 

-wxWindows provides several classes and functions for the message logging.
+wxWindows provides several classes and functions for message logging.

 Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
 
 \twocolwidtha{6cm}
 Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
 
 \twocolwidtha{6cm}


@@ -353,6 +359,7 @@ wxWindows provides its own classes for socket based networking.
 \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}
 \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}
 \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}


@@ -499,6 +506,7 @@ capabilities of the various platforms.
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxThread}{wxthread}}{Thread class}
 \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}
 \twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class}
 \twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class}
 \twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class}


@@ -567,10 +575,8 @@ from specifications stored in an XML format.
 
 \overview{Database classes overview}{odbcoverview}
 
 
 \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:
+wxWindows 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
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt


@@ -586,17 +592,6 @@ working with databases:
 \twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{}
 \end{twocollist}
 
 \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}
 {\large {\bf Miscellaneous}}
 
 \twocolwidtha{6cm}