fixing return values and handling of invalid files

[wxWidgets.git] / docs / doxygen / overviews / sizer.h

diff --git a/docs/doxygen/overviews/sizer.h b/docs/doxygen/overviews/sizer.h
index 3fcbfcadb94cc36d9476cdabf647be885d34e758..29299d0a8a01fa109480958d324bcebe53cd3e2d 100644 (file)
--- a/docs/doxygen/overviews/sizer.h
+++ b/docs/doxygen/overviews/sizer.h
@@ -6,11 +6,12 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/*!
+/**
 
-@page overview_sizer Sizer Overview
+@page overview_sizer Sizers Overview
 
-Classes: wxSizer, wxGridSizer, wxFlexGridSizer, wxBoxSizer, wxStaticBoxSizer
+Classes: wxSizer, wxBoxSizer, wxStaticBoxSizer, wxGridSizer, wxFlexGridSizer,
+         wxGridBagSizer
 
 Sizers, as represented by the wxSizer class and its descendants in the
 wxWidgets class hierarchy, have become the method of choice to define the
@@ -295,7 +296,7 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title )
 {
     wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
 
-    // create text ctrl with minimal size 100x60 that is horizontally and 
+    // create text ctrl with minimal size 100x60 that is horizontally and
     // vertically stretchable with a border width of 10
     topsizer->Add(
         new wxTextCtrl( this, -1, "My text.", wxDefaultPosition, wxSize(100,60), wxTE_MULTILINE),
@@ -303,20 +304,20 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title )
 
     wxBoxSizer *button_sizer = new wxBoxSizer( wxHORIZONTAL );
 
-    //create two buttons that are horizontally unstretchable, 
+    //create two buttons that are horizontally unstretchable,
     // with an all-around border with a width of 10 and implicit top alignment
     button_sizer->Add(
         new wxButton( this, wxID_OK, "OK" ),
-        wxSizerFlags(0).Align().Border(wxALL, 10));       
+        wxSizerFlags(0).Align().Border(wxALL, 10));
 
     button_sizer->Add(
         new wxButton( this, wxID_CANCEL, "Cancel" ),
-        wxSizerFlags(0).Align().Border(wxALL, 10));    
+        wxSizerFlags(0).Align().Border(wxALL, 10));
 
     //create a sizer with no border and centered horizontally
     topsizer->Add(
         button_sizer,
-        wxSizerFlags(0).Center() ); 
+        wxSizerFlags(0).Center() );
 
     SetSizerAndFit(topsizer); // use the sizer for layout and set size and hints
 }
@@ -339,10 +340,13 @@ necessarily the same height or width as in the wxGridSizer.
 wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static box
 around the sizer. Note that this static box has to be created separately.
 
+wxGridBagSizer is a rather special kind of sizer which, unlike the other
+classes, allows to directly put the elements at the given position in the
+sizer. Please see its documentation for more details.
 
 @section overview_sizer_button CreateButtonSizer
 
-As a convenience, CreateButtonSizer(long flags) can be used to create a
+As a convenience, wxDialog::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: