a couple of wors about wxObjArray::Index()

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 7a01f997f8b45752f0d813c8e22ccbded401f931..d1f4b13facf91d16832a91f4e2ca3e8837cf2b7f 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -143,9 +143,15 @@ A synonym for \helpref{Centre}{wxwindowcentre}.
 
 A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}.
 
 
 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}
 
 \membersection{wxWindow::Centre}\label{wxwindowcentre}
 

-\func{void}{Centre}{\param{int}{ direction = wxHORIZONTAL}}
+\func{void}{Centre}{\param{int}{ direction = wxBOTH}}

 
 Centres the window.
 
 
 Centres the window.
 


@@ -156,7 +162,8 @@ or {\tt wxBOTH}. It may also include {\tt wxCENTRE\_ON\_SCREEN} flag
 if you want to center the window on the entire screen and not on its
 parent 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}
 
 
 \wxheading{Remarks}
 


@@ -169,9 +176,10 @@ centered relative to the screen anyhow.
 
 \membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent}
 
 
 \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{Parameters}
 


@@ -187,7 +195,23 @@ window is not a top level window, then behaviour is the same as
 
 \wxheading{See also}
 
 
 \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}
 
 
 \membersection{wxWindow::Clear}\label{wxwindowclear}
 


@@ -453,7 +477,7 @@ Returns the background colour of the window.
 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
 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

-\helpref{wxPanel}wxpanel}), the size returned by this function will be the
+\helpref{wxPanel}{wxpanel}), the size returned by this function will be the

 same as the size the window would have had after calling
 \helpref{Fit}{wxwindowfit}.
 
 same as the size the window would have had after calling
 \helpref{Fit}{wxwindowfit}.
 


@@ -827,7 +851,7 @@ implements the following methods:\par
 \twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{}
 \twocolitem{{\bf IsExposedPoint(pt)}}{}
 \twocolitem{{\bf IsExposedRect(rect)}}{}
 \twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{}
 \twocolitem{{\bf IsExposedPoint(pt)}}{}
 \twocolitem{{\bf IsExposedRect(rect)}}{}

-\end{twocollist}}
+\end{twocollist}}}

 
 \membersection{wxWindow::IsRetained}\label{wxwindowisretained}
 
 
 \membersection{wxWindow::IsRetained}\label{wxwindowisretained}
 


@@ -2271,10 +2295,6 @@ Sets the window's title. Applicable only to frames and dialogs.
 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
 create a new validator of this type.
 
 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::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag}
-
-\func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}}
-

 \membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
 
 \func{void}{SetWindowStyle}{\param{long}{ style}}
 \membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}
 
 \func{void}{SetWindowStyle}{\param{long}{ style}}