diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 6181f83df1..7284d3209b 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -92,6 +92,7 @@ even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmod \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxWindow::wxWindow}\label{wxwindowctor} \func{}{wxWindow}{\void} @@ -125,6 +126,7 @@ correctly sized. } \docparam{name}{Window name.} + \membersection{wxWindow::\destruct{wxWindow}} \func{}{\destruct{wxWindow}}{\void} @@ -140,6 +142,7 @@ can delete a window only when it is safe to do so, in idle time. \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp \helpref{wxCloseEvent}{wxcloseevent} + \membersection{wxWindow::AddChild} \func{virtual void}{AddChild}{\param{wxWindow* }{child}} @@ -154,6 +157,7 @@ called by the user code. \docparam{child}{Child window to add.} + \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse} \func{virtual void}{CaptureMouse}{\void} @@ -171,24 +175,28 @@ as you capture it. \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse} + \membersection{wxWindow::Center}\label{wxwindowcenter} \func{void}{Center}{\param{int}{ direction}} A synonym for \helpref{Centre}{wxwindowcentre}. + \membersection{wxWindow::CenterOnParent}\label{wxwindowcenteronparent} \func{void}{CenterOnParent}{\param{int}{ direction}} A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}. + \membersection{wxWindow::CenterOnScreen}\label{wxwindowcenteronscreen} \func{void}{CenterOnScreen}{\param{int}{ direction}} A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}. + \membersection{wxWindow::Centre}\label{wxwindowcentre} \func{void}{Centre}{\param{int}{ direction = wxBOTH}} @@ -214,6 +222,7 @@ centered relative to the screen anyhow. \helpref{wxWindow::Center}{wxwindowcenter} + \membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent} \func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}} @@ -237,6 +246,7 @@ window is not a top level window, then behaviour is the same as \helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen} + \membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen} \func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}} @@ -253,6 +263,7 @@ or {\tt wxBOTH}.} \helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent} + \membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground} \func{void}{ClearBackground}{\void} @@ -260,6 +271,7 @@ or {\tt wxBOTH}.} Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. + \membersection{wxWindow::ClientToScreen} \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}} @@ -287,6 +299,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::Close}\label{wxwindowclose} \func{bool}{Close}{\param{bool}{ force = {\tt false}}} @@ -327,6 +340,7 @@ To guarantee that the window will be destroyed, call \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp \helpref{wxCloseEvent}{wxcloseevent} + \membersection{wxWindow::ConvertDialogToPixels}\label{wxwindowconvertdialogtopixels} \func{wxPoint}{ConvertDialogToPixels}{\param{const wxPoint\&}{ pt}} @@ -375,6 +389,7 @@ units to pixels} } + \membersection{wxWindow::ConvertPixelsToDialog}\label{wxwindowconvertpixelstodialog} \func{wxPoint}{ConvertPixelsToDialog}{\param{const wxPoint\&}{ pt}} @@ -407,6 +422,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::Destroy}\label{wxwindowdestroy} \func{virtual bool}{Destroy}{\void} @@ -423,12 +439,14 @@ windows. {\tt true} if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. + \membersection{wxWindow::DestroyChildren} \func{virtual void}{DestroyChildren}{\void} Destroys all children of a window. Called automatically by the destructor. + \membersection{wxWindow::Disable}\label{wxwindowdisable} \func{bool}{Disable}{\void} @@ -440,6 +458,7 @@ Disables the window, same as \helpref{Enable({\tt false})}{wxwindowenable}. 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::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui} \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}} @@ -465,6 +484,7 @@ void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event) } \end{verbatim} + \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}} @@ -480,6 +500,7 @@ will not accept drop file events.} Windows only. + \membersection{wxWindow::Enable}\label{wxwindowenable} \func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}} @@ -502,6 +523,7 @@ nothing was done, i.e. if the window had already been in the specified state. \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp \helpref{wxWindow::Disable}{wxwindowdisable} + \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus} \func{static wxWindow*}{FindFocus}{\void} @@ -516,6 +538,7 @@ Note that this is a static function, so it can be called without needing a wxWin \helpref{wxWindow::SetFocus}{wxwindowsetfocus} + \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow} \func{wxWindow*}{FindWindow}{\param{long}{ id}} @@ -534,6 +557,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid} \func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}} @@ -548,6 +572,7 @@ The search is recursive in both cases. \helpref{FindWindow}{wxwindowfindwindow} + \membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname} \func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}} @@ -564,6 +589,7 @@ If no window with such name is found, \helpref{FindWindow}{wxwindowfindwindow} + \membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel} \func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}} @@ -577,6 +603,7 @@ The search is recursive in both cases. \helpref{FindWindow}{wxwindowfindwindow} + \membersection{wxWindow::Fit}\label{wxwindowfit} \func{virtual void}{Fit}{\void} @@ -593,6 +620,7 @@ margin to account for fuzziness of its calculations) to call instead of calling Fit. + \membersection{wxWindow::FitInside}\label{wxwindowfitinside} \func{virtual void}{FitInside}{\void} @@ -603,6 +631,7 @@ sizing changes that do not trigger a size event, and/or scrolled windows without an interior sizer. This function similarly won't do anything if there are no subwindows. + \membersection{wxWindow::Freeze}\label{wxwindowfreeze} \func{virtual void}{Freeze}{\void} @@ -617,6 +646,7 @@ wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWindows and not a mandatory directive. + \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible} \func{wxAccessibile*}{GetAccessible}{\void} @@ -625,6 +655,7 @@ Returns the accessible object for this window, if any. See also \helpref{wxAccessible}{wxaccessible}. + \membersection{wxWindow::GetAdjustedBestSize}\label{wxwindowgetadjustedbestsize} \constfunc{wxSize}{GetAdjustedBestSize}{\void} @@ -635,6 +666,7 @@ window, while this method will return the largest of BestSize and any user specified minimum size. ie. it is the minimum size the window should currently be drawn at, not the minimal size it can possibly tolerate. + \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour} \constfunc{virtual wxColour}{GetBackgroundColour}{\void} @@ -647,6 +679,7 @@ Returns the background colour of the window. \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour} + \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize} \constfunc{virtual wxSize}{GetBestSize}{\void} @@ -658,12 +691,14 @@ control label is not truncated. For windows containing subwindows (typically same as the size the window would have had after calling \helpref{Fit}{wxwindowfit}. + \membersection{wxWindow::GetCaret}\label{wxwindowgetcaret} \constfunc{wxCaret *}{GetCaret}{\void} Returns the \helpref{caret}{wxcaret} associated with the window. + \membersection{wxWindow::GetCapture}\label{wxwindowgetcapture} \func{static wxWindow *}{GetCapture}{\void} @@ -677,24 +712,28 @@ Returns the currently captured window. \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::GetCharHeight} \constfunc{virtual int}{GetCharHeight}{\void} Returns the character height for this window. + \membersection{wxWindow::GetCharWidth} \constfunc{virtual int}{GetCharWidth}{\void} Returns the average character width for this window. + \membersection{wxWindow::GetChildren} \func{wxList\&}{GetChildren}{\void} Returns a reference to the list of the window's children. + \membersection{wxWindow::GetClientSize}\label{wxwindowgetclientsize} \constfunc{virtual void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}} @@ -727,12 +766,14 @@ implements the following methods:\par \helpref{GetSize}{wxwindowgetsize} \helpref{GetVirtualSize}{wxwindowgetvirtualsize} + \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints} \constfunc{wxLayoutConstraints*}{GetConstraints}{\void} Returns a pointer to the window's layout constraints, or NULL if there are none. + \membersection{wxWindow::GetContainingSizer}\label{wxwindowgetcontainingsizer} \constfunc{const wxSizer *}{GetContainingSizer}{\void} @@ -740,6 +781,7 @@ Returns a pointer to the window's layout constraints, or NULL if there are none. Return the sizer that this window is a member of, if any, otherwise {\tt NULL}. + \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget} \constfunc{wxDropTarget*}{GetDropTarget}{\void} @@ -751,6 +793,7 @@ Returns the associated drop target, which may be NULL. \helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget}, \helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler} \constfunc{wxEvtHandler*}{GetEventHandler}{\void} @@ -766,12 +809,14 @@ own event handler. \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp \helpref{wxEvtHandler}{wxevthandler}\rtfsp + \membersection{wxWindow::GetExtraStyle}\label{wxwindowgetextrastyle} \constfunc{long}{GetExtraStyle}{\void} Returns the extra style bits for the window. + \membersection{wxWindow::GetFont}\label{wxwindowgetfont} \constfunc{wxFont\&}{GetFont}{\void} @@ -782,6 +827,7 @@ Returns a reference to the font for this window. \helpref{wxWindow::SetFont}{wxwindowsetfont} + \membersection{wxWindow::GetForegroundColour}\label{wxwindowgetforegroundcolour} \func{virtual wxColour}{GetForegroundColour}{\void} @@ -800,12 +846,14 @@ be used at all. \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour} + \membersection{wxWindow::GetGrandParent} \constfunc{wxWindow*}{GetGrandParent}{\void} Returns the grandparent of a window, or NULL if there isn't one. + \membersection{wxWindow::GetHandle}\label{wxwindowgethandle} \constfunc{void*}{GetHandle}{\void} @@ -817,6 +865,7 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget \perlnote{This method will return an integer in wxPerl.} + \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext} \constfunc{virtual wxString}{GetHelpText}{\void} @@ -830,6 +879,7 @@ and not in the window object itself. \helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider} + \membersection{wxWindow::GetId}\label{wxwindowgetid} \constfunc{int}{GetId}{\void} @@ -846,6 +896,7 @@ Each window has an integer identifier. If the application has not provided one \helpref{wxWindow::SetId}{wxwindowsetid},\rtfsp \helpref{Window identifiers}{windowids} + \membersection{wxWindow::GetLabel} \constfunc{virtual wxString }{GetLabel}{\void} @@ -861,6 +912,7 @@ the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name. + \membersection{wxWindow::GetName}\label{wxwindowgetname} \constfunc{virtual wxString }{GetName}{\void} @@ -876,12 +928,14 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam \helpref{wxWindow::SetName}{wxwindowsetname} + \membersection{wxWindow::GetParent} \constfunc{virtual wxWindow*}{GetParent}{\void} Returns the parent of the window, or NULL if there is no parent. + \membersection{wxWindow::GetPosition}\label{wxwindowgetposition} \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}} @@ -915,12 +969,14 @@ method:\par \end{twocollist} }} + \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} Returns the size and position of the window as a \helpref{wxRect}{wxrect} object. + \membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb} \func{virtual int}{GetScrollThumb}{\param{int }{orientation}} @@ -931,6 +987,7 @@ Returns the built-in scrollbar thumb size. \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar} + \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} \func{virtual int}{GetScrollPos}{\param{int }{orientation}} @@ -941,6 +998,7 @@ Returns the built-in scrollbar position. See \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar} + \membersection{wxWindow::GetScrollRange}\label{wxwindowgetscrollrange} \func{virtual int}{GetScrollRange}{\param{int }{orientation}} @@ -951,6 +1009,7 @@ Returns the built-in scrollbar range. \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar} + \membersection{wxWindow::GetSize}\label{wxwindowgetsize} \constfunc{virtual void}{GetSize}{\param{int* }{width}, \param{int* }{height}} @@ -988,6 +1047,7 @@ method:\par \helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp \helpref{GetVirtualSize}{wxwindowgetvirtualsize} + \membersection{wxWindow::GetSizer}\label{wxwindowgetsizer} \constfunc{wxSizer *}{GetSizer}{\void} @@ -995,6 +1055,7 @@ method:\par Return the sizer associated with the window by a previous call to \helpref{SetSizer()}{wxwindowsetsizer} or {\tt NULL}. + \membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent} \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y}, @@ -1034,6 +1095,7 @@ implements the following methods:\par {\tt font} parameters, and returns a 4-element list {\tt ( x, y, descent, externalLeading )}.} + \membersection{wxWindow::GetTitle}\label{wxwindowgettitle} \func{virtual wxString}{GetTitle}{\void} @@ -1044,12 +1106,14 @@ Gets the window's title. Applicable only to frames and dialogs. \helpref{wxWindow::SetTitle}{wxwindowsettitle} + \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip} \constfunc{wxToolTip*}{GetToolTip}{\void} Get the associated tooltip or NULL if none. + \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion} \constfunc{virtual wxRegion}{GetUpdateRegion}{\void} @@ -1062,12 +1126,14 @@ only be called within an \helpref{wxPaintEvent}{wxpaintevent} handler. \helpref{wxRegion}{wxregion},\rtfsp \helpref{wxRegionIterator}{wxregioniterator} + \membersection{wxWindow::GetValidator}\label{wxwindowgetvalidator} \constfunc{wxValidator*}{GetValidator}{\void} 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}} @@ -1085,6 +1151,7 @@ This gets the virtual size of the window in pixels. \helpref{GetSize}{wxwindowgetsize},\rtfsp \helpref{GetClientSize}{wxwindowgetclientsize} + \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag} \constfunc{long}{GetWindowStyleFlag}{\void} @@ -1092,6 +1159,7 @@ This gets the virtual size of the window in pixels. 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} @@ -1104,12 +1172,14 @@ Returns true if this window has the current mouse capture. \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::Hide}\label{wxwindowhide} \func{bool}{Hide}{\void} Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}). + \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog} \func{void}{InitDialog}{\void} @@ -1117,6 +1187,7 @@ Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}). Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data to the dialog via validators. + \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled} \constfunc{virtual bool}{IsEnabled}{\void} @@ -1127,6 +1198,7 @@ Returns {\tt true} if the window is enabled for input, {\tt false} otherwise. \helpref{wxWindow::Enable}{wxwindowenable} + \membersection{wxWindow::IsExposed}\label{wxwindowisexposed} \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}} @@ -1149,6 +1221,7 @@ implements the following methods:\par \twocolitem{{\bf IsExposedRect(rect)}}{} \end{twocollist}}} + \membersection{wxWindow::IsRetained}\label{wxwindowisretained} \constfunc{virtual bool}{IsRetained}{\void} @@ -1159,12 +1232,14 @@ Returns {\tt true} if the window is retained, {\tt false} otherwise. Retained windows are only available on X platforms. + \membersection{wxWindow::IsShown}\label{wxwindowisshown} \constfunc{virtual bool}{IsShown}{\void} Returns {\tt true} if the window is shown, {\tt false} if it has been hidden. + \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel} \constfunc{bool}{IsTopLevel}{\void} @@ -1173,6 +1248,7 @@ Returns {\tt true} if the given window is a top-level one. Currently all frames dialogs are considered to be top-level windows (even if they have a parent window). + \membersection{wxWindow::Layout}\label{wxwindowlayout} \func{void}{Layout}{\void} @@ -1183,14 +1259,17 @@ for this window. See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}: when auto layout is on, this function gets called automatically when the window is resized. + \membersection{wxWindow::LineDown}\label{wxwindowlinedown} This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$. + \membersection{wxWindow::LineUp}\label{wxwindowlineup} This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$. + \membersection{wxWindow::Lower}\label{wxwindowlower} \func{void}{Lower}{\void} @@ -1198,6 +1277,7 @@ This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$. Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog or frame). + \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal} \func{virtual void}{MakeModal}{\param{bool }{flag}} @@ -1211,6 +1291,7 @@ is not implemented anywhere). \docparam{flag}{If {\tt true}, this call disables all other windows in the application so that the user can only interact with this window. If {\tt false}, the effect is reversed.} + \membersection{wxWindow::Move}\label{wxwindowmove} \func{void}{Move}{\param{int}{ x}, \param{int}{ y}} @@ -1741,6 +1822,7 @@ implements the following methods:\par %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp %% \helpref{Event handling overview}{eventhandlingoverview} + \membersection{wxWindow::OnInternalIdle}\label{wxwindowoninternalidle} \func{virtual void}{OnInternalIdle}{\void} @@ -1754,14 +1836,17 @@ This function may be used to do delayed painting, for example, and most implementations call \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} in order to send update events to the window in idle time. + \membersection{wxWindow::PageDown}\label{wxwindowpagedown} This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(1)$. + \membersection{wxWindow::PageUp}\label{wxwindowpageup} This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(-1)$. + \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler} \constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt false}}} @@ -1781,6 +1866,7 @@ default value is {\tt false}.} \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp \helpref{wxEvtHandler}{wxevthandler}\rtfsp + \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu} \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}} @@ -1820,6 +1906,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler} \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}} @@ -1851,6 +1938,7 @@ remove the event handler. \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp \helpref{wxEvtHandler}{wxevthandler} + \membersection{wxWindow::Raise}\label{wxwindowraise} \func{void}{Raise}{\void} @@ -1858,6 +1946,7 @@ remove the event handler. Raises the window to the top of the window hierarchy if it is a managed window (dialog or frame). + \membersection{wxWindow::Refresh}\label{wxwindowrefresh} \func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect @@ -1878,15 +1967,17 @@ be treated as damaged.} \helpref{wxWindow::RefreshRect}{wxwindowrefreshrect} + \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect} -\func{virtual void}{Refresh}{\param{const wxRect\& }{rect}} +\func{void}{Refresh}{\param{const wxRect\& }{rect}} Redraws the contents of the given rectangle: the area inside it will be repainted. This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax. + \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey} \func{bool}{RegisterHotKey}{\param{int}{ hotkeyId}, \param{int}{ modifiers}, \param{int}{ virtualKeyCode}} @@ -1920,6 +2011,7 @@ This function is currently only implemented under MSW. \helpref{wxWindow::UnregisterHotKey}{wxwindowunregisterhotkey} + \membersection{wxWindow::ReleaseMouse}\label{wxwindowreleasemouse} \func{virtual void}{ReleaseMouse}{\void} @@ -1933,6 +2025,7 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::RemoveChild}\label{wxwindowremovechild} \func{virtual void}{RemoveChild}{\param{wxWindow* }{child}} @@ -1947,6 +2040,7 @@ called by the user code. \docparam{child}{Child window to remove.} + \membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler} \func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}} @@ -1970,6 +2064,7 @@ handler is supposed to be there). \helpref{PushEventHandler}{wxwindowpusheventhandler},\rtfsp \helpref{PopEventHandler}{wxwindowpopeventhandler} + \membersection{wxWindow::Reparent}\label{wxwindowreparent} \func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}} @@ -1982,6 +2077,7 @@ and then re-inserted into another. Available on Windows and GTK. \docparam{newParent}{New parent.} + \membersection{wxWindow::ScreenToClient}\label{wxwindowscreentoclient} \constfunc{virtual void}{ScreenToClient}{\param{int* }{x}, \param{int* }{y}} @@ -2006,6 +2102,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::ScrollLines}\label{wxwindowscrolllines} \func{virtual bool}{ScrollLines}{\param{int }{lines}} @@ -2028,6 +2125,7 @@ platforms). \helpref{ScrollPages}{wxwindowscrollpages} + \membersection{wxWindow::ScrollPages}\label{wxwindowscrollpages} \func{virtual bool}{ScrollPages}{\param{int }{pages}} @@ -2050,6 +2148,7 @@ platforms). \helpref{ScrollLines}{wxwindowscrolllines} + \membersection{wxWindow::ScrollWindow}\label{wxwindowscrollwindow} \func{virtual void}{ScrollWindow}{\param{int }{dx}, \param{int }{dy}, \param{const wxRect*}{ rect = NULL}} @@ -2071,12 +2170,14 @@ can optimize painting by checking for the invalidated region. This parameter is Use this function to optimise your scrolling implementations, to minimise the area that must be redrawn. Note that it is rarely required to call this function from a user program. + \membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable} \func{virtual void}{SetAcceleratorTable}{\param{const wxAcceleratorTable\&}{ accel}} Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}. + \membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible} \func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}} @@ -2086,6 +2187,7 @@ will be deleted first, if not identical to {\it accessible}. See also \helpref{wxAccessible}{wxaccessible}. + \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout} \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}} @@ -2106,6 +2208,7 @@ from within wxWindow::OnSize functions.} \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} + \membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour} \func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}} @@ -2139,12 +2242,14 @@ look as the user wishes with run-time loadable modules. \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp \helpref{wxEraseEvent}{wxeraseevent} + \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} \constfunc{void}{SetCaret}{\param{wxCaret *}{caret}} Sets the \helpref{caret}{wxcaret} associated with the window. + \membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize} \func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}} @@ -2172,6 +2277,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer} \func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}} @@ -2180,6 +2286,7 @@ This normally does not need to be called by user code. It is called when a window is added to a sizer, and is used so the window can remove itself from the sizer when it is destroyed. + \membersection{wxWindow::SetCursor}\label{wxwindowsetcursor} \func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}} @@ -2200,6 +2307,7 @@ be reset back to default. \helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor} + \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints} \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}} @@ -2221,6 +2329,7 @@ the constraints automatically in OnSize; otherwise, you must override OnSize and explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the sizer will have effect. + \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget} \func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}} @@ -2234,6 +2343,7 @@ If the window already has a drop target, it is deleted. \helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget}, \helpref{Drag and drop overview}{wxdndoverview} + \membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} @@ -2264,6 +2374,7 @@ handed to the next one in the chain. \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp \helpref{wxEvtHandler}{wxevthandler} + \membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle} \func{void}{SetExtraStyle}{\param{long }{exStyle}} @@ -2296,6 +2407,7 @@ frames having this style (the dialogs don't have minimize nor maximize box by default)} \end{twocollist} + \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus} \func{virtual void}{SetFocus}{\void} @@ -2306,6 +2418,7 @@ This sets the window to receive keyboard input. \helpref{wxFocusEvent}{wxfocusevent} + \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd} \func{virtual void}{SetFocusFromKbd}{\void} @@ -2315,6 +2428,7 @@ 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}} @@ -2329,6 +2443,7 @@ Sets the font for this window. \helpref{wxWindow::GetFont}{wxwindowgetfont} + \membersection{wxWindow::SetForegroundColour}\label{wxwindowsetforegroundcolour} \func{virtual void}{SetForegroundColour}{\param{const wxColour\& }{colour}} @@ -2355,6 +2470,7 @@ their parent windows. \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour} + \membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext} \func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}} @@ -2368,6 +2484,7 @@ and not in the window object itself. \helpref{GetHelpText}{wxwindowgethelptext}, \helpref{wxHelpProvider}{wxhelpprovider} + \membersection{wxWindow::SetId}\label{wxwindowsetid} \func{void}{SetId}{\param{int}{ id}} @@ -2385,6 +2502,7 @@ on creation and should not be modified subsequently. \helpref{wxWindow::GetId}{wxwindowgetid},\rtfsp \helpref{Window identifiers}{windowids} + \membersection{wxWindow::SetName}\label{wxwindowsetname} \func{virtual void}{SetName}{\param{const wxString\& }{name}} @@ -2399,12 +2517,14 @@ Sets the window's name. \helpref{wxWindow::GetName}{wxwindowgetname} + \membersection{wxWindow::SetPalette}\label{wxwindowsetpalette} \func{virtual void}{SetPalette}{\param{wxPalette* }{palette}} Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead. + \membersection{wxWindow::SetScrollbar}\label{wxwindowsetscrollbar} \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp @@ -2456,6 +2576,7 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \begin{comment} + \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage} \func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt true}}} @@ -2494,6 +2615,7 @@ handling of pages and ranges. \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} + \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos} \func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt true}}} @@ -2521,6 +2643,7 @@ application to take note of scrollbar attributes and redraw contents accordingly \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \begin{comment} + \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange} \func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt true}}} @@ -2552,6 +2675,7 @@ and usually the scrollbar will be automatically hidden. \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} + \membersection{wxWindow::SetSize}\label{wxwindowsetsize} \func{virtual void}{SetSize}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}, @@ -2621,6 +2745,7 @@ implements the following methods:\par \end{twocollist}} } + \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints} \func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}, @@ -2650,6 +2775,7 @@ given bounds. The resizing increments are only significant under Motif or Xt. + \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer} \func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}} @@ -2681,6 +2807,7 @@ the sizer automatically in OnSize; otherwise, you must override OnSize and call 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}} @@ -2688,6 +2815,7 @@ only the sizer will have effect. 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}} @@ -2702,6 +2830,7 @@ Sets the window's title. Applicable only to frames and dialogs. \helpref{wxWindow::GetTitle}{wxwindowgettitle} + \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled} \func{virtual void}{SetThemeEnabled}{\param{bool }{enable}} @@ -2716,6 +2845,7 @@ 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::SetToolTip}\label{wxwindowsettooltip} \func{void}{SetToolTip}{\param{const wxString\& }{tip}} @@ -2727,6 +2857,7 @@ Attach a tooltip to the window. See also: \helpref{GetToolTip}{wxwindowgettooltip}, \helpref{wxToolTip}{wxtooltip} + \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator} \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}} @@ -2734,6 +2865,7 @@ See also: \helpref{GetToolTip}{wxwindowgettooltip}, Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. + \membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize} \func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}} @@ -2742,6 +2874,7 @@ create a new validator of this type. 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}} @@ -2765,12 +2898,14 @@ will be used. 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} \func{void}{SetWindowStyle}{\param{long}{ style}} Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}. + \membersection{wxWindow::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag} \func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}} @@ -2785,6 +2920,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags. \helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag} + \membersection{wxWindow::Show}\label{wxwindowshow} \func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}} @@ -2806,6 +2942,7 @@ done because it already was in the requested state. \helpref{wxWindow::IsShown}{wxwindowisshown} + \membersection{wxWindow::Thaw}\label{wxwindowthaw} \func{virtual void}{Thaw}{\void} @@ -2813,6 +2950,7 @@ done because it already was in the requested state. Reenables window updating after a previous call to \helpref{Freeze}{wxwindowfreeze}. + \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow} \func{virtual bool}{TransferDataFromWindow}{\void} @@ -2828,6 +2966,7 @@ the method will also call TransferDataFromWindow() of all child windows. \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate} + \membersection{wxWindow::TransferDataToWindow}\label{wxwindowtransferdatatowindow} \func{virtual bool}{TransferDataToWindow}{\void} @@ -2846,6 +2985,7 @@ Returns {\tt false} if a transfer failed. \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate} + \membersection{wxWindow::UnregisterHotKey}\label{wxwindowunregisterhotkey} \func{bool}{UnregisterHotKey}{\param{int}{ hotkeyId}} @@ -2868,6 +3008,7 @@ This function is currently only implemented under MSW. \helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey} + \membersection{wxWindow::Update}\label{wxwindowupdate} \func{virtual void}{Update}{\void} @@ -2879,6 +3020,7 @@ nothing if the window hadn't been already repainted. Use \helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the window unconditionally. + \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui} \func{virtual void}{UpdateWindowUI}{\param{long}{ flags = wxUPDATE_UI_NONE}} @@ -2927,6 +3069,7 @@ void MyWindow::OnInternalIdle() \helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui}, \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle} + \membersection{wxWindow::Validate}\label{wxwindowvalidate} \func{virtual bool}{Validate}{\void} @@ -2946,6 +3089,7 @@ Returns {\tt false} if any of the validations failed. \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp \helpref{wxValidator}{wxvalidator} + \membersection{wxWindow::WarpPointer}\label{wxwindowwarppointer} \func{void}{WarpPointer}{\param{int}{ x}, \param{int}{ y}}