define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

[wxWidgets.git] / docs / latex / wx / window.tex

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index b3bb29d0793a9b0cd5da1bf001a64f9f4b006193..322ca2ae90796cdea4f6c9279d9b92d578dfae69 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        window.tex
+%% Purpose:     wxWindow documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxWindow}}\label{wxwindow}
 
 wxWindow is the base class for all windows and represents any visible object on
 \section{\class{wxWindow}}\label{wxwindow}
 
 wxWindow is the base class for all windows and represents any visible object on


@@ -55,10 +66,9 @@ use this style in order to get the arrows or etc., but would still like to have
 normal keyboard navigation take place, you should create and send a
 wxNavigationKeyEvent in response to the key events for Tab and
 Shift-Tab.}
 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,
 \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,


@@ -72,7 +82,9 @@ repainted, then children being painted over them. Windows only.}
 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
 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}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.


@@ -549,7 +561,8 @@ nothing was done, i.e. if the window had already been in the specified state.
 \wxheading{See also}
 
 \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp

-\helpref{wxWindow::Disable}{wxwindowdisable}
+\helpref{wxWindow::Disable}{wxwindowdisable},\rtfsp
+\helpref{wxRadioBox::Enable}{wxradioboxenable}

 
 
 \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus}
 
 
 \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus}


@@ -1308,7 +1321,7 @@ method. {\bf GetWindowStyle()} is another name for the same function.
 
 \constfunc{wxWindowVariant}{GetWindowVariant}{\void}
 
 
 \constfunc{wxWindowVariant}{GetWindowVariant}{\void}
 

-Returns the value previous passed to
+Returns the value previously passed to

 \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
 
 
 \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
 
 


@@ -1473,20 +1486,23 @@ layout is on, this function gets called automatically when the window is resized
 
 \membersection{wxWindow::LineDown}\label{wxwindowlinedown}
 
 
 \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}
 
 
 
 \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}
 
 
 
 \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}
 
 
 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}


@@ -2204,17 +2220,24 @@ remove the event handler.
 
 \func{void}{Raise}{\void}
 
 
 \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}
 
 
 
 \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{Parameters}
 


@@ -2268,7 +2291,8 @@ hotkey with this modifier/virtualKeyCode combination.
 \wxheading{Remarks}
 
 Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
 \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}
 
 
 \wxheading{See also}
 


@@ -3117,16 +3141,20 @@ value should be used.}
 
 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
 
 
 \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.\\
 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.\\
 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.
 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}
 }
 
 \wxheading{Remarks}


@@ -3154,7 +3182,7 @@ implements the following methods:\par
 
 \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
 
 
 \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},
  \param{int}{ incW=-1}, \param{int}{ incH=-1}}
 
 \func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize},


@@ -3398,8 +3426,9 @@ done because it already was in the requested state.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::IsShown}{wxwindowisshown}
-
+\helpref{wxWindow::IsShown}{wxwindowisshown},\rtfsp
+\helpref{wxWindow::Hide}{wxwindowhide},\rtfsp
+\helpref{wxRadioBox::Show}{wxradioboxshow}

 
 
 \membersection{wxWindow::Thaw}\label{wxwindowthaw}
 
 
 \membersection{wxWindow::Thaw}\label{wxwindowthaw}


@@ -3473,12 +3502,12 @@ This function is currently only implemented under MSW.
 
 \func{virtual void}{Update}{\void}
 
 
 \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}
 
 
 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}