removed virtual from functions which are not; expanded wxWindow description

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

diff --git a/docs/latex/wx/tsizer.tex b/docs/latex/wx/tsizer.tex
index 22a7b5440098a3876ee1be000129f0b9929febb1..3cede468fb7befd0a7b348f28852f0cebc66a99a 100644 (file)
--- a/docs/latex/wx/tsizer.tex
+++ b/docs/latex/wx/tsizer.tex
@@ -3,7 +3,8 @@
 Classes: \helpref{wxSizer}{wxsizer}, \helpref{wxGridSizer}{wxgridsizer}, 
 \helpref{wxFlexGridSizer}{wxflexgridsizer}, \helpref{wxBoxSizer}{wxboxsizer}, 
 \helpref{wxStaticBoxSizer}{wxstaticboxsizer}, 
 Classes: \helpref{wxSizer}{wxsizer}, \helpref{wxGridSizer}{wxgridsizer}, 
 \helpref{wxFlexGridSizer}{wxflexgridsizer}, \helpref{wxBoxSizer}{wxboxsizer}, 
 \helpref{wxStaticBoxSizer}{wxstaticboxsizer}, 

-\helpref{wxNotebookSizer}{wxnotebooksizer}
+\helpref{wxNotebookSizer}{wxnotebooksizer},
+\helpref{CreateButtonSizer}{createbuttonsizer}

 
 Sizers, as represented by the wxSizer class and its descendants in
 the wxWindows class hierarchy, have become the method of choice to
 
 Sizers, as represented by the wxSizer class and its descendants in
 the wxWindows class hierarchy, have become the method of choice to


@@ -61,13 +62,13 @@ calculate their size (such as a checkbox) whereas others (such as a listbox)
 don't have any natural width or height and thus require an explicit size. Some controls
 can calculate their height, but not their width (e.g. a single line text control):
 
 don't have any natural width or height and thus require an explicit size. Some controls
 can calculate their height, but not their width (e.g. a single line text control):
 

