Added 'Include files' section to class references

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 1999-02-15 20:41:29 +00:00
parent a2ace6ff1f
commit 954b8ae603
196 changed files with 1273 additions and 49 deletions

View File

@ -6,6 +6,10 @@ An object used by an application wishing to create an \helpref{accelerator table
None
\wxheading{Include files}
<wx/accel.h>
\wxheading{See also}
\helpref{wxAcceleratorTable}{wxacceleratortable}, \helpref{wxWindow::SetAcceleratorTable}{wxwindowsetacceleratortable}
@ -77,6 +81,10 @@ initial accelerator table for a window.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/accel.h>
\wxheading{Example}
{\small%

View File

@ -8,6 +8,10 @@ or deactivated.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process an activate event, use these event handler macros to direct input to a member

View File

@ -22,6 +22,10 @@ a reference to your application object) to be visible to other files.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/app.h>
\wxheading{See also}
\helpref{wxApp overview}{wxappoverview}

View File

@ -22,6 +22,10 @@ Note that this class works under Windows only, and currently only for Visual C++
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/msw/ole/automtn.h>
\wxheading{See also}
\helpref{wxVariant}{wxvariant}

View File

@ -12,6 +12,10 @@ almost any other window.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/bmpbuttn.h>
\wxheading{Remarks}
A bitmap button can be supplied with a single bitmap, and wxWindows will draw

View File

@ -10,6 +10,10 @@ either monochrome or colour.
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/bitmap.h>
\wxheading{See also}
\helpref{wxBitmap overview}{wxbitmapoverview},
@ -539,6 +543,10 @@ application initialisation.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/bitmap.h>
\wxheading{See also}
\helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}

View File

@ -13,6 +13,10 @@ and \helpref{WriteData}{wxbitmapdataobjectwritedata} will have to be overridden.
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
<wx/dataobj.h>
\wxheading{See also}
\helpref{wxDataObject}{wxdataobject}

View File

@ -9,6 +9,10 @@ style.
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/brush.h>
\wxheading{Remarks}
On a monochrome display, wxWindows shows
@ -259,6 +263,10 @@ A brush list is a list containing all brushes which have been created.
\helpref{wxList}{wxlist}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gdicmn.h>
\wxheading{Remarks}
There is only one instance of this class: {\bf wxTheBrushList}. Use

View File

@ -20,6 +20,10 @@ and \helpref{wxEndBusyCursor}{wxendbusycursor} in the destructor.
None
\wxheading{Include files}
<wx/utils.h>
\wxheading{See also}
\helpref{wxBeginBusyCursor}{wxbeginbusycursor}, \helpref{wxEndBusyCursor}{wxendbusycursor}

View File

@ -12,6 +12,10 @@ almost any other window.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/button.h>
\wxheading{Window styles}
There are no special styles for wxButton.

View File

@ -9,6 +9,10 @@ occupy.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/laywin.h>
\wxheading{Event table macros}
\twocolwidtha{7cm}%

View File

@ -10,6 +10,10 @@ or off (no checkmark).
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/checkbox.h>
\wxheading{Window styles}
There are no special styles for wxCheckBox.

View File

