X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4488a1d33266555c47bd3ca72cca6e20c67ab509..2712e31795ee7ab4de62189b440d702f3f849c0d:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index ef908b33d0..cf6e0c3eca 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -219,6 +219,26 @@ called by the user code. \docparam{child}{Child window to add.} +\membersection{wxWindow::AlwaysShowScrollbars}\label{wxwindowalwaysshowscrollbars} + +\func{void}{AlwaysShowScrollbars}{\param{bool}{ hflag}, \param{bool}{ vflag}} + +Call this function to force one or both scrollbars to be always shown, even if +the window is big enough to show its entire contents without scrolling. + +\newsince{2.9.0} + +\wxheading{Parameters} + +\docparam{hflag}{Whether the horizontal scroll bar should always be visible.} + +\docparam{vflag}{Whether the vertical scroll bar should always be visible.} + +\wxheading{Remarks} + +This function is currently only implemented under Mac/Carbon. + + \membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize} \constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}} @@ -275,13 +295,6 @@ A synonym for \helpref{Centre}{wxwindowcentre}. 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}} @@ -329,24 +342,7 @@ window is not a top level window, then behaviour is the same as \wxheading{See also} -\helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen} - - -\membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen} - -\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}} - -Centres the window on screen. This only works for top level windows - -otherwise, the window will still be centered on its parent. - -\wxheading{Parameters} - -\docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp -or {\tt wxBOTH}.} - -\wxheading{See also} - -\helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent} +\helpref{wxTopLevelWindow::CentreOnScreen}{wxtoplevelwindowcenteronscreen} \membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground} @@ -732,7 +728,8 @@ subwindows. Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. \helpref{Thaw}{wxwindowthaw} must be called to reenable window redrawing. Calls to these two functions may be -nested. +nested but to ensure that the window is properly repainted again, you must thaw +it exactly as many times as you froze it. This method is useful for visual appearance optimization (for example, it is a good idea to use it before doing many large text insertions in a row into @@ -1177,6 +1174,20 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam \helpref{wxWindow::SetName}{wxwindowsetname} +\membersection{wxWindow::GetNextSibling}\label{wxwindowgetnextsibling} + +\constfunc{wxWindow *}{GetNextSibling}{\void} + +Returns the next window after this one among the parent children or \NULL if +this window is the last child. + +\newsince{2.8.8} + +\wxheading{See also} + +\helpref{GetPrevSibling}{wxwindowgetprevsibling} + + \membersection{wxWindow::GetParent}\label{wxwindowgetparent} \constfunc{virtual wxWindow*}{GetParent}{\void} @@ -1250,6 +1261,20 @@ method:\par \helpref{GetScreenPosition}{wxwindowgetscreenposition} +\membersection{wxWindow::GetPrevSibling}\label{wxwindowgetprevsibling} + +\constfunc{wxWindow *}{GetPrevSibling}{\void} + +Returns the previous window before this one among the parent children or \NULL if +this window is the first child. + +\newsince{2.8.8} + +\wxheading{See also} + +\helpref{GetNextSibling}{wxwindowgetnextsibling} + + \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} @@ -1491,6 +1516,13 @@ Returns the value previously passed to \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}. +\membersection{wxWindow::HandleWindowEvent}\label{wxwindowhandlewindowevent} + +\func{bool}{HandleWindowEvent}{\param{wxEvent\& }{event}} + +Shorthand for \texttt{\helpref{GetEventHandler}{wxwindowgeteventhandler}()->\helpref{SafelyProcessEvent}{wxevthandlersafelyprocessevent}(event)}. + + \membersection{wxWindow::HasCapture}\label{wxwindowhascapture} \constfunc{virtual bool}{HasCapture}{\void} @@ -1566,6 +1598,20 @@ wxWindow-derived class to ensure that background is painted correctly. Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}). +\membersection{wxWindow::HideWithEffect}\label{wxwindowhidewitheffect} + +\func{virtual bool}{HideWithEffect}{\param{wxShowEffect }{effect}, \param{unsigned }{timeout = $0$}, \param{wxDirection }{dir = wxBOTTOM}} + +This function hides a window, like \helpref{Hide()}{wxwindowhide}, but using a +special visual effect if possible. + +The parameters of this function are the same as for +\helpref{ShowWithEffect()}{wxwindowshowwitheffect}, please see their +description there. + +\newsince{2.9.0} + + \membersection{wxWindow::InheritAttributes}\label{wxwindowinheritattributes} \func{void}{InheritAttributes}{\void} @@ -1686,6 +1732,21 @@ Returns {\tt true} if the window is retained, {\tt false} otherwise. Retained windows are only available on X platforms. +\membersection{wxWindow::IsScrollbarAlwaysShown}\label{wxwindowisscrollbaralwaysshown} + +\func{bool}{IsScrollbarAlwaysShown}{\param{int}{ orient}} + +Return whether a scrollbar is always shown. + +\wxheading{Parameters} + +\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.} + +\wxheading{See also} + +\helpref{wxWindow::AlwaysShowScrollbars}{wxwindowalwaysshowscrollbars} + + \membersection{wxWindow::IsShown}\label{wxwindowisshown} \constfunc{virtual bool}{IsShown}{\void} @@ -3708,6 +3769,39 @@ done because it already was in the requested state. \helpref{wxRadioBox::Show}{wxradioboxshow} +\membersection{wxWindow::ShowWithEffect}\label{wxwindowshowwitheffect} + +\func{virtual bool}{ShowWithEffect}{\param{wxShowEffect }{effect}, \param{unsigned }{timeout = $0$}, \param{wxDirection }{dir = wxBOTTOM}} + +This function shows a window, like \helpref{Show()}{wxwindowshow}, but using a +special visual effect if possible. + +Possible values for \arg{effect} are: +\begin{twocollist}\itemsep=0pt +\twocolitem{wxSHOW\_EFFECT\_ROLL}{Roll window effect} +\twocolitem{wxSHOW\_EFFECT\_SLIDE}{Sliding window effect} +\twocolitem{wxSHOW\_EFFECT\_BLEND}{Fade in or out effect} +\twocolitem{wxSHOW\_EFFECT\_EXPAND}{Expanding or collapsing effect} +\end{twocollist} + +For the roll and slide effects the \arg{dir} parameter specifies the animation +direction: it can be one of \texttt{wxTOP}, \texttt{wxBOTTOM}, \texttt{wxLEFT} +or \texttt{wxRIGHT}. For the other effects, this parameter is unused. + +The \arg{timeout} parameter specifies the time of the animation, in +milliseconds. If the default value of $0$ is used, the default animation time +for the current platform is used. + +Currently this function is only implemented in wxMSW and does the same thing as +Show() in the other ports. + +\newsince{2.9.0} + +\wxheading{See also} + +\helpref{HideWithEffect}{wxwindowhidewitheffect} + + \membersection{wxWindow::Thaw}\label{wxwindowthaw} \func{virtual void}{Thaw}{\void}