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 = wxHORIZONTAL}}
+\func{void}{Centre}{\param{int}{ direction = wxBOTH}}
Centres the window.
if you want to center the window on the entire screen and not on its
parent window.}
-The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer.
+The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer
+(it has no effect).
\wxheading{Remarks}
\membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent}
-\func{void}{CentreOnParent}{\param{int}{ direction = wxHORIZONTAL}}
+\func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}}
-Centres the window.
+Centres the window on its parent. This is a more readable synonym for
+\helpref{Centre}{wxwindowcentre}.
\wxheading{Parameters}
\wxheading{See also}
-\helpref{wxWindow::CenterOnParent}{wxwindowcenteronparent}
+\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}
\membersection{wxWindow::Clear}\label{wxwindowclear}
This functions returns the best acceptable minimal size for the window. For
example, for a static control, it will be the minimal size such that the
-control label is not truncated. For windows containing subwindows (typically
+control label is not truncated. For windows containing subwindows (typically
\helpref{wxPanel}{wxpanel}), the size returned by this function will be the
-same as the size the window would have had after calling
+same as the size the window would have had after calling
\helpref{Fit}{wxwindowfit}.
\membersection{wxWindow::GetCharHeight}
\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}
Returns a pointer to the current validator for the window, or NULL if there is none.
-\membersection{wxWindow::GetWindowStyleFlag}
+\membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
\constfunc{long}{GetWindowStyleFlag}{\void}
-Gets the window style that was passed to the consructor or {\bf Create} member.
-{\bf GetWindowStyle} is synonymous.
+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::InitDialog}\label{wxwindowinitdialog}
last repaint. Call this in an paint event handler to optimize redrawing by
only redrawing those areas, which have been exposed.
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{}
+\twocolitem{{\bf IsExposedPoint(pt)}}{}
+\twocolitem{{\bf IsExposedRect(rect)}}{}
+\end{twocollist}}}
+
\membersection{wxWindow::IsRetained}\label{wxwindowisretained}
\constfunc{virtual bool}{IsRetained}{\void}
Reparents the window, i.e the window will be removed from its
current parent window (e.g. a non-standard toolbar in a wxFrame)
-and then re-inserted into another (e.g. a wxMiniFrame for a
-floating toolbar). Available on Windows and GTK+.
+and then re-inserted into another. Available on Windows and GTK.
\wxheading{Parameters}
\docparam{rect}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
-can optimise painting by checking for the invalidated region. This paramter is ignored under GTK,
-instead the regions to be invalidated are calculated automatically. }
+can optimise painting by checking for the invalidated region. This paramter is ignored under GTK.}
\wxheading{Remarks}
\docparam{autoLayout}{Set this to TRUE if you wish the Layout function to be called
from within wxWindow::OnSize functions.}
-\wxheading{Remarks}
-
-Note that this function is actually disabled for wxWindow. It has
-effect for wxDialog, wxFrame, wxPanel and wxScrolledWindow. Windows
-of other types that need to invoke the Layout algorithm should provide
-an EVT\_SIZE handler and call
-\helpref{wxWindow::Layout}{wxwindowlayout} from within it.
-
\wxheading{See also}
\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints}
may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
calling this function.
-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
-their parent windows.
+Use this function with care under GTK as the new appearance of the window might
+not look equally well when used with "Themes", i.e GTK's ability to change its
+look as the user wishes with run-time loadable modules.
\wxheading{See also}
\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
\helpref{Drag and drop overview}{wxdndoverview}
+\membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle}
+
+\func{void}{SetExtraStyle}{\param{long }{exStyle}}
+
+Sets the extra style bits for the window. The currently defined extra style
+bits are:
+
+\twocolwidtha{5cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow()
+and Validate() methods will recursively descend into all children of the
+window if it has this style flag set.}
+\end{twocollist}
+
\membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
\func{virtual void}{SetFocus}{\void}
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::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}}
+
+Sets the style of the window. Please note that some styles cannot be changed
+after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might
+be called after changing the others for the change to take place immediately.
+
+See \helpref{Windowstyles}{windowstyles} for more information about flags.
+
+\wxheading{See also}
+
+\helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag}
+
\membersection{wxWindow::Show}\label{wxwindowshow}
\func{virtual bool}{Show}{\param{bool}{ show}}
Transfers values from child controls to data areas specified by their validators. Returns
FALSE if a transfer failed.
+If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
+the method will also call TransferDataFromWindow() of all child windows.
+
\wxheading{See also}
\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
Transfers values to child controls from data areas specified by their validators.
+If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
+the method will also call TransferDataToWindow() of all child windows.
+
\wxheading{Return value}
Returns FALSE if a transfer failed.
Validates the current values of the child controls using their validators.
+If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
+the method will also call Validate() of all child windows.
+
\wxheading{Return value}
Returns FALSE if any of the validations failed.
projects / wxWidgets.git / blobdiff