@ -15,6 +15,10 @@ Only the new functions for this class are documented; see also \helpref{wxListBo
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/checklst.h>
\wxheading{Window styles}
See \helpref{wxListBox}{wxlistbox}.

View File

@ -11,6 +11,10 @@ menu of choices.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/choice.h>
\wxheading{Window styles}
There are no special styles for wxChoice.

View File

@ -8,6 +8,10 @@ of macros such as {\bf DECLARE\_DYNAMIC\_CLASS} and {\bf IMPLEMENT\_DYNAMIC\_CLA
No parent class.
\wxheading{Include files}
<wx/object.h>
\wxheading{See also}
\helpref{Overview}{wxclassinfooverview}, \helpref{wxObject}{wxobject}

View File

@ -14,6 +14,10 @@ To draw on the whole window including decorations, construct a \helpref{wxWindow
\helpref{wxDC}{wxdc}
\wxheading{Include files}
<wx/dcclient.h>
\wxheading{See also}
\helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp

View File

@ -40,6 +40,10 @@ For example:
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/clipbrd.h>
\wxheading{See also}
\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}

View File

@ -6,6 +6,10 @@ This event class contains information about window and session close events.
\helpref{wxEvent}{wxevent}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a close event, use these event handler macros to direct input to member

View File

@ -7,6 +7,10 @@ simple controls. More complex controls, such as \helpref{wxTreeCtrl}{wxtreectrl}
\helpref{wxEvent}{wxevent}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a menu command event, use these event handler macros to direct input to member

View File

@ -8,6 +8,10 @@ if you want different behaviour.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{wxCommandProcessor overview}{wxcommandprocessoroverview}, \helpref{wxCommand}{wxcommand}

View File

@ -9,6 +9,10 @@ This class represents the colour chooser dialog.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/colordlg.h>
\wxheading{See also}
\helpref{wxColourDialog Overview}{wxcolourdialogoverview}, \helpref{wxColour}{wxcolour}, \helpref{wxColourData}{wxcolourdata}

View File

@ -11,6 +11,10 @@ Valid RGB values are in the range 0 to 255.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/colour.h>
\wxheading{See also}
\helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp
@ -126,6 +130,10 @@ This class holds a variety of information related to colour dialogs.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/cmndata.h>
\wxheading{See also}
\helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
@ -215,6 +223,10 @@ is only one instance of this class: {\bf wxTheColourDatabase}.
\helpref{wxList}{wxlist}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gdicmn.h>
\wxheading{Remarks}
The colours in the standard database are as follows:

View File

@ -14,6 +14,10 @@ A combobox permits a single selection only. Combobox items are numbered from zer
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/combo.h>
\wxheading{Window styles}
\begin{twocollist}\itemsep=0pt

View File

@ -9,6 +9,10 @@ change the data or view.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\overview{Overview}{wxcommandoverview}

View File

@ -6,6 +6,10 @@ TODO
None.
\wxheading{Include files}
<wx/thread.h>
\wxheading{See also}
\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}

View File

@ -21,6 +21,14 @@ features of this class.
No base class
\wxheading{Include files}
<wx/config.h> (to let wxWindows choose a wxConfig class for your platform)\\
<wx/confbase.h> (base config class)\\
<wx/fileconf.h> (wxFileconfig class)\\
<wx/msw/regconf.h> (wxRegConfig class)\\
<wx/msw/iniconf.h> (wxIniConfig class)
\wxheading{Example}
Here is how you would typically use this class:

View File

@ -11,6 +11,10 @@ of data.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/control.h>
\wxheading{See also}
\helpref{wxValidator}{wxvalidator}

View File

@ -18,6 +18,10 @@ possible instead of directly using wxCriticalSection for the same reasons
None.
\wxheading{Include files}
<wx/thread.h>
\wxheading{See also}
\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition},

View File

@ -10,6 +10,10 @@ and difficult to debug problems).
None.
\wxheading{Include files}
<wx/thread.h>
\wxheading{See also}
\helpref{wxCriticalSection}{wxcriticalsection},

View File

@ -20,6 +20,10 @@ global \helpref{::wxSetCursor}{wxsetcursor} is also available for MS Windows use
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/cursor.h>
\wxheading{See also}
\helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor},\rtfsp

View File

@ -1,11 +1,16 @@
\section{\class{wxDatabase}}\label{wxdatabase}
Every database object represents an ODBC connection. The connection may be closed and reopened.
Every database object represents an ODBC connection.
The connection may be closed and reopened.
\wxheading{Derivation}
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/odbc.h>
\wxheading{See also}
\overview{wxDatabase overview}{wxdatabaseoverview}, \helpref{wxRecordSet}{wxrecordset}

View File

@ -43,6 +43,10 @@ available data and the WriteData() methods in both classes.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dataobj.h>
\wxheading{See also}
\helpref{wxFileDataObject}{wxfiledataobject},

View File

@ -2,14 +2,18 @@
A class for manipulating dates.
NOTE: this class should be
used with caution, since it is not fully tested. It may be replaced
with a new class in the near future.
{\bf NOTE:} this class should be
used with caution, since it is not fully tested. It will be replaced
with a new wxDateTime class in the near future.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/date.h>
\wxheading{See also}
\helpref{wxTime}{wxtime}

View File

@ -10,6 +10,10 @@ Sparc or anything else.
\helpref{wxInputStream}{wxinputstream}\\
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/datstrm.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDataInputStream::wxDataInputStream}\label{wxdatainputstreamconstr}

View File

@ -13,6 +13,10 @@ only, so refer to this section for most device context information.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dc.h>
\wxheading{See also}
\helpref{Overview}{dcoverview}

View File

@ -19,6 +19,10 @@ of this API is available using \helpref{wxTCPClient}{wxtcpclient}.
wxClientBase\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dde.h>
\wxheading{See also}
\helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEConnection}{wxddeconnection},

View File

@ -21,6 +21,10 @@ of this API is available using \helpref{wxTCPConnection}{wxtcpconnection}.
wxConnectionBase\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dde.h>
\wxheading{Types}
\index{wxIPCFormat}wxIPCFormat is defined as follows:

View File

@ -11,6 +11,10 @@ of this API is available using \helpref{wxTCPServer}{wxtcpserver}.
wxServerBase
\wxheading{Include files}
<wx/dde.h>
\wxheading{See also}
\helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, \helpref{IPC overview}{ipcoverview}

View File

@ -11,6 +11,10 @@ USE\_DEBUG\_CONTEXT to 0 is wx\_setup.h
No parent class.
\wxheading{Include files}
<wx/memory.h>
\wxheading{See also}
\overview{Overview}{wxdebugcontextoverview}
@ -251,6 +255,10 @@ This is soon to be obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
streambuf
\wxheading{Include files}
<wx/memory.h>
\wxheading{Example}
\begin{verbatim}

