AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Removed a lot of redundant references to wxWindow::On... functions.

Browse Source 
Added initial artprov.tex.
Sorted out duff references.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15035 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 2002-04-08 16:46:27 +00:00
parent 6ce27aa2fd
commit f4fcc29197
34 changed files with 248 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/latex/wx/activevt.tex
View File

@ -34,7 +34,7 @@ or a frame becomes inactivate resulting in all application frames being inactive
\wxheading{See also}
\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
%\helpref{wxWindow::OnActivate}{wxwindowonactivate},\rtfsp
%% GD: OnXXX functions are not documented
%%\helpref{wxApp::OnActivate}{wxapponactivate},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}

2
docs/latex/wx/app.tex
View File

@ -424,7 +424,6 @@ Under Windows, OnQueryEndSession is called in response to the WM\_QUERYENDSESSIO
\wxheading{See also}
\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
\helpref{wxCloseEvent}{wxcloseevent}
%% GD: OnXXX functions are not documented
%%\helpref{wxApp::OnEndSession}{wxapponendsession}
@ -482,7 +481,6 @@ If TRUE is returned, more OnIdle processing is requested by one or more window.
%% GD: OnXXX functions are not documented
%%\helpref{wxApp::OnIdle}{wxapponidle}
\helpref{wxWindow::OnIdle}{wxwindowonidle},\rtfsp
\helpref{wxIdleEvent}{wxidleevent}
\membersection{wxApp::SetAppName}\label{wxappsetappname}

73
docs/latex/wx/artprov.tex Normal file
View File

@ -0,0 +1,73 @@
%
% automatically generated by HelpGen $Revision$ from
% artprov.h at 08/Apr/02 17:44:57
%
\section{\class{wxArtProvider}}\label{wxartprovider}
wxArtProvider class.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/artprov.h>
\wxheading{Data structures}
{\small \begin{verbatim}
typedef wxString wxArtClient
typedef wxString wxArtID
\end{verbatim}}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxArtProvider::CleanUpProviders}\label{wxartprovidercleanupproviders}
\func{void}{CleanUpProviders}{\void}
Destroy caches and all providers.
\membersection{wxArtProvider::CreateBitmap}\label{wxartprovidercreatebitmap}
\func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{WXUNUSED(id)}, \param{const wxArtClient\& }{WXUNUSED(client)}, \param{const wxSize\& }{WXUNUSED(size)}}
Derived classes must override this method to create requested
art resource. This method is called only once per instance's
lifetime for each requested wxArtID.
\membersection{wxArtProvider::GetBitmap}\label{wxartprovidergetbitmap}
\func{wxBitmap}{GetBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
Query the providers for bitmap with given ID and return it. Return
wxNullBitmap if no provider provides it.
\membersection{wxArtProvider::GetIcon}\label{wxartprovidergeticon}
\func{wxIcon}{GetIcon}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
Query the providers for icon with given ID and return it. Return
wxNullIcon if no provider provides it.
\membersection{wxArtProvider::PopProvider}\label{wxartproviderpopprovider}
\func{bool}{PopProvider}{\void}
Remove latest added provider and delete it.
\membersection{wxArtProvider::PushProvider}\label{wxartproviderpushprovider}
\func{void}{PushProvider}{\param{wxArtProvider* }{provider}}
Add new provider to the top of providers stack.
\membersection{wxArtProvider::RemoveProvider}\label{wxartproviderremoveprovider}
\func{bool}{RemoveProvider}{\param{wxArtProvider* }{provider}}
Remove provider. The provider must have been added previously.
The provider is {\it not} deleted.

2
docs/latex/wx/category.tex
View File

@ -300,7 +300,7 @@ 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}}

3
docs/latex/wx/classes.tex
View File

@ -10,6 +10,7 @@
\input app.tex
\input array.tex
\input arrstrng.tex
\input artprov.tex
\input autoobj.tex
\input bitmap.tex
\input bbutton.tex
@ -218,7 +219,7 @@
\input paintevt.tex
\input palette.tex
\input panel.tex
\input pantabv.tex
%\input pantabv.tex
\input pathlist.tex
\input pen.tex
\input plotcurve.tex

15
docs/latex/wx/closeevt.tex
View File

