silence gcc warnings about values not handled in switch

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 3cbe01776773af9c45fd6a72457394d0d2949dd1..4c15ed17196ad2feef0bc39e3af1a6d8cf48b05b 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -355,7 +355,7 @@ Usually it is only used with the top level windows (wxFrame and wxDialog
 classes) as the others are not supposed to have any special OnClose() logic.
 
 The close handler should check whether the window is being deleted forcibly,
 classes) as the others are not supposed to have any special OnClose() logic.
 
 The close handler should check whether the window is being deleted forcibly,

-using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}, in which case it
+using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}, in which case it

 should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
 
 {\it Note} that calling Close does not guarantee that the window will be
 should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
 
 {\it Note} that calling Close does not guarantee that the window will be


@@ -689,6 +689,10 @@ a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 
 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 

+\wxheading{See also}
+
+\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker}
+

 
 \membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable}
 
 
 \membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable}
 


@@ -1107,9 +1111,9 @@ windows.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{x}{Receives the x position of the window.}
+\docparam{x}{Receives the x position of the window if non-\NULL.}

 
 

-\docparam{y}{Receives the y position of the window.}
+\docparam{y}{Receives the y position of the window if non-\NULL.}

 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par


@@ -1129,12 +1133,53 @@ method:\par
 }}
 
 
 }}
 
 

+\wxheading{See also}
+
+\helpref{GetScreenPosition}{wxwindowgetscreenposition}
+
+

 \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::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}
 
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 

+\wxheading{See also}
+
+\helpref{GetScreenRect}{wxwindowgetscreenrect}
+
+
+\membersection{wxWindow::GetScreenPosition}\label{wxwindowgetscreenposition}
+
+\constfunc{virtual void}{GetScreenPosition}{\param{int* }{x}, \param{int* }{y}}
+
+\constfunc{wxPoint}{GetScreenPosition}{\void}
+
+Returns the window position in screen coordinates, whether the window is a
+child window or a top level one.
+
+\wxheading{Parameters}
+
+\docparam{x}{Receives the x position of the window on the screen if non-\NULL.}
+
+\docparam{y}{Receives the y position of the window on the screen if non-\NULL.}
+
+\wxheading{See also}
+
+\helpref{GetPosition}{wxwindowgetposition}
+
+
+\membersection{wxWindow::GetScreenRect}\label{wxwindowgetscreenrect}
+
+\constfunc{virtual wxRect}{GetScreenRect}{\void}
+
+Returns the size and position of the window on the screen as a 
+\helpref{wxRect}{wxrect} object.
+
+\wxheading{See also}
+
+\helpref{GetRect}{wxwindowgetrect}
+

 
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 


@@ -1498,7 +1543,7 @@ This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$.
 
 \func{void}{Lower}{\void}
 
 
 \func{void}{Lower}{\void}
 

-Lowers the window to the bottom of the window hierarchy.
+Lowers the window to the bottom of the window hierarchy (z-order).

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2197,9 +2242,9 @@ remove the event handler.
 
 \func{void}{Raise}{\void}
 
 
 \func{void}{Raise}{\void}
 

-Raises the window to the top of the window hierarchy.
+Raises the window to the top of the window hierarchy (z-order).

 
 

-In current version of wxWidgets this works both for manage and child windows.
+In current version of wxWidgets this works both for managed and child windows.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2314,7 +2359,7 @@ not delete) it from it.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{handler}{The event handler to remove, must be non {\tt NULL} and
+\docparam{handler}{The event handler to remove, must be non-{\tt NULL} and

 must be present in this windows event handlers chain}
 
 \wxheading{Return value}
 must be present in this windows event handlers chain}
 
 \wxheading{Return value}


@@ -2404,9 +2449,7 @@ on top/bottom and nothing was done.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-This function is currently only implemented under MSW and wxTextCtrl under
-wxGTK (it also works for wxScrolledWindow derived classes under all
-platforms).
+This function is currently only implemented under MSW and wxGTK.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2457,16 +2500,21 @@ See also \helpref{wxAccessible}{wxaccessible}.
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
 
 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
 
 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will

-be called automatically when the window is resized. It is called implicitly by
-\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use
+be called automatically when the window is resized. Please note that this only
+happens for the windows usually used to contain children, namely 
+\helpref{wxPanel}{wxpanel} and \helpref{wxTopLevelWindow}{wxtoplevelwindow} 
+(and the classes deriving from them).
+
+This method is called implicitly by 
+\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use 

 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
 manually or otherwise the window layout won't be correctly updated when its
 size changes.
 
 \wxheading{Parameters}
 
 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
 manually or otherwise the window layout won't be correctly updated when its
 size changes.
 
 \wxheading{Parameters}
 

-\docparam{autoLayout}{Set this to {\tt true} if you wish the Layout function to be called
-from within wxWindow::OnSize functions.}
+\docparam{autoLayout}{Set this to \true if you wish the Layout function to be
+called automatically when the window is resized.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2984,7 +3032,8 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp

-\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
+\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow},\rtfsp
+\helpref{wxScrollWinEvent}{wxscrollwinevent}

 
 \begin{comment}
 
 
 \begin{comment}
 


@@ -3127,7 +3176,7 @@ value should be used.}
 {\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
 a wxWidgets-supplied default width.\\
 {\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
 {\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
 a wxWidgets-supplied default width.\\
 {\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate

-a wxWidgets-supplied default width.\\
+a wxWidgets-supplied default height.\\

 {\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
 {\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used


@@ -3407,6 +3456,10 @@ Reenables window updating after a previous call to
 \helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called
 exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}.
 
 \helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called
 exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}.
 

+\wxheading{See also}
+
+\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker}
+

 
 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
 
 
 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}