]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/category.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / category.tex
index 5607a41c741d08b25f7544a5d103c722742dbb07..a6d91d76af49d9b30b5035058649ee94d0dda673 100644 (file)
@@ -26,7 +26,7 @@ Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
 \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog}
 \end{twocollist}
 
-See also {\bf Common dialogs}.
+See also the \helpref{Common dialogs overview}{commondialogsoverview}.
 
 {\large {\bf Miscellaneous windows}}
 
@@ -93,13 +93,16 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t
 \twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
 \twocolitem{\helpref{wxBitmapComboBox}{wxbitmapcombobox}}{A combobox with bitmaps next to text items}
 \twocolitem{\helpref{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.}
+\twocolitem{\helpref{wxBitmapToggleButton}{wxbitmaptogglebutton}}{A toggle button with bitmaps.}
 \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{wxCollapsiblePane}{wxcollapsiblepane}}{A panel which can be shown/hidden by the user}
 \twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
 \twocolitem{\helpref{wxComboCtrl}{wxcomboctrl}}{A combobox with application defined popup}
 \twocolitem{\helpref{wxDataViewCtrl}{wxdataviewctrl}}{A control to tabular or tree like data}
+\twocolitem{\helpref{wxDataViewTreeCtrl}{wxdataviewtreectrl}}{A specialized wxDataViewCtrl with wxTreeCtrl-like API}
 \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}}{An abstract class for creating listboxes showing HTML content}
@@ -184,6 +187,7 @@ 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{wxWrapSizer}{wxwrapsizer}}{A sizer which wraps its child controls as size permits}
 \end{twocollist}
 
 \overview{Constraints overview}{constraintsoverview} describes constraints-based layout.
@@ -196,6 +200,13 @@ These are the classes relevant to constraints-based window layout.
 \twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class}
 \end{twocollist}
 
+Other layouting classes:
+
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
+\end{twocollist}
+
 {\large {\bf Device contexts}}
 
 \overview{Overview}{dcoverview}
@@ -285,6 +296,7 @@ An event object contains information about a specific event. Event handlers
 \twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event}
 \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event}
 \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
+\twocolitem{\helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}}{An event set by navigation keys such as tab}
 \twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
 \twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed}
 \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}
@@ -330,17 +342,7 @@ These are the data structure classes supported by wxWidgets.
 \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
 \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{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 wxWidgets classes}
 \twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths}
 \twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point}
@@ -356,6 +358,36 @@ These are the data structure classes supported by wxWidgets.
 \twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
 \end{twocollist}
 
+{\large {\bf Container classes}}
+
+\overview{Overview}{wxcontaineroverview}
+
+These are classes, templates and class macros are used by wxWidgets. Most
+of these classes provide a subset or almost complete STL API.
+
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxArray<T>}{wxarray}}{A type-safe dynamic array implementation (macro based)}
+\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects}
+\twocolitem{\helpref{wxHashMap<T>}{wxhashmap}}{A type-safe hash map implementation (macro based)}
+\twocolitem{\helpref{wxHashSet<T>}{wxhashset}}{A type-safe hash set implementation(macro based)}
+\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)}
+\twocolitem{\helpref{wxList<T>}{wxlist}}{A type-safe linked list implementation (macro based)}
+\twocolitem{\helpref{wxVector<T>}{wxvector}}{Template base vector implementation identical to std::vector}
+\end{twocollist}
+
+{\large {\bf Smart pointers}}
+
+wxWidgets provides a few smart pointer class templates.
+
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxObjectDataPtr<T>}{wxobjectdataptr}}{A shared pointer (using intrusive reference counting)}
+\twocolitem{\helpref{wxScopedPtr<T>}{wxscopedptrtemplate}}{A scoped pointer}
+\twocolitem{\helpref{wxSharedPtr<T>}{wxsharedptr}}{A shared pointer (using non-intrusive reference counting)}
+\twocolitem{\helpref{wxWeakRef<T>}{wxweakref}}{A weak reference}
+\end{twocollist}
+
 {\large {\bf Run-time class information system}}
 
 \overview{Overview}{runtimeclassoverview}
@@ -387,7 +419,8 @@ Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
 \twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs}
 \twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging}
 \twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets}
-\twocolitem{\helpref{wxLogPassThrough}{wxlogpassthrough}}{Allows to filter the log messages}
+\twocolitem{\helpref{wxLogInterposer}{wxloginterposer}}{Allows to filter the log messages}
+\twocolitem{\helpref{wxLogInterposerTemp}{wxloginterposertemp}}{Allows to filter the log messages}
 \twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows
 to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
 \twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions}
@@ -524,6 +557,7 @@ overview}{wxfileoverview} for more details.
 \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}
+\twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths}
 \end{twocollist}
 
 {\large {\bf Stream classes}}
@@ -608,9 +642,9 @@ and paragraph formatting.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxTextAttr}{wxtextattr}}{Attributes specifying text styling.}
 \twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{A rich text control.}
 \twocolitem{\helpref{wxRichTextBuffer}{wxrichtextbuffer}}{The content of a rich text control.}
-\twocolitem{\helpref{wxRichTextAttr}{wxrichtextattr}}{Attributes specifying rich text styling.}
 \twocolitem{\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.}
 \twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.}
 \twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.}
@@ -629,6 +663,16 @@ and paragraph formatting.
 \twocolitem{\helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata}}{Header and footer data specification.}
 \end{twocollist}
 
+{\large {\bf Scintilla text editor classes}}
+
+wxWidgets also provides a wrapper around the Scintilla text editor control, which is
+a control for plain-text editing with support for highlighting, smart indentation, etc.
+
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxStyledTextCtrl}{wxstyledtextctrl}}{A wxWidgets implementation of the Scintilla source code editing component.}
+\end{twocollist}
+
 {\large {\bf Virtual file system classes}}
 
 wxWidgets provides a set of classes that implement an extensible virtual file system,
@@ -645,9 +689,9 @@ used internally by the HTML classes.
 
 \twocolwidtha{6cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files.}
-\twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes.}
-\twocolitem{\helpref{wxXmlProperty}{wxxmlproperty}}{A class which represents XML properties.}
+\twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files}
+\twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes}
+\twocolitem{\helpref{wxXmlAttribute}{wxxmlattribute}}{A class which represent an XML attribute}
 \end{twocollist}
 
 {\large {\bf XML-based resource system classes}}
@@ -659,8 +703,8 @@ 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.}
+\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}}
@@ -677,40 +721,37 @@ from specifications stored in an XML format.
 \twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips}
 \end{twocollist}
 
-{\large {\bf Database classes}}
+{\large {\bf Multimedia classes}}
 
-\overview{Database classes overview}{odbcoverview}
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxMediaCtrl}{wxmediactrl}}{Display multimedia contents.}
+\end{twocollist}
 
-wxWidgets provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
-product, donated by Remstar. This is known as wxODBC.
+{\large {\bf OpenGL classes}}
 
 \twocolwidtha{6cm}
 \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}}{}
+\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.}
+\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.}
 \end{twocollist}
 
-{\large {\bf Miscellaneous}}
+{\large {\bf Application and process-management classes}}
 
 \twocolwidtha{6cm}
 \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{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}
+\end{twocollist}
+
+{\large {\bf Miscellaneous}}
+
+\twocolwidtha{6cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object}
+\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)}
 \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
 \twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
 \twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class}