@ -2,6 +2,20 @@
This event class contains information about window and session close events.
The handler function for EVT\_CLOSE is called when the user has tried to close a a frame
or dialog box using the window manager (X) or system menu (Windows). It is
called via the \helpref{wxWindow::Close}{wxwindowclose} function, so
that the application can also invoke the handler programmatically.
You should check whether the application is forcing the deletion of the window
using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}. If this is {\tt FALSE},
you {\it must} destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
If the return value is TRUE, it is up to you whether you respond by destroying the window.
If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to
let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function
to return {\tt TRUE} or {\tt FALSE} depending on whether the close instruction was honoured or not.
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}
@ -27,7 +41,6 @@ This event applies to wxApp only.}
\wxheading{See also}
\helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession},\rtfsp
%% GD: OnXXX functions are not documented

6
docs/latex/wx/dialog.tex
View File

@ -27,7 +27,7 @@ be created by Dialog Editor. For details,
see \helpref{The wxWindows resource system}{resourceformats}, \helpref{wxWindows resource functions}{resourcefuncs} and
the resource sample.
An application can define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the
An application can define an \helpref{wxCloseEvent}{wxcloseevent} handler for the
dialog to respond to system close events.
\wxheading{Window styles}
@ -214,7 +214,7 @@ Returns TRUE if the dialog box is modal, FALSE otherwise.
This member is called to allow the window to intercept keyboard events
before they are processed by child windows.
For more information, see \helpref{wxWindow::OnCharHook}{wxwindowoncharhook}
%For more information, see \helpref{wxWindow::OnCharHook}{wxwindowoncharhook}
\wxheading{Remarks}
@ -282,7 +282,7 @@ The default handler for wxEVT\_SYS\_COLOUR\_CHANGED.
Changes the dialog's colour to conform to the current settings (Windows only).
Add an event table entry for your dialog class if you wish the behaviour
to be different (such as keeping a user-defined
background colour). If you do override this function, call \helpref{wxWindow::OnSysColourChanged}{wxwindowonsyscolourchanged} to
background colour). If you do override this function, call wxEvent::Skip to
propagate the notification to child windows and controls.
\wxheading{See also}

5
docs/latex/wx/dropevt.tex
View File

@ -2,6 +2,8 @@
This class is used for drop files events, that is, when files have been dropped
onto the window. This functionality is currently only available under Windows.
The window must have previously been enabled for dropping by calling
\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}.
Important note: this is a separate implementation to the more general
drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the
@ -28,7 +30,8 @@ function that takes a wxDropFilesEvent argument.
\wxheading{See also}
\helpref{wxWindow::OnDropFiles}{wxwindowondropfiles}, \helpref{Event handling overview}{eventhandlingoverview}
%\helpref{wxWindow::OnDropFiles}{wxwindowondropfiles},
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

13
docs/latex/wx/eraseevt.tex
View File

@ -2,6 +2,16 @@
An erase event is sent when a window's background needs to be repainted.
On some platforms, such as GTK+, this event is simulated (simply generated just before the
paint event) and may cause flicker. It is therefore recommended that
you set the text background colour explicitly in order to prevent flicker.
The default background colour under GTK+ is grey.
To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table definition.
You must call wxEraseEvent::GetDC and use the returned device context if it is non-NULL.
If it is NULL, create your own temporary wxClientDC object.
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}\\
@ -28,7 +38,8 @@ the event handler.
\wxheading{See also}
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}, \helpref{Event handling overview}{eventhandlingoverview}
%\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground},
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

4
docs/latex/wx/focusevt.tex
View File

@ -24,8 +24,8 @@ function that takes a wxFocusEvent argument.
\wxheading{See also}
\helpref{wxWindow::OnSetFocus}{wxwindowonsetfocus},\rtfsp
\helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
%\helpref{wxWindow::OnSetFocus}{wxwindowonsetfocus},\rtfsp
%\helpref{wxWindow::OnKillFocus}{wxwindowonkillfocus},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

17
docs/latex/wx/frame.tex
View File

