\constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
-\perlnote{In wxPerl this method returns a 2-element list intead of
+\perlnote{In wxPerl this method returns a 2-element list instead of
modifying its parameters.}
\constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}}
For the x dimension, the pixels are multiplied by 4 and then divided by the average
character width.
-For the y dimension, the pixels are multipled by 8 and then divided by the average
+For the y dimension, the pixels are multiplied by 8 and then divided by the average
character height.
\wxheading{Remarks}
different window classes can be destroyed differently. Frames and dialogs
are not destroyed immediately when this function is called - they are added
to a list of windows to be deleted on idle time, when all the window's events
-have been processed. This prevents problems with events being sent to non-existant
+have been processed. This prevents problems with events being sent to non-existent
windows.
\wxheading{Return value}
Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}.
+\wxheading{Return value}
+
+Returns {\tt TRUE} if the window has been disabled, {\tt FALSE} if it had been
+already disabled before the call to this function.
+
\membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
\func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
-Enables or disables elibility for drop file events (OnDropFiles).
+Enables or disables eligibility for drop file events (OnDropFiles).
\wxheading{Parameters}
\membersection{wxWindow::Enable}\label{wxwindowenable}
-\func{virtual void}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
+\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
Enable or disable the window for user input.
\docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.}
+\wxheading{Return value}
+
+Returns {\tt TRUE} if the window has been enabled or disabled, {\tt FALSE} if
+nothing was done, i.e. if the window had already been in the specified state.
+
\wxheading{See also}
\helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
\end{twocollist}}
}
+\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid}
+
+\func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}}
+
+Find the first window with the given {\it id}.
+
+If {\it parent} is NULL, the search will start from all top-level
+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{See also}
+
+\helpref{FindWindow}{wxwindowfindwindow}
+
+\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname}
+
+\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}}
+
+Find a window by its name (as given in a window constructor or {\bf Create} function call).
+If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.
+
+If no window with such name is found,
+\helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called.
+
+\wxheading{See also}
+
+\helpref{FindWindow}{wxwindowfindwindow}
+
+\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel}
+
+\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}}
+
+Find a window by its label. Depending on the type of window, the label may be a window title
+or panel item label. If {\it parent} is NULL, the search will start from all top-level
+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{See also}
+
+\helpref{FindWindow}{wxwindowfindwindow}
+
\membersection{wxWindow::Fit}\label{wxwindowfit}
\func{virtual void}{Fit}{\void}
Returns the \helpref{caret}{wxcaret} associated with the window.
+\membersection{wxWindow::GetCapture}\label{wxwindowgetcapture}
+
+\func{static wxWindow *}{GetCapture}{\void}
+
+Returns the currently captured window.
+
+\wxheading{See also}
+
+\helpref{wxWindow::HasCapture}{wxwindowhascapture},
+\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
+\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
+\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
+
\membersection{wxWindow::GetCharHeight}
\constfunc{virtual int}{GetCharHeight}{\void}
\wxheading{See also}
\helpref{GetSize}{wxwindowgetsize}
+\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
\membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
\constfunc{wxPoint}{GetPosition}{\void}
-This gets the position of the window in pixels, relative to the parent window or
-if no parent, relative to the whole display.
+This gets the position of the window in pixels, relative to the parent window
+for the child windows or relative to the display origin for the top level
+windows.
\wxheading{Parameters}
\wxheading{See also}
-\helpref{GetClientSize}{wxwindowgetclientsize}
+\helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp
+\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
\membersection{wxWindow::GetSizer}\label{wxwindowgetsizer}
\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}
Returns a pointer to the current validator for the window, or NULL if there is none.
+\membersection{wxWindow::GetVirtualSize}\label{wxwindowgetvirtualsize}
+
+\constfunc{void}{GetVirtualSize}{\param{int* }{width}, \param{int* }{height}}
+
+\constfunc{wxSize}{GetVirtualSize}{\void}
+
+This gets the virtual size of the window in pixels.
+
+\wxheading{Parameters}
+
+\docparam{width}{Receives the window virtual width.}
+
+\docparam{height}{Receives the window virtual height.}
+
+\helpref{GetSize}{wxwindowgetsize},\rtfsp
+\helpref{GetClientSize}{wxwindowgetclientsize}
+
\membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
\constfunc{long}{GetWindowStyleFlag}{\void}
Gets the window style that was passed to the constructor or {\bf Create}
method. {\bf GetWindowStyle()} is another name for the same function.
+\membersection{wxWindow::HasCapture}\label{wxwindowhascapture}
+
+\constfunc{virtual bool}{HasCapture}{\void}
+
+Returns TRUE if this window has the current mouse capture.
+
+\wxheading{See also}
+
+\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
+\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
+\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
+
\membersection{wxWindow::Hide}\label{wxwindowhide}
\func{bool}{Hide}{\void}
\constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
-Returns {\tt TRUE} if the given point or rectange area has been exposed since the
+Returns {\tt TRUE} if the given point or rectangle area has been exposed since the
last repaint. Call this in an paint event handler to optimize redrawing by
only redrawing those areas, which have been exposed.
%% or dialog box using the window manager (X) or system menu (Windows).
%%
%% {\bf Note:} This is an obsolete function.
-%% It is superceded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
+%% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
%% handler.
%%
%% \wxheading{Return value}
%% \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}}
%% \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}}
\wxheading{See also}
-\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}
+\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
+\helpref{wxWindow::HasCapture}{wxwindowhascapture},
+\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},
+\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
\membersection{wxWindow::RemoveChild}\label{wxwindowremovechild}
\docparam{child}{Child window to remove.}
-\membersection{wxWindow::RemoveEventHandler}{wxwindowremoveeventhandler}
+\membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler}
\func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}
\func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
-be called automatically when the window is resized. Use in connection with
-\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and
-\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for laying out
-subwindows.
+be called automatically when the window is resized. It is called implicitly by
+\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use
+\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
+manually or otherwise the window layout won't be correctly updated when its
+size changes.
\wxheading{Parameters}
\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
\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}
and Validate() methods will recursively descend into all children of the
window if it has this style flag set.}
\twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{Normally, the command
-events are propagared upwards to the window parent recursively until a handler
+events are propagated upwards to the window parent recursively until a handler
for them is found. Using this style allows to prevent them from being
propagated beyond this window. Notice that wxDialog has this style on by
default for the reasons explained in the
\twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{This can be used to prevent a
window from being used as an implicit parent for the dialogs which were
created without a parent. It is useful for the windows which can disappear at
-any moment as creating childs of such windows results in fatal problems.}
+any moment as creating children of such windows results in fatal problems.}
\twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
a wxEVT\_HELP event if the user clicked on an application window.
This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
you should use the style of
-{\tt wxDEFAULT\_FRAME\_STYLE & ~(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
+{\tt wxDEFAULT\_FRAME\_STYLE \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
frames having this style (the dialogs don't have minimize nor maximize box by
default)}
\end{twocollist}
This sets the window to receive keyboard input.
+\wxheading{See also}
+
+\helpref{wxFocusEvent}{wxfocusevent}
+
+\membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
+
+\func{virtual void}{SetFocusFromKbd}{\void}
+
+This function is called by wxWindows keyboard navigation code when the user
+gives the focus to this window from keyboard (e.g. using {\tt TAB} key).
+By default this method simply calls \helpref{SetFocus}{wxwindowsetfocus} but
+can be overridden to do something in addition to this in the derived classes.
+
\membersection{wxWindow::SetFont}\label{wxwindowsetfont}
\func{void}{SetFont}{\param{const wxFont\& }{font}}
be used at all.
Note that when using this functions under GTK, you will disable the so called "themes",
-i.e. the user chosen apperance of windows and controls, including the themes of
+i.e. the user chosen appearance of windows and controls, including the themes of
their parent windows.
\wxheading{See also}
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}
\membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
-\func{void}{SetSizer}{\param{wxSizer* }{sizer}}
+\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}}
Sets the window to have the given layout sizer. The window
will then own the object, and will take care of its deletion.
If an existing layout constraints object is already owned by the
-window, it will be deleted.
+window, it will be deleted if the deleteOld parameter is TRUE.
+
+Note that this function will also call
+\helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt TRUE}
+parameter if the {\it sizer}\/ is non-NULL and {\tt FALSE} otherwise.
\wxheading{Parameters}
-\docparam{sizer}{The sizer to set. Pass NULL to disassociate and delete the window's
-sizer.}
+\docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
+the window's sizer. See below.}
+
+\docparam{deleteOld}{If TRUE (the default), this will delete any prexisting sizer.
+Pass FALSE if you wish to handle deleting the old sizer yourself.}
\wxheading{Remarks}
+SetSizer now enables and disables Layout automatically, but prior to wxWindows 2.3.3
+the following applied:
+
You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use
the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints},
only the sizer will have effect.
+\membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit}
+
+\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}}
+
+The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints
+for the window based on the sizer's minimum size.
+
\membersection{wxWindow::SetTitle}\label{wxwindowsettitle}
\func{virtual void}{SetTitle}{\param{const wxString\& }{title}}
\helpref{wxWindow::GetTitle}{wxwindowgettitle}
+\membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}
+
+\func{virtual void}{SetThemeEnabled}{\param{bool }{enable}}
+
+This function tells a window if it should use the system's "theme" code
+to draw the windows' background instead if its own background drawing
+code. This does not always have any effect since the underlying platform
+obviously needs to support the notion of themes in user defined windows.
+One such platform is GTK+ where windows can have (very colourful) backgrounds
+defined by a user's selected theme.
+
+Dialogs, notebook pages and the status bar have this flag set to TRUE
+by default so that the default look and feel is simulated best.
+
\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
\func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}
Get the associated tooltip or NULL if none.
+\membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
+
+\func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}}
+
+\func{void}{SetVirtualSize}{\param{const wxSize\&}{ size}}
+
+Sets the virtual size of the window in pixels.
+
+
+\membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
+
+\func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}
+
+Allows specification of minimum and maximum virtual window sizes.
+If a pair of values is not set (or set to -1), the default values
+will be used.
+
+\wxheading{Parameters}
+
+\docparam{minW}{Specifies the minimum width allowable.}
+
+\docparam{minH}{Specifies the minimum height allowable.}
+
+\docparam{maxW}{Specifies the maximum width allowable.}
+
+\docparam{maxH}{Specifies the maximum height allowable.}
+
+\wxheading{Remarks}
+
+If this function is called, the user will not be able to size the virtual area
+of the window outside the given bounds.
\membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
projects / wxWidgets.git / blobdiff