-\center{
-\image{}{sizer03.gif}
+\newcommand{\myimage}[1]{\mbox{\image{0cm;0cm}{#1}}}

 
 

-\image{}{sizer04.gif}
-
-\image{}{sizer05.gif}
-}
+\begin{center}
+\myimage{sizer03.eps}\gifsep
+\myimage{sizer04.eps}\gifsep
+\myimage{sizer05.eps}
+\end{center}

 
 {\bf A border:} The border is just empty space and is used to separate dialog items
 in a dialog. This border can either be all around, or at any combination of sides
 
 {\bf A border:} The border is just empty space and is used to separate dialog items
 in a dialog. This border can either be all around, or at any combination of sides


@@ -75,13 +76,11 @@ such as only above and below the control. The thickness of this border must be s
 explicitly, typically 5 points. The following samples show dialogs with only one
 dialog item (a button) and a border of 0, 5, and 10 pixels around the button:
 
 explicitly, typically 5 points. The following samples show dialogs with only one
 dialog item (a button) and a border of 0, 5, and 10 pixels around the button:
 

-\center{
-\image{}{sizer00.gif}
-
-\image{}{sizer01.gif}
-
-\image{}{sizer02.gif}
-}
+\begin{center}
+\myimage{sizer00.eps}\gifsep
+\myimage{sizer01.eps}\gifsep
+\myimage{sizer02.eps}
+\end{center}

 
 {\bf An alignment:} Often, a dialog item is given more space than its minimal size
 plus its border. Depending on what flags are used for the respective dialog
 
 {\bf An alignment:} Often, a dialog item is given more space than its minimal size
 plus its border. Depending on what flags are used for the respective dialog


@@ -91,9 +90,9 @@ the centre of the available space or to either side of the space. The following
 sample shows a listbox and three buttons in a horizontal box sizer; one button
 is centred, one is aligned at the top, one is aligned at the bottom:
 
 sample shows a listbox and three buttons in a horizontal box sizer; one button
 is centred, one is aligned at the top, one is aligned at the bottom:
 

-\center{
-\image{}{sizer06.gif}
-}
+\begin{center}
+\myimage{sizer06.eps}
+\end{center}

 
 {\bf A stretch factor:} If a sizer contains more than one child and it is offered
 more space than its children and their borders need, the question arises how to
 
 {\bf A stretch factor:} If a sizer contains more than one child and it is offered
 more space than its children and their borders need, the question arises how to


@@ -108,12 +107,27 @@ three buttons, the first one has a stretch factor of 1 and thus gets stretched,
 whereas the other two buttons have a stretch factor of zero and keep their
 initial width:
 
 whereas the other two buttons have a stretch factor of zero and keep their
 initial width:
 

-\center{
-\image{}{sizer07.gif}
-}
+\begin{center}
+\myimage{sizer07.eps}
+\end{center}

 
 Within wxDesigner, this stretch factor gets set from the {\it Option} menu.
 
 
 Within wxDesigner, this stretch factor gets set from the {\it Option} menu.
 

+\subsubsection{Hiding controls using sizers}\label{sizershiding}
+
+You can hide controls contained in sizers the same way you would hide any control,
+using the \helpref{wxWindow::Show}{wxwindowshow} method.
+
+However, wxSizer also offers a separate method which can tell the sizer not to 
+consider that control in its size calculations.  To hide a window using the sizer,
+call \helpref{wxSizer::Show}{wxsizershow}.  You must then call Layout on the sizer 
+to force an update.
+
+This is useful when hiding parts of the interface, since you can avoid removing
+the controls from the sizer and having to add them back later.
+
+Note: This is supported only by wxBoxSizer and wxFlexGridSizer.
+

 \wxheading{wxBoxSizer}
 
 \helpref{wxBoxSizer}{wxboxsizer} can lay out its children either vertically
 \wxheading{wxBoxSizer}
 
 \helpref{wxBoxSizer}{wxboxsizer} can lay out its children either vertically


@@ -127,18 +141,18 @@ stretch factor determines how much the child can be stretched horizontally.
 The following sample shows the same dialog as in the last sample,
 only the box sizer is a vertical box sizer now:
 
 The following sample shows the same dialog as in the last sample,
 only the box sizer is a vertical box sizer now:
 

-\center{
-\image{}{sizer08.gif}
-}
+\begin{center}
+\myimage{sizer08.eps}
+\end{center}

 
 \wxheading{wxStaticBoxSizer}
 
 \helpref{wxStaticBoxSixer}{wxstaticboxsizer} is the same as a wxBoxSizer, but surrounded by a
 static box. Here is a sample:
 
 
 \wxheading{wxStaticBoxSizer}
 
 \helpref{wxStaticBoxSixer}{wxstaticboxsizer} is the same as a wxBoxSizer, but surrounded by a
 static box. Here is a sample:
 

-\center{
-\image{}{sizer09.gif}
-}
+\begin{center}
+\myimage{sizer09.eps}
+\end{center}

 
 \wxheading{wxGridSizer}
 
 
 \wxheading{wxGridSizer}
 


@@ -148,9 +162,9 @@ this case the text control in the left bottom border. Either the number
 of columns or the number or rows is fixed and the grid sizer will grow
 in the respectively other orientation if new children are added:
 
 of columns or the number or rows is fixed and the grid sizer will grow
 in the respectively other orientation if new children are added:
 

-\center{
-\image{}{sizer10.gif}
-}
+\begin{center}
+\myimage{sizer10.eps}
+\end{center}

 
 For programming information, see \helpref{wxGridSizer}{wxgridsizer}.
 
 
 For programming information, see \helpref{wxGridSizer}{wxgridsizer}.
 


@@ -164,9 +178,9 @@ rows can be declared to be stretchable if the sizer is assigned
 a size different from that which it requested. The following sample shows
 the same dialog as the one above, but using a flex grid sizer:
 
 a size different from that which it requested. The following sample shows
 the same dialog as the one above, but using a flex grid sizer:
 

-\center{
-\image{}{sizer11.gif}
-}
+\begin{center}
+\myimage{sizer11.eps}
+\end{center}

 
 \wxheading{wxNotebookSizer}
 
 
 \wxheading{wxNotebookSizer}
 


@@ -194,7 +208,7 @@ the buttons shall be centred as the width of the dialog changes.
 It is the unique feature of a box sizer, that it can grow in both directions (height and
 width) but can distribute its growth in the main direction (horizontal for a row) {\it unevenly} 
 among its children. In our example case, the vertical sizer is supposed to propagate all its
 It is the unique feature of a box sizer, that it can grow in both directions (height and
 width) but can distribute its growth in the main direction (horizontal for a row) {\it unevenly} 
 among its children. In our example case, the vertical sizer is supposed to propagate all its

-height changes to only the text area, not to the button area. This is determined by the {\it option} parameter
+height changes to only the text area, not to the button area. This is determined by the {\it proportion} parameter

 when adding a window (or another sizer) to a sizer. It is interpreted
 as a weight factor, i.e. it can be zero, indicating that the window may not be resized
 at all, or above zero. If several windows have a value above zero, the value is interpreted
 when adding a window (or another sizer) to a sizer. It is interpreted
 as a weight factor, i.e. it can be zero, indicating that the window may not be resized
 at all, or above zero. If several windows have a value above zero, the value is interpreted


@@ -254,11 +268,9 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title )
      0,                // make vertically unstretchable
      wxALIGN_CENTER ); // no border and centre horizontally
 
      0,                // make vertically unstretchable
      wxALIGN_CENTER ); // no border and centre horizontally
 