@ -63,7 +63,7 @@ See also \helpref{window styles overview}{windowstyles}.
\wxheading{Remarks}
An application should normally define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the
An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the
frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
\wxheading{See also}
@ -400,29 +400,26 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}.
\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}.
\membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand}
\func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}}
See \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand}.
\membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight}
\func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}}
See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}.
The default implementation displays an appropriate help string
in the status bar, if there is one.
See \helpref{wxMenuEvent}{wxmenuevent}.
\membersection{wxFrame::OnSize}\label{wxframeonsize}
\func{void}{OnSize}{\param{wxSizeEvent\& }{event}}
See \helpref{wxWindow::OnSize}{wxwindowonsize}.
The default {\bf wxFrame::OnSize} implementation looks for a single subwindow,
and if one is found, resizes it to fit
inside the frame. Override this member if more complex behaviour
is required (for example, if there are several subwindows).
See \helpref{wxSizeEvent}{wxsizeevent}.
\membersection{wxFrame::SetIcon}\label{wxframeseticon}
\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}

31
docs/latex/wx/function.tex
View File

@ -37,7 +37,7 @@ the corresponding topic.
\helpref{wxCHECK\_VERSION}{wxcheckversion}\\
\helpref{wxCHECK}{wxcheck}\\
\helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
\helpref{wxClipboardOpen}{wxclipboardopen}\\
\helpref{wxClipboardOpen}{functionwxclipboardopen}\\
\helpref{wxCloseClipboard}{wxcloseclipboard}\\
\helpref{wxColourDisplay}{wxcolourdisplay}\\
\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
@ -51,12 +51,11 @@ the corresponding topic.
\helpref{wxDDEInitialize}{wxddeinitialize}\\
\helpref{wxDROP\_ICON}{wxdropicon}\\
\helpref{wxDebugMsg}{wxdebugmsg}\\
\helpref{wxDirExists}{wxdirexists}\\
\helpref{wxDirExists}{functionwxdirexists}\\
\helpref{wxDirSelector}{wxdirselector}\\
\helpref{wxDisplayDepth}{wxdisplaydepth}\\
\helpref{wxDisplaySize}{wxdisplaysize}\\
\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
\helpref{wxDisplaySize}{wxdisplaysize}\\
\helpref{wxDisplaySize}{wxdisplaysize}\\
\helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
\helpref{wxDynamicCast}{wxdynamiccast}\\
@ -71,7 +70,7 @@ the corresponding topic.
\helpref{wxFAIL\_MSG}{wxfailmsg}\\
\helpref{wxFAIL}{wxfail}\\
\helpref{wxFatalError}{wxfatalerror}\\
\helpref{wxFileExists}{wxfileexists}\\
\helpref{wxFileExists}{functionwxfileexists}\\
\helpref{wxFileModificationTime}{wxfilemodificationtime}\\
\helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
\helpref{wxFileSelector}{wxfileselector}\\
@ -519,7 +518,7 @@ terminated with a NULL pointer.}
Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
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}.
application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}.
\wxheading{Include files}
@ -661,7 +660,7 @@ threads.
\helpref{wxFile}{wxfile}\\
\helpref{wxFileName}{wxfilename}
\membersection{::wxDirExists}\label{wxdirexists}
\membersection{::wxDirExists}\label{functionwxdirexists}
\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
@ -674,7 +673,7 @@ Returns TRUE if the directory exists.
Converts a DOS to a Unix filename by replacing backslashes with forward
slashes.
\membersection{::wxFileExists}\label{wxfileexists}
\membersection{::wxFileExists}\label{functionwxfileexists}
\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
@ -1960,7 +1959,7 @@ class instead.
<wx/clipbrd.h>
\membersection{::wxClipboardOpen}\label{wxclipboardopen}
\membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
\func{bool}{wxClipboardOpen}{\void}
@ -2107,16 +2106,6 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
<wx/dde.h>
\membersection{::wxDisplaySize}\label{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{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
@ -2363,7 +2352,7 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
<wx/utils.h>
\section{Byte order macros}\label{macros}
\section{Byte order macros}\label{byeordermacros}
The endian-ness issues (that is the difference between big-endian and
little-endian architectures) are important for the portable programs working
@ -2421,7 +2410,7 @@ been compiled on a big-endian architecture, the value will be unchanged.
Use these macros to read data from and write data to a file that stores
data in big-endian format.
\section{RTTI functions}\label{macros}
\section{RTTI functions}\label{rttimacros}
wxWindows uses its own RTTI ("run-time type identification") system which
predates the current standard C++ RTTI and so is kept for backwards

2
docs/latex/wx/indlgevt.tex
View File

@ -2,6 +2,7 @@
A wxInitDialogEvent is sent as a dialog or panel is being initialised.
Handlers for this event can transfer data to the window.
The default handler calls \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}.
\wxheading{Derived from}
@ -24,7 +25,6 @@ function that takes a wxInitDialogEvent argument.
\wxheading{See also}
\helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

4
docs/latex/wx/keyevent.tex
View File

@ -50,6 +50,9 @@ similar to but slightly different from Windows {\tt WM\_KEYDOWN} and
{\tt WM\_CHAR} events. In particular, Alt-x combination will generate a char
event in wxWindows (unless it is used as an acclerator).
{\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in
key event function, otherwise menu shortcuts may cease to work under Windows.
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}
@ -205,4 +208,3 @@ be still processed normally).
Returns TRUE if the shift key was down at the time of the key event.