View File

@ -10,6 +10,10 @@ the screen. It can contain controls and other windows.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dialog.h>
\wxheading{Remarks}
There are two kinds of dialog - {\it modal} and {\it modeless}. A modal dialog

View File

@ -9,6 +9,10 @@ This class represents the directory chooser dialog.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dirdlg.h>
\wxheading{See also}
\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}

View File

@ -16,6 +16,10 @@ See the example application in {\tt samples/docview}.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe}

View File

@ -9,6 +9,10 @@ and \helpref{wxDocTemplate}{wxdoctemplate} classes.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{wxDocManager overview}{wxdocmanageroverview}, \helpref{wxDocument}{wxdocument},\rtfsp

View File

@ -17,6 +17,10 @@ See the example application in {\tt samples/docview}.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docmdi.h>
\wxheading{See also}
\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}

View File

@ -16,6 +16,10 @@ See the example application in {\tt samples/docview}.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docmdi.h>
\wxheading{See also}
\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIParentFrame}{wxmdiparentframe}

View File

@ -15,6 +15,10 @@ See the example application in {\tt samples/docview}.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe}

View File

@ -7,6 +7,10 @@ document class and a view class.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{wxDocTemplate overview}{wxdoctemplateoverview}, \helpref{wxDocument}{wxdocument}, \helpref{wxView}{wxview}

View File

@ -10,6 +10,10 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{wxDocument overview}{wxdocumentoverview}, \helpref{wxView}{wxview},\rtfsp

View File

@ -12,6 +12,10 @@ older, Windows message-based approach of dropping files.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a drop files event, use these event handler macros to direct input to a member

View File

@ -8,6 +8,10 @@ This class represents a source for a drag and drop operation.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dnd.h>
\wxheading{Types}
\index{wxDragResult}wxDragResult is defined as follows:

View File

@ -8,6 +8,10 @@ This class represents a target for a drag and drop operation.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dnd.h>
\wxheading{See also}
\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},

View File

@ -7,6 +7,10 @@ An erase event is sent when a window's background needs to be repainted.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process an erase event, use this event handler macro to direct input to a member

View File

@ -8,6 +8,10 @@ event object, and is an abstract base class for other event classes (see below).
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{See also}
\helpref{wxCommandEvent}{wxcommandevent},\rtfsp

View File

@ -8,6 +8,10 @@ this class.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{See also}
\overview{Event handling overview}{eventhandlingoverview}

View File

@ -8,6 +8,10 @@ or list, and lists can be nested.
None
\wxheading{Include files}
<wx/wxexpr.h>
\wxheading{See also}
\helpref{wxExpr overview}{exproverview}, \helpref{wxExprDatabase}{wxexprdatabase}

View File

@ -6,6 +6,10 @@ wxFileDataObject is a specialization of wxDataObject for file names.
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
<wx/dataobj.h>
\wxheading{See also}
\helpref{wxDataObject}{wxdataobject}

View File

@ -6,6 +6,10 @@
\helpref{wxDropTarget}{wxdroptarget}
\wxheading{Include files}
<wx/dnd.h>
\wxheading{See also}
\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},

View File

@ -9,6 +9,10 @@ between platforms and compilers.
None.
\wxheading{Include files}
<wx/file.h>
\wxheading{Constants}
wx/file.h defines the following constants:

View File

@ -9,6 +9,10 @@ This class represents the file chooser dialog.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/filedlg.h>
\wxheading{See also}
\helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector}

View File

@ -11,6 +11,10 @@ as well as the MDI parent frame.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/docview.h>
\wxheading{See also}
\helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}

View File

@ -29,14 +29,14 @@ A MIME type may have one or more associated extensions: "text/plain" will
typically correspond to the extension ".txt", but may as well be associated with
".ini" or ".conf".
\wxheading{Required headers}
<wx/mimetype.h>
\wxheading{Derived from}
No base class.
\wxheading{Include files}
<wx/mimetype.h>
\wxheading{See also}
\helpref{wxMimeTypesManager}{wxmimetypesmanager}

View File

@ -8,6 +8,10 @@
\helpref{wxInputStream}{wxinputstream}\\
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/stream.h>
\wxheading{Note}
The use of this class is exactly the same as of wxInputStream. Only a constructor

View File

@ -8,6 +8,10 @@
\helpref{wxOutputStream}{wxoutputstream}\\
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/stream.h>
\wxheading{Note}
The use of this class is exactly the same as of wxOutputStream. Only a constructor

View File

@ -7,6 +7,10 @@ A focus event is sent when a window's focus changes.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a focus event, use these event handler macros to direct input to a member

View File

@ -9,6 +9,10 @@ a window's text.
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/font.h>
\wxheading{See also}
\helpref{wxFont overview}{wxfontoverview}, \helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp

View File

