%% Created:
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets Team
-%% License: wxWidgets license
+%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxWindow}}\label{wxwindow}
normal keyboard navigation take place, you should create and send a
wxNavigationKeyEvent in response to the key events for Tab and
Shift-Tab.}
-\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting
-the window completely when its size is changed - you will have to repaint the
-new window area manually if you use this style. Currently only has an effect for
-Windows.}
+\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting
+the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete
+and no longer has an effect.}
\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.}
\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.}
\twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars,
a complete redraw of the window whenever it is resized instead of redrawing
just the part of the window affected by resizing. Note that this was the
behaviour by default before 2.5.1 release and that if you experience redraw
-problems with the code which previously used to work you may want to try this.}
+problems with code which previously used to work you may want to try this.
+Currently this style applies on GTK+ 2 and Windows only, and full repainting is always
+done on other platforms.}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}.
\constfunc{wxWindowVariant}{GetWindowVariant}{\void}
-Returns the value previous passed to
+Returns the value previously passed to
\helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
\membersection{wxWindow::LineDown}\label{wxwindowlinedown}
-This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$.
+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)$.
+This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$.
\membersection{wxWindow::Lower}\label{wxwindowlower}
\func{void}{Lower}{\void}
-Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
-or frame).
+Lowers the window to the bottom of the window hierarchy.
+
+\wxheading{See also}
+
+\helpref{Raise}{wxwindowraise}
\membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}
\func{void}{Raise}{\void}
-Raises the window to the top of the window hierarchy if it is a managed window (dialog
-or frame).
+Raises the window to the top of the window hierarchy.
+
+In current version of wxWidgets this works both for manage and child windows.
+
+\wxheading{See also}
+
+\helpref{Lower}{wxwindowlower}
\membersection{wxWindow::Refresh}\label{wxwindowrefresh}
-\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect
-= NULL}}
+\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}}
-Causes an event to be generated to repaint the
-window.
+Causes this window, and all of its children recursively (except under wxGTK1
+where this is not implemented), to be repainted. Note that repainting doesn't
+happen immediately but only during the next event loop iteration, if you need
+to update the window immediately you should use \helpref{Update}{wxwindowupdate}
+instead.
\wxheading{Parameters}
\wxheading{Remarks}
Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
-This function is currently only implemented under MSW.
+This function is currently only implemented under Windows. It is used
+in the \helpref{Windows CE port}{wxwince} for detecting hardware button presses.
\wxheading{See also}
\docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
-{\bf wxSIZE\_AUTO\_WIDTH}: a -1 width value is taken to indicate
+{\bf wxSIZE\_AUTO\_WIDTH}: a $-1$ width value is taken to indicate
a wxWidgets-supplied default width.\\
-{\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height value is taken to indicate
+{\bf wxSIZE\_AUTO\_HEIGHT}: a $-1$ height value is taken to indicate
a wxWidgets-supplied default width.\\
{\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
a wxWidgets-supplied default size.\\
{\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
if -1 values are supplied.\\
-{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of -1 and less to be interpreted
+{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of $-1$ and less to be interpreted
as real dimensions, not default values.
+{\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are
+already the same as the parameters of this function, nothing is done. but with
+this flag a window resize may be forced even in this case (supported in wx
+2.6.2 and later and only implemented for MSW and ignored elsewhere currently)
}
\wxheading{Remarks}
\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},
+\func{virtual void}{SetSizeHints}{\param{int}{ minW}, \param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},
\param{int}{ incW=-1}, \param{int}{ incH=-1}}
\func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize},
\func{virtual void}{Update}{\void}
-Calling this method immediately repaints the invalidated area of the window
-while this would usually only happen when the flow of control returns to the
-event loop. Notice that this function doesn't refresh the window and does
-nothing if the window hadn't been already repainted. Use
-\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
-window unconditionally.
+Calling this method immediately repaints the invalidated area of the window and
+all of its children recursively while this would usually only happen when the
+flow of control returns to the event loop. Notice that this function doesn't
+refresh the window and does 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}
projects / wxWidgets.git / blobdiff