1
docs/latex/wx/mdi.tex
View File

@ -432,7 +432,6 @@ automatically by the client window.
\helpref{wxMDIParentFrame::GetToolBar}{wxmdiparentframegettoolbar},\rtfsp
\helpref{wxMDIParentFrame::SetToolBar}{wxmdiparentframesettoolbar},\rtfsp
\helpref{wxWindow}{wxwindowonsize},\rtfsp
\helpref{wxMDIClientWindow}{wxmdiclientwindow}

6
docs/latex/wx/menuevt.tex
View File

@ -1,7 +1,11 @@
\section{\class{wxMenuEvent}}\label{wxmenuevent}
This class is used for a variety of menu-related events. Note that
these do not include menu command events.
these do not include menu command events, which are
handled using \helpref{wxCommandEvent}{wxcommandevent} objects.
The handler \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
text in the first field of the status bar.
\wxheading{Derived from}

12
docs/latex/wx/mouseevt.tex
View File

@ -8,21 +8,21 @@ for the middle one and $3$ for the right one. Note that not all mice have
a middle button so a portable application should avoid relying on the events
from it.
{\bf NB: } Note that under Windows mouse enter and leave events are not natively supported
{\bf NB:} Note that under Windows mouse enter and leave events are not natively supported
by the system but are generated by wxWindows itself. This has several
drawbacks: the LEAVE\_WINDOW event might be received some time after the mouse
left the window and the state variables for it may have changed during this
time.
{\bf NB: } Note the difference between methods like
\helpref{LeftDown}{wxmouseeventleftdown} and
\helpref{LeftIsDown}{wxmouseeventleftisdown}: the formet returns {\tt TRUE}
{\bf NB:} Note the difference between methods like
\helpref{LeftDown}{wxmouseeventleftdown} and
\helpref{LeftIsDown}{wxmouseeventleftisdown}: the format returns {\tt TRUE}
when the event corresponds to the left mouse button click while the latter
returns {\tt TRUE} if the left mouse button is currently being pressed. For
example, when the user is dragging the mouse you can use
example, when the user is dragging the mouse you can use
\helpref{LeftIsDown}{wxmouseeventleftisdown} to test
whether the left mouse button is (still) depressed. Also, by convention, if
\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE},
\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE},
\helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt TRUE} in
wxWindows whatever the underlying GUI behaviour is (which is
platform-dependent). The same applies, of course, to other mouse buttons as

2
docs/latex/wx/moveevt.tex
View File

@ -24,7 +24,7 @@ when a window is moved.}
\wxheading{See also}
\helpref{wxWindow::OnMove}{wxwindowonmove}, \helpref{wxPoint}{wxpoint}, \helpref{Event handling overview}{eventhandlingoverview}
\helpref{wxPoint}{wxpoint}, \helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

64
docs/latex/wx/paintevt.tex
View File

