X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..e46286351dbfa7ae98e8341e4fc328b134601e87:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 246b9f7bb3..b3ebbcecaa 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -29,24 +29,14 @@ The following are a variety of windows that are derived from wxWindow. \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window} \twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings} +\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{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars} \twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally} \twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame} -\twocolitem{\helpref{wxStatusBar95}{wxstatusbar95}}{Implements a Windows 95 status bar on a frame} -\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel} -\end{twocollist} - -{\large {\bf Toolbar classes}} - -\overview{Overview}{wxtoolbaroverview} - -These are the toolbar classes. - -\begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxToolBarBase}{wxtoolbarbase}}{Toolbar base class} -\twocolitem{\helpref{wxToolBarSimple}{wxtoolbarsimple}}{A simple, cross-platform toolbar class} -\twocolitem{\helpref{wxToolBarMSW}{wxtoolbarmsw}}{A Windows-only toolbar class} -\twocolitem{\helpref{wxToolBar95}{wxtoolbar95}}{A Windows 95-only toolbar class} +\twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class} +%\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)} +\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class} \end{twocollist} {\large {\bf Common dialogs}} @@ -67,6 +57,7 @@ in an application. \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} \end{twocollist} @@ -133,7 +124,7 @@ by passing different device contexts. \twocolitem{\helpref{wxScreenDC}{wxscreendc}}{A device context to access the entire screen} \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{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles} \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} @@ -153,6 +144,7 @@ These classes are related to drawing on device contexts and windows. \twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts} \twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts} \twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts} +\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class} \twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls} \twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing} \twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context} @@ -170,6 +162,7 @@ An event object contains information about a specific event. Event handlers \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event} +\twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout} \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{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event} @@ -184,22 +177,32 @@ An event object contains information about a specific event. Event handlers \twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event} \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event} \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event} +\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} -%\twocolitem{\helpref{wxSessionEvent}{wxsessionevent}}{A session ending event} +\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event} +\twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information} +\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{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event} +\twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event} \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event} \twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event} \end{twocollist} {\large {\bf Validators}} +\overview{Overview}{validatoroverview} + These are the window validators, used for filtering and validating user input. \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class.} -\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class.} +\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class} +\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class} +\twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class} \end{twocollist} {\large {\bf Data structures}} @@ -223,6 +226,8 @@ These are the data structure classes supported by wxWindows. \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} +\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types +that may change at run-time} \end{twocollist} {\large {\bf Run-time class information system}} @@ -246,14 +251,16 @@ wxWindows supports some aspects of debugging an application through classes, functions and macros. \begin{twocollist}\itemsep=0pt -\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides various debugging facilities} -\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream} -\twocolitem{\helpref{wxObject}{wxobject}}{Provides optional debugging versions of {\bf new} and {\bf delete}} -\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility} -\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels} +\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities} +%\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream} +\twocolitem{\helpref{wxLog}{wxlog}}{Logging facility} +\twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions} +\twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking} +%\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility} +%\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels} \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{WXTRACE}{trace}}{Trace macro} +%\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels} \end{twocollist} {\large {\bf Interprocess communication}} @@ -267,7 +274,12 @@ based on DDE. \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} -%TODO: put this somewhere \twocolitem{\helpref{wxHelpInstance}{wxhelpinstance}}{A specialised client} +\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{wxSocketClient}{wxsocketclient}}{Represents a socket client} +\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} +\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} \end{twocollist} {\large {\bf Document/view framework}} @@ -277,9 +289,6 @@ based on DDE. wxWindows supports a document/view framework which provides housekeeping for a document-centric application. -TODO: MDI frame classes for documents; make it unnecessary to convert -between streams and files (overridable method that uses filenames instead of streams). - \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document} \twocolitem{\helpref{wxView}{wxview}}{Represents a view} @@ -287,6 +296,8 @@ between streams and files (overridable method that uses filenames instead of str \twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application} \twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view} \twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views} +%\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view} +%\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views} \end{twocollist} {\large {\bf Printing framework}} @@ -301,20 +312,24 @@ facilities. \twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview} \twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview} \twocolitem{\helpref{wxPreviewControlBar}{wxpreviewcontrolbar}}{Standard control bar for a print preview} -\twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed} \twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog} +\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog} \twocolitem{\helpref{wxPrinter}{wxprinter}}{Class representing the printer} \twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{Printer device context} \twocolitem{\helpref{wxPrintout}{wxprintout}}{Class representing a particular printout} \twocolitem{\helpref{wxPrintPreview}{wxprintpreview}}{Class representing a print preview} +\twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed} +\twocolitem{\helpref{wxPrintDialogData}{wxprintdialogdata}}{Represents information about the print dialog} +\twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog} \end{twocollist} {\large {\bf Database classes}} \overview{Database classes overview}{odbcoverview} -wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity) -product. +wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity) +product. The new version by Remstar is documented in a separate manual. +The older classes are as follows: \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class} @@ -323,12 +338,69 @@ product. \twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record} \end{twocollist} +{\large {\bf Drag and drop and clipboard classes}} + +\overview{Drag and drop and clipboard overview}{wxdndoverview} + +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class} +\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class} +\twocolitem{\helpref{wxFileDataObject}{wxtextdataobject}}{File data object class} +\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class} +\twocolitem{\helpref{wxPrivateDataObject}{wxprivatedataobject}}{Private data object class} +\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class} +\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class} +\twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class} +\twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class} +\twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class} +\end{twocollist} + +{\large {\bf File related classes}} + +wxWindows has several small classes to work with disk files, see \helpref{file classes +overview}{wxfileoverview} for more details. + +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output} +\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} +\end{twocollist} + +{\large {\bf Stream classes}} + +wxWindows has its own set of stream classes, as an alternative to often buggy standard stream +libraries, and to provide enhanced functionality. + +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class} +\twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class} +\twocolitem{\helpref{wxInputStream}{wxinputstream}}{Input stream class} +\twocolitem{\helpref{wxOutputStream}{wxoutputstream}}{Output stream class} +\twocolitem{\helpref{wxFilterInputStream}{wxfilterinputstream}}{Filtered input stream class} +\twocolitem{\helpref{wxFilterOutputStream}{wxfilteroutputstream}}{Filtered output stream class} +\twocolitem{\helpref{wxDataInputStream}{wxdatainputstream}}{Platform-independent binary data input stream class} +\twocolitem{\helpref{wxDataOutputStream}{wxdataoutputstream}}{Platform-independent binary data output stream class} +\twocolitem{\helpref{wxTextInputStream}{wxtextinputstream}}{Platform-independent text data input stream class} +\twocolitem{\helpref{wxTextOutputStream}{wxtextoutputstream}}{Platform-independent text data output stream class} +\twocolitem{\helpref{wxFileInputStream}{wxfileinputstream}}{File input stream class} +\twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class} +\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib (compression) input stream class} +\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (compression) output stream class} +\twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class} +\twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class} +\end{twocollist} + {\large {\bf Miscellaneous}} \begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table} \twocolitem{\helpref{wxApp}{wxapp}}{Application class} +\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class} +\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing} +\twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows} +\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} +\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class} \end{twocollist} -