X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6fb26ea3b3784922bd0613a5e96fda78fac684ac..d45d30c8682f858321600e2958167d7ef54ebeb5:/docs/latex/wx/category.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 768597cf0b..806ffb90b7 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -57,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} @@ -99,9 +100,22 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t {\large {\bf Window layout}} -\overview{Overview}{constraintsoverview} +There are two different systems for layouting windows (and dialogs in particluar). +One is based upon so-called sizers and it requires less typing, thinking and calculating +and will in almost all cases produce dialogs looking equally well on all platforms, the +other is based on so-called constraints and allows for more detailed layouts. -These are the classes relevant to automated window layout. +These are the classes relevant to the sizer-based layout. + +\begin{twocollist}\itemsep=0pt +\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class} +\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column} +\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with surrounding static box} +\end{twocollist} + +\overview{Overview}{constraintsoverview} over the constraints-based layout. + +These are the classes relevant to constraints-based window layout. \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension} @@ -123,7 +137,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} @@ -143,6 +157,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} @@ -176,9 +191,12 @@ An event object contains information about a specific event. Event handlers \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{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} @@ -189,12 +207,15 @@ An event object contains information about a specific event. Event handlers {\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}} @@ -215,9 +236,12 @@ These are the data structure classes supported by wxWindows. \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{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}} @@ -241,10 +265,11 @@ 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{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} @@ -257,14 +282,18 @@ classes, functions and macros. \overview{Overview}{ipcoverview} wxWindows provides a simple interprocess communications facilities -based on DDE. +based on DDE. [Note that this is currently work in progress and may not +function properly.] \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{wxSocketClient}{wxsocketclient}}{Represents a socket client} -\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} +%\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler} \twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server} \end{twocollist} @@ -298,20 +327,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} @@ -320,11 +353,65 @@ 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{wxDataFormat}{wxdataformat}}{Represents a data format} +\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{wxCustomDataObject}{wxcustomdataobject}}{Custom 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} @@ -333,4 +420,3 @@ product. \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class} \end{twocollist} -