@ -23,7 +23,69 @@ function that takes a wxPaintEvent argument.
\wxheading{See also}
\helpref{wxWindow::OnPaint}{wxwindowonpaint}, \helpref{Event handling overview}{eventhandlingoverview}
%\helpref{wxWindow::OnPaint}{wxwindowonpaint},
\helpref{Event handling overview}{eventhandlingoverview}
\wxheading{Remarks}
Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object,
even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong.
For example:
\small{%
\begin{verbatim}
void MyWindow::OnPaint(wxPaintEvent\& event)
{
wxPaintDC dc(this);
DrawMyDocument(dc);
}
\end{verbatim}
}%
You can optimize painting by retrieving the rectangles
that have been damaged and only repainting these. The rectangles are in
terms of the client area, and are unscrolled, so you will need to do
some calculations using the current view position to obtain logical,
scrolled units.
Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
{\small%
\begin{verbatim}
// Called when window needs to be repainted.
void MyWindow::OnPaint(wxPaintEvent\& event)
{
wxPaintDC dc(this);
// Find Out where the window is scrolled to
int vbX,vbY; // Top left corner of client
GetViewStart(&vbX,&vbY);
int vX,vY,vW,vH; // Dimensions of client area in pixels
wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
while (upd)
{
vX = upd.GetX();
vY = upd.GetY();
vW = upd.GetW();
vH = upd.GetH();
// Alternatively we can do this:
// wxRect rect;
// upd.GetRect(&rect);
// Repaint this rectangle
...some code...
upd ++ ;
}
}
\end{verbatim}
}%
\latexignore{\rtfignore{\wxheading{Members}}}

6
docs/latex/wx/panel.tex
View File

@ -101,12 +101,12 @@ The default button is the one activated by pressing the Enter key.
\func{void}{InitDialog}{\void}
Sends an \helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog} event, which
Sends a \helpref{wxInitDialogEvent}{wxinitdialogevent}, which
in turn transfers data to the dialog via validators.
\wxheading{See also}
\helpref{wxWindow::OnInitDialog}{wxwindowoninitdialog}
\helpref{wxInitDialogEvent}{wxinitdialogevent}
\membersection{wxPanel::OnSysColourChanged}\label{wxpanelonsyscolourchanged}
@ -123,7 +123,7 @@ The default handler for wxEVT\_SYS\_COLOUR\_CHANGED.
Changes the panel's colour to conform to the current settings (Windows only).
Add an event table entry for your panel class if you wish the behaviour
to be different (such as keeping a user-defined
background colour). If you do override this function, call \helpref{wxWindow::OnSysColourChanged}{wxwindowonsyscolourchanged} to
background colour). If you do override this function, call wxEvent::Skip to
propagate the notification to child windows and controls.
\wxheading{See also}

4
docs/latex/wx/region.tex
View File

@ -214,7 +214,7 @@ typically when examining the damaged regions of a window within an OnPaint call.
To use it, construct an iterator object on the stack and loop through the
regions, testing the object and incrementing the iterator at the end of the loop.
See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
See \helpref{wxPaintEvent}{wxpaintevent} for an example of use.
\wxheading{Derived from}
@ -226,7 +226,7 @@ See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
\wxheading{See also}
\helpref{wxWindow::OnPaint}{wxwindowonpaint}
\helpref{wxPaintEvent}{wxpaintevent}
\latexignore{\rtfignore{\wxheading{Members}}}

3
docs/latex/wx/scrlwevt.tex
View File

@ -33,7 +33,8 @@ sent as the user drags the thumtrack).}
\wxheading{See also}
\helpref{wxWindow::OnScroll}{wxwindowonscroll}, \helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
%\helpref{wxWindow::OnScroll}{wxwindowonscroll},
\helpref{wxScrollEvent}{wxscrollevent}, \helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

2
docs/latex/wx/scrolbar.tex
View File

@ -274,7 +274,7 @@ When defining your own scrollbar behaviour, you will always need to recalculate
the scrollbar settings when the window size changes. You could therefore put your
scrollbar calculations and SetScrollbar
call into a function named AdjustScrollbars, which can be called initially and also
from a \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
from a \helpref{wxSizeEvent}{wxsizeevent} event handler function.
\wxheading{See also}

13
docs/latex/wx/sizeevt.tex
View File

