X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1c0c339c2d391168461dece5e97571f5f12a5026..56b88f1276ea4049a21f6174842b56ca9f280a3f:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index bfd880b459..5f15e9a86b 100644 --- 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{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{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} @@ -90,9 +92,11 @@ 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{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{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} @@ -104,6 +108,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{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows} \end{twocollist} {\large {\bf Menus}} @@ -131,6 +136,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{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} @@ -156,6 +162,8 @@ by passing different device contexts. \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} @@ -163,6 +171,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{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} @@ -191,6 +200,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{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives} \end{twocollist} {\large {\bf Events}} @@ -211,7 +221,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} @@ -222,6 +232,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} @@ -262,12 +273,12 @@ 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)} \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{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} @@ -283,7 +294,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{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} @@ -299,14 +309,14 @@ creation of objects given class names. \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}} +{\large {\bf Logging features}} \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} @@ -350,6 +360,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} +\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} @@ -364,17 +375,14 @@ wxWindows provides its own classes for socket based networking. \overview{Overview}{ipcoverview} -wxWindows provides a 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} @@ -499,11 +507,13 @@ capabilities of the various platforms. \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{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}} @@ -566,10 +576,8 @@ from specifications stored in an XML format. \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 @@ -585,17 +593,6 @@ working with databases: \twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{} \end{twocollist} -The documentation for the older classes is still included, but you should avoid -using any of them in the 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} @@ -620,4 +617,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} -