X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1ee445c75b57e2b8785b2e1bce8d7e30cafe21f6..b8b37cedd39bae3a3653003a7f8ae5fecf4df78f:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index d5542b9a9e..4c095c6535 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -19,6 +19,7 @@ Frames and dialogs are similar in wxWidgets, but only dialogs may be modal. \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} @@ -43,7 +44,7 @@ The following are a variety of classes that are derived from wxWindow. \twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} \twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control} \twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control} -\twocolitem{\helpref{wxPlotWindow}{wxplotwindow}}{A class to display data.} +\twocolitem{\helpref{wxTreebook}{wxtreebook}}{Similar to notebook but using tree 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} @@ -68,9 +69,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} @@ -86,11 +89,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{wxComboCtrl}{wxcomboctrl}}{A combobox with application defined popup} \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} @@ -98,13 +102,15 @@ 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{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} \twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control} \twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control} \twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control} \twocolitem{\helpref{wxSpinCtrl}{wxspinctrl}}{A spin control - i.e. spin button and text control} \twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text} +\twocolitem{\helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}{A static text which opens an URL when clicked} \twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap} \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} @@ -112,6 +118,21 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows} \end{twocollist} + +{\large {\bf Miscellaneous pickers}} + +A picker control is a control whose appearance and behaviour is highly platform-dependent. + +\twocolwidtha{6cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}}{A control which allows the user to choose a colour} +\twocolitem{\helpref{wxDirPickerCtrl}{wxdirpickerctrl}}{A control which allows the user to choose a directory} +\twocolitem{\helpref{wxFilePickerCtrl}{wxfilepickerctrl}}{A control which allows the user to choose a file} +\twocolitem{\helpref{wxFontPickerCtrl}{wxfontpickerctrl}}{A control which allows the user to choose a font} +\twocolitem{\helpref{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control} +\end{twocollist} + + {\large {\bf Menus}} \twocolwidtha{6cm} @@ -215,8 +236,11 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event} \twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}} \twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout} +\twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event} \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} @@ -240,16 +264,20 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event} \twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} \twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information} +\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event} \twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons} \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows} \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{wxTreebookEvent}{wxtreebookevent}}{A treebook control 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} @@ -278,7 +306,10 @@ These are the data structure classes supported by wxWidgets. \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} @@ -291,11 +322,11 @@ These are the data structure classes supported by wxWidgets. \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} @@ -346,11 +377,13 @@ 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}} @@ -439,7 +472,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} @@ -463,7 +496,7 @@ 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{wxFileLocator}{wxfilelocator}}{Find the locations of standard directories.} +\twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories} \end{twocollist} {\large {\bf Stream classes}} @@ -492,11 +525,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} @@ -551,7 +586,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. @@ -606,8 +641,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{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}