X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/72045d5768a126191a907bc640c28e81a11afdd6..85136e3bf5dadf921652519e71da5db351fb3194:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 750d1456b7..ff9602fd90 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -18,15 +18,15 @@ Frames and dialogs are similar in wxWidgets, but only dialogs may be modal. \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{wxSplashScreen}{wxsplashscreen}}{Splash screen class} %\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} -See also {\bf Common dialogs}. +See also the \helpref{Common dialogs overview}{commondialogsoverview}. {\large {\bf Miscellaneous windows}} @@ -75,6 +75,8 @@ in an application. \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} \twocolitem{\helpref{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog} \twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog} +\twocolitem{\helpref{wxSymbolPickerDialog}{wxsymbolpickerdialog}}{Symbol selector dialog} +\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for formatting the content of a wxRichTextCtrl} \twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.} \end{twocollist} @@ -91,20 +93,24 @@ 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}}{A listbox showing HTML content} +\twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{An abstract class for creating listboxes showing HTML content} +\twocolitem{\helpref{wxSimpleHtmlListBox}{wxsimplehtmllistbox}}{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{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode} +\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade}) for wxListCtrl in report mode} \twocolitem{\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}}{A combobox with owner-drawn list items} \twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{Generic rich text editing control} \twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control} @@ -145,6 +151,23 @@ A picker control is a control whose appearance and behaviour is highly platform- \twocolitem{\helpref{wxMenuItem}{wxmenuitem}}{Represents a single menu item} \end{twocollist} +{\large {\bf wxAUI - advanced user interface}} + +This is a new set of classes for writing a customizable application +interface with built-in docking, floatable panes and a flexible +MDI-like interface. Further classes for custom notebooks with +draggable tabs etc. are in progress. See also \helpref{wxAUI overview}{wxauioverview}. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAuiManager}{wxauimanager}}{The central class for managing the interface} +\twocolitem{\helpref{wxAuiNotebook}{wxauinotebook}}{A replacement notebook class with extra features} +\twocolitem{\helpref{wxAuiPaneInfo}{wxauipaneinfo}}{Describes a single pane} +\twocolitem{\helpref{wxAuiDockArt}{wxauidockart}}{Art and metrics provider for customizing the docking user interface} +\twocolitem{\helpref{wxAuiTabArt}{wxauitabart}}{Art and metrics provider for customizing the notebook user interface} +\end{twocollist} + + {\large {\bf Window layout}} There are two different systems for laying out windows (and dialogs in particular). @@ -164,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. @@ -176,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} @@ -186,6 +217,7 @@ by passing different device contexts. \twocolwidtha{6cm} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAutoBufferedPaintDC}{wxautobufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.} \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} @@ -264,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} @@ -309,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} @@ -335,6 +358,24 @@ 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}{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}{wxhashmap}}{A type-safe hash map implementation (macro based)} +\twocolitem{\helpref{wxHashSet}{wxhashset}}{A type-safe hash set implementation(macro based)} +\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)} +\twocolitem{\helpref{wxList}{wxlist}}{A type-safe linked list implementation (macro based)} +\twocolitem{\helpref{wxVector}{wxvector}}{Template base vector implementation} +\end{twocollist} + {\large {\bf Run-time class information system}} \overview{Overview}{runtimeclassoverview} @@ -366,7 +407,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} @@ -503,6 +545,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}} @@ -534,10 +577,12 @@ libraries, and to provide enhanced functionality. \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{wxZlibInputStream}{wxzlibinputstream}}{Zlib and gzip (compression) input stream class} +\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib and gzip (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{wxTarInputStream}{wxtarinputstream}}{Input stream for reading from tar archives} +\twocolitem{\helpref{wxTarOutputStream}{wxtaroutputstream}}{Output stream for writing from tar archives} \twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class} \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class} \end{twocollist} @@ -578,6 +623,44 @@ class include a help system based on the HTML widget. \twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser} \end{twocollist} +{\large {\bf Rich text classes}} + +wxWidgets provides a set of generic classes to edit and print simple rich text with character +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{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.} +\twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.} +\twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.} +\twocolitem{\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}}{A set of style definitions.} +\twocolitem{\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}}{A drop-down control for applying styles.} +\twocolitem{\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}}{A listbox for applying styles.} +\twocolitem{\helpref{wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialog}}{A dialog that can be used for managing or browsing styles.} +\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text event.} +\twocolitem{\helpref{wxRichTextRange}{wxrichtextrange}}{Specification for ranges in a rich text control or buffer.} +\twocolitem{\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}}{File handler base class.} +\twocolitem{\helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}}{A handler for converting rich text to HTML.} +\twocolitem{\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler}}{A handler for loading and saving rich text XML.} +\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for rich text formatting.} +\twocolitem{\helpref{wxRichTextPrinting}{wxrichtextprinting}}{A class for easy printing of rich text buffers.} +\twocolitem{\helpref{wxRichTextPrintout}{wxrichtextprintout}}{A class used by wxRichTextPrinting.} +\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, @@ -594,9 +677,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}} @@ -608,8 +691,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}} @@ -626,40 +709,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}