@ -8,6 +8,10 @@ This class holds a variety of information related to font dialogs.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/cmndata.h>
\wxheading{See also}
\helpref{Overview}{wxfontdialogoverview}, \helpref{wxFontDialog}{wxfontdialog}
@ -149,6 +153,10 @@ This class represents the font chooser dialog.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/fontdlg.h>
\wxheading{See also}
\helpref{Overview}{wxfontdialogoverview}, \helpref{wxFontData}{wxfontdata}

View File

@ -12,6 +12,10 @@ deleted and their resources freed, eliminating the possibility of `memory leaks'
\helpref{wxList}{wxlist}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gdicmn.h>
\wxheading{See also}
\helpref{wxFont}{wxfont}

View File

@ -14,6 +14,10 @@ the remaining size available to application windows.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/frame.h>
\wxheading{Window styles}
\twocolwidtha{5cm}

View File

@ -4,6 +4,10 @@
\helpref{wxProtocol}{wxprotocol}
\wxheading{Include files}
<wx/ftp.h>
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase}

View File

@ -6,7 +6,13 @@ The functions defined in wxWindows are described here.
\section{File functions}\label{filefunctions}
See also \helpref{wxPathList}{wxpathlist}.
\wxheading{Include files}
<wx/utils.h>
\wxheading{See also}
\helpref{wxPathList}{wxpathlist}
\membersection{::wxDirExists}
@ -332,6 +338,10 @@ if (s)
Remember that the returned pointer is temporary and should be copied
if other wxWindows calls will be made before the value is to be used.
\wxheading{Include files}
<wx/filedlg.h>
\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
@ -345,6 +355,10 @@ or press Cancel to return NULL.
If {\it centre} is TRUE, the message text (which may include new line characters)
is centred; if FALSE, the message is left-justified.
\wxheading{Include files}
<wx/textdlg.h>
\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
@ -367,6 +381,10 @@ If Cancel is pressed, -1 is returned.
If {\it centre} is TRUE, the message text (which may include new line characters)
is centred; if FALSE, the message is left-justified.
\wxheading{Include files}
<wx/choicdlg.h>
\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
@ -382,6 +400,10 @@ Cancel to return NULL.
If {\it centre} is TRUE, the message text (which may include new line characters)
is centred; if FALSE, the message is left-justified.
\wxheading{Include files}
<wx/choicdlg.h>
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
@ -391,6 +413,10 @@ is centred; if FALSE, the message is left-justified.
As {\bf wxGetSingleChoice} but returns the index representing the selected string.
If the user pressed cancel, -1 is returned.
\wxheading{Include files}
<wx/choicdlg.h>
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
@ -400,6 +426,10 @@ If the user pressed cancel, -1 is returned.
As {\bf wxGetSingleChoice} but takes an array of client data pointers
corresponding to the strings, and returns one of these pointers.
\wxheading{Include files}
<wx/choicdlg.h>
\membersection{::wxMessageBox}\label{wxmessagebox}
\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
@ -442,10 +472,18 @@ is specified in the style, in which case a generic function is used.
This is because the native MessageBox function cannot centre text.
The symbols are not shown when the generic function is used.
\wxheading{Include files}
<wx/msgdlg.h>
\section{GDI functions}\label{gdifunctions}
The following are relevant to the GDI (Graphics Device Interface).
\wxheading{Include files}
<wx/gdicmn.h>
\membersection{::wxColourDisplay}
\func{bool}{wxColourDisplay}{\void}
@ -498,6 +536,10 @@ See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowset
The following functions are used to control PostScript printing. Under
Windows, PostScript output can only be sent to a file.
\wxheading{Include files}
<wx/dcps.h>
\membersection{::wxGetPrinterCommand}
\func{wxString}{wxGetPrinterCommand}{\void}
@ -600,6 +642,10 @@ Sets the translation (from the top left corner) for PostScript output. The defau
These clipboard functions are implemented for Windows only.
\wxheading{Include files}
<wx/clipbrd.h>
\membersection{::wxClipboardOpen}
\func{bool}{wxClipboardOpen}{\void}
@ -697,19 +743,27 @@ The clipboard must have previously been opened for this call to succeed.
\section{Miscellaneous functions}\label{miscellany}
\membersection{::NewId}
\membersection{::wxNewId}
\func{long}{NewId}{\void}
\func{long}{wxNewId}{\void}
Generates an integer identifier unique to this run of the program.
\membersection{::RegisterId}
\wxheading{Include files}
\func{void}{RegisterId}{\param{long}{ id}}
<wx/utils.h>
\membersection{::wxRegisterId}
\func{void}{wxRegisterId}{\param{long}{ id}}
Ensures that ids subsequently generated by {\bf NewId} do not clash with
the given {\bf id}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
@ -721,20 +775,19 @@ ensures that only the outer calls take effect.
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxBell}
\func{void}{wxBell}{\void}
Ring the system bell.
\membersection{::wxCleanUp}\label{wxcleanup}
\wxheading{Include files}
\func{void}{wxCleanUp}{\void}
Normally, wxWindows will call this cleanup function for you. However, if
you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
manually, then you should also call wxCleanUp before terminating wxWindows,
if wxWindows does not get a chance to do it.
<wx/utils.h>
\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
@ -752,6 +805,10 @@ called by the application.
See also helpref{wxDDEInitialize}{wxddeinitialize}.
\wxheading{Include files}
<wx/dde.h>
\membersection{::wxDDEInitialize}\label{wxddeinitialize}
\func{void}{wxDDEInitialize}{\void}
@ -764,6 +821,10 @@ by wxWindows if necessary.
See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
\helpref{wxDDECleanUp}{wxddecleanup}.
\wxheading{Include files}
<wx/dde.h>
\membersection{::wxDebugMsg}\label{wxdebugmsg}
\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
@ -787,18 +848,26 @@ instead.
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxDisplaySize}
\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
Gets the physical size of the display in pixels.
\wxheading{Include files}
<wx/gdicmn.h>
\membersection{::wxEntry}\label{wxentry}
This initializes wxWindows in a platform-dependent way. Use this if you
are not using the default wxWindows entry code (e.g. main or WinMain). For example,
you can initialize wxWindows from an Microsoft Foundation Classes application using
this function. See also \helpref{wxCleanUp}{wxcleanup}.
this function.
\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
\param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
@ -816,6 +885,26 @@ wxWindows initialization under Windows (for applications constructed as a DLL).
wxWindows initialization under Unix.
\wxheading{Remarks}
To clean up wxWindows, call wxApp::OnExit followed by the static function
wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
\begin{verbatim}
int CTheApp::ExitInstance()
{
// OnExit isn't called by CleanUp so must be called explicitly.
wxTheApp->OnExit();
wxApp::CleanUp();
return CWinApp::ExitInstance();
}
\end{verbatim}
\wxheading{Include files}
<wx/app.h>
\membersection{::wxError}\label{wxerror}
\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
@ -824,6 +913,10 @@ Displays {\it msg} and continues. This writes to standard error under
Unix, and pops up a message box under Windows. Used for internal
wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
\func{void}{wxEndBusyCursor}{\void}
@ -833,6 +926,10 @@ Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxExecute}\label{wxexecute}
\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
@ -859,6 +956,10 @@ the process finishes.
See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxExit}\label{wxexit}
\func{void}{wxExit}{\void}
@ -868,6 +969,10 @@ Should only be used in an emergency: normally the top-level frame
should be deleted (after deleting all other frames) to terminate the
application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
\wxheading{Include files}
<wx/app.h>
\membersection{::wxFatalError}\label{wxfatalerror}
\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
@ -876,12 +981,20 @@ Displays {\it msg} and exits. This writes to standard error under Unix,
and pops up a message box under Windows. Used for fatal internal
wxWindows errors. See also \helpref{wxError}{wxerror}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxFindMenuItemId}
\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
Find a menu item identifier associated with the given frame's menu bar.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxFindWindowByLabel}
\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
@ -891,6 +1004,10 @@ or panel item label. If {\it parent} is NULL, the search will start from all top
frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
The search is recursive in both cases.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
@ -902,24 +1019,40 @@ The search is recursive in both cases.
If no such named window is found, {\bf wxFindWindowByLabel} is called.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
\func{wxWindow *}{wxGetActiveWindow}{\void}
Gets the currently active window (Windows only).
\wxheading{Include files}
<wx/windows.h>
\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
\func{wxString}{wxGetDisplayName}{\void}
Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetHomeDir}
\func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
Fills the buffer with a string representing the user's home directory (Unix only).
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetHostName}
\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
@ -929,6 +1062,10 @@ buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
successful. Under Unix, this will return a machine name. Under Windows,
this returns ``windows''.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
@ -940,6 +1077,10 @@ by this call.
See also \helpref{wxTimer}{wxtimer}.
\wxheading{Include files}
<wx/timer.h>
\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
\func{long}{wxGetFreeMemory}{\void}
@ -948,12 +1089,20 @@ Returns the amount of free memory in Kbytes under environments which
support it, and -1 if not supported. Currently, returns a positive value
under Windows, and -1 under Unix.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetMousePosition}
\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
Returns the mouse position in screen coordinates.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetOsVersion}
\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
@ -973,6 +1122,10 @@ Gets operating system version information.
\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
\end{twocollist}
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetResource}\label{wxgetresource}
\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
@ -1003,6 +1156,10 @@ the overloading of the function for different types.
See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetUserId}
\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
@ -1011,6 +1168,10 @@ Copies the user's login identity (such as ``jacs'') into the buffer {\it
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
Under Windows, this returns ``user''.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxGetUserName}
\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
@ -1019,6 +1180,10 @@ Copies the user's name (such as ``Julian Smart'') into the buffer {\it
buf}, of maximum size {\it bufSize}, returning TRUE if successful.
Under Windows, this returns ``unknown''.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxKill}\label{wxkill}
\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
@ -1029,12 +1194,9 @@ Returns 0 on success, -1 on failure.
Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
It does not raise a signal in the receiving process.
\membersection{::wxInitClipboard}\label{wxinitclipboard}
\wxheading{Include files}
\func{void}{wxInitClipboard}{\void}
Initializes the generic clipboard system by creating an instance of
the class \helpref{wxClipboard}{wxclipboard}.
<wx/utils.h>
\membersection{::wxIsBusy}\label{wxisbusy}
@ -1045,6 +1207,10 @@ Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\r
See also \helpref{wxBusyCursor}{wxbusycursor}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxLoadUserResource}\label{wxloaduserresource}
\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
@ -1066,23 +1232,35 @@ using \helpref{wxResourceParseString}{wxresourceparsestring}.
This function is available under Windows only.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxNow}\label{wxnow}
\func{wxString}{wxNow}{\void}
Returns a string representing the current date and time.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxPostDelete}\label{wxpostdelete}
\func{void}{wxPostDelete}{\param{wxObject *}{object}}
Under X, tells the system to delete the specified object when
Tells the system to delete the specified object when
all other events have been processed. In some environments, it is
necessary to use this instead of deleting a frame directly with the
delete operator, because X will still send events to the window.
delete operator, because some GUIs will still send events to a deleted window.
Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
@ -1094,6 +1272,10 @@ displays to be used.
See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxShell}\label{wxshell}
\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
@ -1103,12 +1285,20 @@ specified, then just the shell is spawned.
See also \helpref{wxExecute}{wxexecute}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxSleep}\label{wxsleep}
\func{void}{wxSleep}{\param{int}{ secs}}
Sleeps for the specified number of seconds.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxStripMenuCodes}
\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
@ -1121,6 +1311,10 @@ in {\it out} (or returns the new string, in the first form).
Menu codes include \& (mark the next character with an underline
as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxStartTimer}\label{wxstarttimer}
\func{void}{wxStartTimer}{\void}
@ -1129,18 +1323,30 @@ Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get th
See also \helpref{wxTimer}{wxtimer}.
\wxheading{Include files}
<wx/timer.h>
\membersection{::wxToLower}\label{wxtolower}
\func{char}{wxToLower}{\param{char }{ch}}
Converts the character to lower case. This is implemented as a macro for efficiency.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxToUpper}\label{wxtoupper}
\func{char}{wxToUpper}{\param{char }{ch}}
Converts the character to upper case. This is implemented as a macro for efficiency.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxTrace}\label{wxtrace}
\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
@ -1150,6 +1356,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
\wxheading{Include files}
<wx/memory.h>
\membersection{::wxTraceLevel}\label{wxtracelevel}
\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
@ -1162,6 +1372,10 @@ this value.
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
\wxheading{Include files}
<wx/memory.h>
\membersection{::wxWriteResource}\label{wxwriteresource}
\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
@ -1189,6 +1403,10 @@ file under Unix, although the WIN.INI file is fair game under Windows.
See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
<wx/utils.h>
\membersection{::wxYield}
\func{bool}{wxYield}{\void}
@ -1203,6 +1421,10 @@ user to perform actions which are not compatible with the current task.
Disabling menu items or whole menus during processing can avoid unwanted
reentrance of code.
\wxheading{Include files}
<wx/utils.h>
\section{Macros}\label{macros}
These macros are defined in wxWindows.
@ -1213,6 +1435,10 @@ These macros are defined in wxWindows.
Returns a pointer to the wxClassInfo object associated with this class.
\wxheading{Include files}
<wx/object.h>
\membersection{WXDEBUG\_NEW}\label{debugnew}
\func{}{WXDEBUG\_NEW}{arg}
@ -1226,6 +1452,10 @@ with filename and line number arguments. The definition is:
In non-debug mode, this is defined as the normal new operator.
\wxheading{Include files}
<wx/object.h>
\membersection{DECLARE\_ABSTRACT\_CLASS}
\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
@ -1248,6 +1478,10 @@ class wxCommand: public wxObject
};
\end{verbatim}
\wxheading{Include files}
<wx/object.h>
\membersection{DECLARE\_APP}\label{declareapp}
\func{}{DECLARE\_APP}{className}
@ -1261,6 +1495,10 @@ Example:
DECLARE_APP(MyApp)
\end{verbatim}
\wxheading{Include files}
<wx/app.h>
\membersection{DECLARE\_CLASS}
\func{}{DECLARE\_CLASS}{className}
@ -1269,6 +1507,10 @@ Used inside a class declaration to declare that the class should be
made known to the class hierarchy, but objects of this class cannot be created
dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
\wxheading{Include files}
<wx/object.h>
\membersection{DECLARE\_DYNAMIC\_CLASS}
\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
@ -1290,6 +1532,10 @@ class wxFrame: public wxWindow
};
\end{verbatim}
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
@ -1308,6 +1554,10 @@ wxCommand::wxCommand(void)
}
\end{verbatim}
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
@ -1315,6 +1565,10 @@ wxCommand::wxCommand(void)
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_APP}\label{implementapp}
\func{}{IMPLEMENT\_APP}{className}
@ -1336,6 +1590,10 @@ New form:
See also \helpref{DECLARE\_APP}{declareapp}.
\wxheading{Include files}
<wx/app.h>
\membersection{IMPLEMENT\_CLASS}
\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
@ -1343,6 +1601,10 @@ See also \helpref{DECLARE\_APP}{declareapp}.
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_CLASS2}
\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
@ -1351,6 +1613,10 @@ Used in a C++ implementation file to complete the declaration of a
class that has run-time type information and two base classes. The
same as IMPLEMENT\_ABSTRACT\_CLASS2.
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
@ -1370,6 +1636,10 @@ wxFrame::wxFrame(void)
}
\end{verbatim}
\wxheading{Include files}
<wx/object.h>
\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
@ -1379,6 +1649,10 @@ a class that has run-time type information, and whose instances
can be created dynamically. Use this for classes derived from two
base classes.
\wxheading{Include files}
<wx/object.h>
\membersection{WXTRACE}\label{trace}
\func{}{WXTRACE}{formatString, ...}
@ -1388,6 +1662,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
\wxheading{Include files}
<wx/memory.h>
\membersection{WXTRACELEVEL}\label{tracelevel}
\func{}{WXTRACELEVEL}{level, formatString, ...}
@ -1400,6 +1678,10 @@ this value.
This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
\wxheading{Include files}
<wx/memory.h>
\section{wxWindows resource functions}\label{resourcefuncs}
\overview{wxWindows resource system}{resourceformats}
@ -1416,6 +1698,8 @@ as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminol
See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
loading from resource data.
{\bf Warning:} this needs updating for wxWindows 2.
\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
@ -1600,6 +1884,10 @@ Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
further information.
\wxheading{Include files}
<wx/log.h>
\membersection{::wxLogError}\label{wxlogerror}
\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
@ -1693,6 +1981,10 @@ Useful macros and functins for error checking and defensive programming. ASSERTs
compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
builds.
\wxheading{Include files}
<wx/debug.h>
\membersection{::wxOnAssert}\label{wxonassert}
\func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}

View File

@ -10,6 +10,10 @@ There are no user commands for the gauge.
\helpref{wxEvtHandler}{wxEvtHandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gauge.h>
\wxheading{Window styles}
\twocolwidtha{5cm}

View File

@ -11,6 +11,10 @@ Since the functionality of this class is platform-specific, it is not documented
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/gdiobj.h>
\wxheading{See also}
\helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush}, \helpref{wxFont}{wxfont}

View File

@ -9,6 +9,10 @@ wxGrid is a class for displaying and editing tabular information.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/grid.h>
\wxheading{Window styles}
There are no specific window styles for this class.

View File

@ -8,6 +8,10 @@ key.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/hash.h>
\wxheading{Example}
Below is an example of using a hash table.

View File

@ -25,14 +25,14 @@ There are currently the following help controller classes defined:
The default browser is Netscape Navigator.
\end{itemize}
\wxheading{Derivation}
\wxheading{Derived from}
wxHelpControllerBase\\
\helpref{wxObject}{wxobject}
\wxheading{Include file}
\wxheading{Include files}
{\tt <wx/help.h>}
<wx/help.h>
\latexignore{\rtfignore{\wxheading{Members}}}

View File

@ -34,6 +34,10 @@ For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverv
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/icon.h>
\wxheading{See also}
\helpref{Bitmap and icon overview}{wxbitmapoverview}, \helpref{supported bitmap file formats}{supportedbitmapformats},

View File

@ -7,6 +7,10 @@ This class is used for idle events, which are generated when the system is idle.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process an idle event, use this event handler macro to direct input to a member

View File

@ -10,6 +10,10 @@ which means that their values should be calculated by looking at known constrain
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/layout.h>
\wxheading{See also}
\helpref{Overview and examples}{constraintsoverview},\rtfsp

View File

@ -14,6 +14,10 @@ wxDC::DrawBitmap.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/image.h>
\wxheading{See also}
\helpref{wxBitmap}{wxbitmap}
@ -465,8 +469,7 @@ application initialisation.
\wxheading{Note (Legal Issue)}
This software is based in part on the work of
the Independent JPEG Group.
This software is based in part on the work of the Independent JPEG Group.
(Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg
created by IJG.)
@ -475,6 +478,10 @@ created by IJG.)
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/image.h>
\wxheading{See also}
\helpref{wxImage}{wximage}

View File

@ -12,6 +12,10 @@ wxImageList is used principally in conjunction with \helpref{wxTreeCtrl}{wxtreec
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/imaglist.h>
\wxheading{See also}
\helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxListCtrl}{wxlistctrl}

View File

@ -8,6 +8,10 @@ Handlers for this event can transfer data to the window.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process an activate event, use these event handler macros to direct input to a member

View File

@ -7,6 +7,10 @@
\helpref{wxStreamBase}{wxstreambase}
\wxheading{Include files}
<wx/stream.h>
\wxheading{See also}
\helpref{wxStreamBuffer}{wxstreambuffer}

View File

@ -7,6 +7,10 @@ events received by windows.
\helpref{wxEvent}{wxevent}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a mouse event, use these event handler macros to direct input to member

View File

@ -6,6 +6,10 @@ wxJoystick allows an application to control one or more joysticks.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/joystick.h>
\wxheading{See also}
\helpref{wxJoystickEvent}{wxjoystickevent}

View File

@ -6,6 +6,10 @@ This event class contains information about keypress (character) events.
\helpref{wxEvent}{wxevent}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a key event, use these event handler macros to direct input to member

View File

@ -58,6 +58,10 @@ way of specifying layouts for which the normal constraint system is unsuitable.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/laywin.h>
\wxheading{Event handling}
The algorithm object does not respond to events, but itself generates the

View File

@ -30,6 +30,10 @@ not be changed.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/layout.h>
\wxheading{See also}
\helpref{Overview and examples}{constraintsoverview},\rtfsp

View File

@ -72,6 +72,10 @@ future versions completely.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/list.h>
\wxheading{Example}
It is very common to iterate on a list as follows:

View File

@ -19,6 +19,10 @@ wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/listbox.h>
\wxheading{Window styles}
\twocolwidtha{5cm}%

View File

@ -12,6 +12,10 @@ To intercept events from a list control, use the event table macros described in
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/listctrl.h>
\wxheading{Window styles}
\twocolwidtha{5cm}

View File

@ -8,6 +8,10 @@ A list event holds information about events associated with wxListCtrl objects.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/listctrl.h>
\wxheading{Event table macros}
To process input from a list control, use these event handler macros to direct input to member

View File

@ -19,6 +19,10 @@ logging facilities.
No base class
\wxheading{Include files}
<wx/log.h>
\latexignore{\rtfignore{\wxheading{Function groups}}}
\membersection{Static functions}

View File

@ -7,6 +7,10 @@ the unmasked area is white.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/bitmap.h>
\wxheading{Remarks}
A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when

View File

@ -10,6 +10,10 @@ which is itself a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/mdi.h>
\wxheading{Window styles}
\twocolwidtha{5cm}
@ -153,6 +157,10 @@ more \helpref{wxMDIChildFrame}{wxmdichildframe} objects.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/mdi.h>
\wxheading{Remarks}
The client window is the area where MDI child windows exist. It doesn't have to cover the whole
@ -225,6 +233,10 @@ and is used in many popular Windows applications, such as Microsoft Word(TM).
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/mdi.h>
\wxheading{Remarks}
There may be multiple MDI parent frames in a single application, but this probably only makes sense

View File

@ -7,6 +7,10 @@ A memory device context provides a means to draw graphics onto a bitmap.
\helpref{wxDC}{wxdc}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/dcmemory.h>
\wxheading{Remarks}
A bitmap must be selected into the new memory DC before it may be used

View File

@ -12,6 +12,10 @@ identify the selection, or to change the menu item in some way.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/menu.h>
\wxheading{Event handling}
If the menu is part of a menubar, then \helpref{wxMenuBar}{wxmenubar} event processing is used.
@ -351,6 +355,10 @@ A menu bar is a series of menus accessible from the top of a frame.
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/menu.h>
\wxheading{Event handling}
To respond to a menu selection, provide a handler for EVT\_MENU, in the frame

View File

@ -8,6 +8,10 @@ these do not include menu command events.
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a menu event, use these event handler macros to direct input to member

View File

@ -9,6 +9,10 @@ bitmaps can be achieved via wxMenu on all platforms.
wxOwnerDrawn (Windows only)\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/menuitem.h>
\wxheading{See also}
\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}

View File

@ -10,6 +10,10 @@ is to use a wxMetafileDC.
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/metafile.h>
\wxheading{See also}
\helpref{wxMetafileDC}{wxmetafiledc}
@ -94,6 +98,10 @@ closing your disk-based metafile device context.
\helpref{wxDC}{wxdc}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/metafile.h>
\wxheading{See also}
\helpref{wxMetafile}{wxmetafile}, \helpref{wxDC}{wxdc}

View File

@ -22,14 +22,14 @@ provided to load additional files.
NB: Currently, wxMimeTypesManager is limited to reading MIME type information
but it will support modifying it as well in the future versions.
\wxheading{Required headers}
<wx/mimetype.h>
\wxheading{Derived from}
No base class.
\wxheading{Include files}
<wx/mimetype.h>
\wxheading{See also}
\helpref{wxFileType}{wxfiletype}

Some files were not shown because too many files have changed in this diff Show More