@ -13,6 +13,19 @@
A size event holds information about size change events.
The EVT\_SIZE handler function will be called when the window has been resized.
You may wish to use this for frames to resize their child windows as appropriate.
Note that the size passed is of
the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
used by the application.
When a window is resized, usually only a small part of the window is damaged and you
may only need to repaint that area. However, if your drawing depends on the size of the window,
you may need to clear the DC explicitly and repaint the whole window. In which case, you
may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}\\

3
docs/latex/wx/sysclevt.tex
View File

@ -32,7 +32,8 @@ or to pass the event on to the window's children explicitly.
\wxheading{See also}
\helpref{wxWindow::OnSysColourChanged}{wxwindowonsyscolourchanged}, \helpref{Event handling overview}{eventhandlingoverview}
%\helpref{wxWindow::OnSysColourChanged}{wxwindowonsyscolourchanged},
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

2
docs/latex/wx/tapp.tex
View File

@ -18,7 +18,7 @@ An application closes by destroying all windows. Because all frames must
be destroyed for the application to exit, it is advisable to use parent
frames wherever possible when creating new frames, so that deleting the
top level frame will automatically delete child frames. The alternative
is to explicitly delete child frames in the top-level frame's \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow}\rtfsp
is to explicitly delete child frames in the top-level frame's \helpref{wxCloseEvent}{wxcloseevent}\rtfsp
handler.
In emergencies the \helpref{wxExit}{wxexit} function can be called to kill the

4
docs/latex/wx/tdc.tex
View File

@ -17,9 +17,9 @@ these device contexts and when you should use them.
\begin{itemize}\itemsep=0pt
\item {\bf wxScreenDC.} Use this to paint on the screen, as opposed to an individual window.
\item {\bf wxClientDC.} Use this to paint on the client area of window (the part without
borders and other decorations), but do not use it from within an \helpref{wxWindow::OnPaint}{wxwindowonpaint} event.
borders and other decorations), but do not use it from within an \helpref{wxPaintEvent}{wxpaintevent}.
\item {\bf wxPaintDC.} Use this to paint on the client area of a window, but {\it only} from
within an \helpref{wxWindow::OnPaint}{wxwindowonpaint} event.
within a \helpref{wxPaintEvent}{wxpaintevent}.
\item {\bf wxWindowDC.} Use this to paint on the whole area of a window, including decorations.
This may not be available on non-Windows platforms.
\end{itemize}

8
docs/latex/wx/tdelwin.tex
View File

@ -10,7 +10,7 @@ to close windows.
When the user clicks on the system close button or system close command,
in a frame or a dialog, wxWindows calls \helpref{wxWindow::Close}{wxwindowclose}. This
in turn generates an EVT\_CLOSE event: see \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow}.
in turn generates an EVT\_CLOSE event: see \helpref{wxCloseEvent}{wxcloseevent}.
It is the duty of the application to define a suitable event handler, and
decide whether or not to destroy the window.
@ -53,9 +53,9 @@ In other words, by default, the dialog {\it is not destroyed} (it might have bee
on the stack, so the assumption of dynamic creation cannot be made).
The default close event handler for wxFrame destroys the frame using Destroy().
Under Windows, wxDialog defines a handler for \helpref{wxWindow::OnCharHook}{wxwindowoncharhook} that
generates a Cancel event if the Escape key has been pressed.
%
%Under Windows, wxDialog defines a handler for \helpref{wxWindow::OnCharHook}{wxwindowoncharhook} that
%generates a Cancel event if the Escape key has been pressed.
\wxheading{What should I do when the user calls up Exit from a menu?}

4
docs/latex/wx/tguide.tex
View File

@ -34,8 +34,8 @@ brushes (\helpref{wxBrush}{wxbrush}) and pens (\helpref{wxPen}{wxpen}).
To intercept events, you add a DECLARE\_EVENT\_TABLE macro to the window class declaration,
and put a BEGIN\_EVENT\_TABLE ... END\_EVENT\_TABLE block in the implementation file. Between these
macros, you add event macros which map the event (such as a mouse click) to a member function.
These might override predefined event handlers such as \helpref{wxWindow::OnChar}{wxwindowonchar} and
\rtfsp\helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
These might override predefined event handlers such as for \helpref{wxKeyEvent}{wxkeyevent} and
\rtfsp\helpref{wxMouseEvent}{wxmouseevent}.
Most modern applications will have an on-line, hypertext help system; for this, you
need wxHelp and the \helpref{wxHelpController}{wxhelpcontroller} class to control

