split wxSizer::Fit() into ComputeFittingWindow/ClientSize() that only does computatio...

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

diff --git a/docs/latex/wx/tlw.tex b/docs/latex/wx/tlw.tex
index dfcb1d2d9f1ca687ec2a6f168fce28c8e4204ea7..db2f329cfdca326cf3a4e0d2f026158fd0b98fb1 100644 (file)
--- a/docs/latex/wx/tlw.tex
+++ b/docs/latex/wx/tlw.tex
@@ -26,6 +26,10 @@ applicable for the two classes above.
 
 <wx/toplevel.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -40,6 +44,29 @@ Returns \true if the platform supports making the window translucent.
 \helpref{wxTopLevelWindow::SetTransparent}{wxtoplevelwindowsettransparent}
 
 
+\membersection{wxWindow::CenterOnScreen}\label{wxtoplevelwindowcenteronscreen}
+
+\func{void}{CenterOnScreen}{\param{int}{ direction}}
+
+A synonym for \helpref{CentreOnScreen}{wxtoplevelwindowcentreonscreen}.
+
+
+\membersection{wxTopLevelWindow::CentreOnScreen}\label{wxtoplevelwindowcentreonscreen}
+
+\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
+
+Centres the window on screen.
+
+\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{wxTopLevelWindow::EnableCloseButton}\label{wxtoplevelenableclosebutton}
 
 \func{bool}{EnableCloseButton}{\param{bool}{ enable = true}}
@@ -47,7 +74,10 @@ Returns \true if the platform supports making the window translucent.
 Enables or disables the Close button (most often in the right
 upper corner of a dialog) and the Close entry of the system
 menu (most often in the left upper corner of the dialog).
-Currently only implemented for wxMSW and wxGTK.
+Currently only implemented for wxMSW and wxGTK. Returns
+true if operation was successful. This may be wrong on
+X11 (including GTK+) where the window manager may not support
+this operation and there is no way to find out.
 
 \membersection{wxTopLevelWindow::GetDefaultItem}\label{wxtoplevelwindowgetdefaultitem}
 
@@ -277,6 +307,45 @@ Unavailable on full keyboard machines.
 \helpref{wxTopLevelWindow::SetRightMenu}{wxtoplevelwindowsetrightmenu}.
 
 
+\membersection{wxTopLevelWindow::SetMaxSize}\label{wxtoplevelwindowsetmaxsize}
+
+\func{void}{SetMaxSize}{\param{const wxSize\& }{size}}
+
+A simpler interface for setting the size hints than
+\helpref{SetSizeHints}{wxtoplevelwindowsetsizehints}.
+
+\membersection{wxTopLevelWindow::SetMinSize}\label{wxtoplevelwindowsetminsize}
+
+\func{void}{SetMinSize}{\param{const wxSize\& }{size}}
+
+A simpler interface for setting the size hints than
+\helpref{SetSizeHints}{wxtoplevelwindowsetsizehints}.
+
+\membersection{wxTopLevelWindow::SetSizeHints}\label{wxtoplevelwindowsetsizehints}
+
+\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{const wxSize\&}{ maxSize=wxDefaultSize}, \param{const wxSize\&}{ incSize=wxDefaultSize}}
+
+Allows specification of minimum and maximum window sizes, and window size increments.
+If a pair of values is not set (or set to -1), no constraints will be used.
+
+\docparam{incW}{Specifies the increment for sizing the width (GTK/Motif/Xt only).}
+
+\docparam{incH}{Specifies the increment for sizing the height (GTK/Motif/Xt only).}
+
+\docparam{incSize}{Increment size (only taken into account under X11-based
+ports such as wxGTK/wxMotif/wxX11).}
+
+\wxheading{Remarks}
+
+Notice that this function not only prevents the user from resizing the window
+outside the given bounds but it also prevents the program itself from doing it
+using \helpref{SetSize}{wxwindowsetsize}.
+
+
 \membersection{wxTopLevelWindow::SetRightMenu}\label{wxtoplevelwindowsetrightmenu}
 
 \func{void}{SetRightMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}