-  SetAutoLayout( TRUE );     // tell dialog to use sizer
-  SetSizer( topsizer );      // actually set the sizer
+  SetSizer( topsizer );      // use the sizer for layout

 
 

-  topsizer->Fit( this );            // set size to minimum size as calculated by the sizer
-  topsizer->SetSizeHints( this );   // set size hints to honour mininum size
+  topsizer->SetSizeHints( this );   // set size hints to honour minimum size

 }
 \end{verbatim}
 
 }
 \end{verbatim}
 


@@ -288,8 +300,8 @@ sizer.
 
 In order to query the size of notebook page, this page needs to have its
 own sizer, otherwise the wxNotebookSizer will ignore it. Notebook pages
 
 In order to query the size of notebook page, this page needs to have its
 own sizer, otherwise the wxNotebookSizer will ignore it. Notebook pages

-get their size by assigning one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer} 
-and setting the auto-layout option to TRUE using 
+get their sizer by assigning one to them using \helpref{wxWindow::SetSizer}{wxwindowsetsizer} 
+and setting the auto-layout option to true using 

 \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}. Here is one
 example showing how to add a notebook page that the notebook sizer is
 aware of:
 \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}. Here is one
 example showing how to add a notebook page that the notebook sizer is
 aware of:


@@ -306,7 +318,7 @@ aware of:
 
     // Add controls to panel and panelsizer here...
 
 
     // Add controls to panel and panelsizer here...
 

-    panel->SetAutoLayout( TRUE );
+    panel->SetAutoLayout( true );

     panel->SetSizer( panelsizer );
 \end{verbatim}
 
     panel->SetSizer( panelsizer );
 \end{verbatim}
 


@@ -316,3 +328,25 @@ aware of:
 box around the sizer. Note that this static box has to be created 
 separately.
 
 box around the sizer. Note that this static box has to be created 
 separately.
 

+\subsection{CreateButtonSizer}\label{createbuttonsizer}
+
+As a convenience, CreateButtonSizer ( long flags ) can be used to create a standard button sizer
+in which standard buttons are displayed. The following flags can be passed to this function:
+
+
+\begin{verbatim}
+    wxYES_NO // Add Yes/No subpanel
+    wxYES    // return wxID_YES
+    wxNO     // return wxID_NO
+    wxNO_DEFAULT // make the wxNO button the default, otherwise wxYES or wxOK button will be default
+    
+    wxOK     // return wxID_OK
+    wxCANCEL // return wxID_CANCEL
+    wxHELP   // return wxID_HELP
+    
+    wxFORWARD   // return wxID_FORWARD  
+    wxBACKWARD  // return wxID_BACKWARD 
+    wxSETUP     // return wxID_SETUP    
+    wxMORE      // return wxID_MORE     
+
+\end{verbatim}