2
docs/latex/wx/truntime.tex
View File

@ -28,7 +28,7 @@ Note that these are entirely optional; use them if you wish to check object
types, or create instances of classes using the class name. However,
it is good to get into the habit of adding these macros for all classes.
Variations on these \helpref{macros}{macros} are used for multiple inheritance, and abstract
Variations on these \helpref{macros}{rttimacros} are used for multiple inheritance, and abstract
classes that cannot be instantiated dynamically or otherwise.
DECLARE\_DYNAMIC\_CLASS inserts a static wxClassInfo declaration into the

2
docs/latex/wx/tsamples.tex
View File

@ -55,7 +55,7 @@ a good starting point for learning how to use wxWindows.
The {\tt artprov} sample shows how you can customize the look of standard
wxWindows dialogs by replacing default bitmaps/icons with your own versions.
It also shows how you can use \helpref{wxArtProvider}{wxartprovider} to
It also shows how you can use wxArtProvider to
get stock bitmaps for use in your application.
\subsection{Calendar sample}\label{samplecalendar}

2
docs/latex/wx/tscroll.tex
View File

@ -79,7 +79,7 @@ When defining your own scrollbar behaviour, you will always need to recalculate
the scrollbar settings when the window size changes. You could therefore put your
scrollbar calculations and SetScrollbar
call into a function named AdjustScrollbars, which can be called initially and also
from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
%\normalbox{{\bf For Windows programmers:} note that scrollbar range in wxWindows has a different meaning
%from that in Windows. In native Windows scrollbar calls, range is the number of positions that the scrollbar

131
docs/latex/wx/window.tex
View File

@ -876,7 +876,7 @@ Gets the window's title. Applicable only to frames and dialogs.
\constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
Returns the region specifying which parts of the window have been damaged. Should
only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler.
only be called within an \helpref{wxPaintEvent}{wxpaintevent} handler.
\wxheading{See also}
@ -1196,95 +1196,6 @@ implements the following methods:\par
%% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp
%% \helpref{wxCloseEvent}{wxcloseevent}
%%
%% \membersection{wxWindow::OnCloseWindow}\label{wxwindowonclosewindow}
%%
%% \func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}}
%%
%% This is an event handler function called when the user has tried to close a a frame
%% or dialog box using the window manager (X) or system menu (Windows). It is
%% called via the \helpref{wxWindow::Close}{wxwindowclose} function, so
%% that the application can also invoke the handler programmatically.
%%
%% Use the EVT\_CLOSE event table macro to handle close events.
%%
%% You should check whether the application is forcing the deletion of the window
%% using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is {\tt TRUE},
%% destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
%% If not, it is up to you whether you respond by destroying the window.
%%
%% (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
%% the window is required, test for the negative of CanVeto. If CanVeto returns {\tt FALSE},
%% it is not possible to skip window deletion.)
%%
%% If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to
%% let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function
%% to return {\tt TRUE} or {\tt FALSE} depending on whether the close instruction was honoured or not.
%%
%% \wxheading{Remarks}
%%
%% The \helpref{wxWindow::OnClose}{wxwindowonclose} virtual function remains
%% for backward compatibility with earlier versions of wxWindows. The
%% default {\bf OnCloseWindow} handler for wxFrame and wxDialog will call {\bf OnClose},
%% destroying the window if it returns {\tt TRUE} or if the close is being forced.
%%
%% \wxheading{See also}
%%
%% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp
%% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp
%% \helpref{wxWindow::OnClose}{wxwindowonclose},\rtfsp
%% \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp
%% \helpref{wxCloseEvent}{wxcloseevent},\rtfsp
%% \helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession}
%% %% GD: OnXXX functions are not documented
%% %%\helpref{wxApp::OnEndSession}{wxapponendsession}
%%
%% \membersection{wxWindow::OnDropFiles}\label{wxwindowondropfiles}
%%
%% \func{void}{OnDropFiles}{\param{wxDropFilesEvent\&}{ event}}
%%
%% Called when files have been dragged from the file manager to the window.
%%
%% \wxheading{Parameters}
%%
%% \docparam{event}{Drop files event. For more information, see \helpref{wxDropFilesEvent}{wxdropfilesevent}.}
%%
%% \wxheading{Remarks}
%%
%% The window must have previously been enabled for dropping by calling
%% \rtfsp\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}.
%%
%% This event is only generated under Windows.
%%
%% To intercept this event, use the EVT\_DROP\_FILES macro in an event table definition.
%%
%% \wxheading{See also}
%%
%% \helpref{wxDropFilesEvent}{wxdropfilesevent}, \helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles},\rtfsp
%% \helpref{Event handling overview}{eventhandlingoverview}
%%
%% \membersection{wxWindow::OnEraseBackground}\label{wxwindowonerasebackground}
%%
%% \func{void}{OnEraseBackground}{\param{wxEraseEvent\&}{ event}}
%%
%% Called when the background of the window needs to be erased.
%%
%% \wxheading{Parameters}
%%
%% \docparam{event}{Erase background event. For more information, see \helpref{wxEraseEvent}{wxeraseevent}.}
%%
%% \wxheading{Remarks}
%%
%% Under non-Windows platforms, this event is simulated (simply generated just before the
%% paint event) and may cause flicker. It is therefore recommended that
%% you set the text background colour explicitly in order to prevent flicker.
%% The default background colour under GTK is grey.
%%
%% To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table definition.
%%
%% \wxheading{See also}
%%
%% \helpref{wxEraseEvent}{wxeraseevent}, \helpref{Event handling overview}{eventhandlingoverview}
%%
%% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown}
%%
%% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}}
@ -1347,40 +1258,6 @@ implements the following methods:\par
%% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp
%% \helpref{Event handling overview}{eventhandlingoverview}
%%
%% \membersection{wxWindow::OnKillFocus}\label{wxwindowonkillfocus}
%%
%% \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}}
%%
%% Called when a window's focus is being killed.
%%
%% \wxheading{Parameters}
%%
%% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.}
%%
%% \wxheading{Remarks}
%%
%% To intercept this event, use the macro EVT\_KILL\_FOCUS in an event table definition.
%%
%% Most, but not all, windows respond to this event.
%%
%% \wxheading{See also}
%%
%% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnSetFocus}{wxwindowonsetfocus},\rtfsp
%% \helpref{Event handling overview}{eventhandlingoverview}
%%
%% \membersection{wxWindow::OnIdle}\label{wxwindowonidle}
%%
%% \func{void}{OnIdle}{\param{wxIdleEvent\& }{event}}
%%
%% Provide this member function for any processing which needs to be done
%% when the application is idle.
%%
%% \wxheading{See also}
%%
%% %% GD: OnXXX functions are not documented
%% %%\helpref{wxApp::OnIdle}{wxapponidle}
%% \helpref{wxIdleEvent}{wxidleevent}
%%
%% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog}
%%
%% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}}
@ -1963,7 +1840,7 @@ Sets the background colour of the window.
\wxheading{Remarks}
The background colour is usually painted by the default\rtfsp
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function
\helpref{wxEraseEvent}{wxeraseevent} event handler function
under Windows and automatically under GTK.
Note that setting the background colour does not cause an immediate refresh, so you
@ -1981,7 +1858,7 @@ look as the user wishes with run-time loadable modules.
\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
\helpref{wxWindow::Clear}{wxwindowclear},\rtfsp
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}
\helpref{wxEraseEvent}{wxeraseevent}
\membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
@ -2279,7 +2156,7 @@ When defining your own scrollbar behaviour, you will always need to recalculate
the scrollbar settings when the window size changes. You could therefore put your
scrollbar calculations and SetScrollbar
call into a function named AdjustScrollbars, which can be called initially and also
from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
\wxheading{See also}

2
docs/latex/wx/wx.hpj
View File

@ -1,5 +1,5 @@
[OPTIONS]
BMROOT=c:\wx2dev\wxWind~1\docs\latex\wx
BMROOT=c:\wx2dev\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
TITLE=wxWindows Manual
CONTENTS=Contents
COMPRESS=HIGH