X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/de2b67e6996decc38233075cb803cce0cfe80168..4e15d1caa03346c126015019c1fdf093033ef40b:/docs/doxygen/overviews/sizer.h
diff --git a/docs/doxygen/overviews/sizer.h b/docs/doxygen/overviews/sizer.h
index 3fcbfcadb9..a2401c1526 100644
--- a/docs/doxygen/overviews/sizer.h
+++ b/docs/doxygen/overviews/sizer.h
@@ -3,14 +3,14 @@
// Purpose: topic overview
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-/*!
+/**
-@page overview_sizer Sizer Overview
+@page overview_sizer Sizers Overview
-Classes: wxSizer, wxGridSizer, wxFlexGridSizer, wxBoxSizer, wxStaticBoxSizer
+@tableofcontents
Sizers, as represented by the wxSizer class and its descendants in the
wxWidgets class hierarchy, have become the method of choice to define the
@@ -28,16 +28,10 @@ classes.
For information about the wxWidgets resource system, which can describe
sizer-based dialogs, see the @ref overview_xrc.
-@li @ref overview_sizer_idea
-@li @ref overview_sizer_features
-@li @ref overview_sizer_hiding
-@li @ref overview_sizer_box
-@li @ref overview_sizer_types
-@li @ref overview_sizer_button
+@see wxSizer, wxBoxSizer, wxStaticBoxSizer, wxGridSizer, wxFlexGridSizer,
+ wxGridBagSizer
-
-
@section overview_sizer_idea The Idea Behind Sizers
@@ -295,7 +289,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 +297,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 +333,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:
@@ -364,4 +361,3 @@ wxMORE // return wxID_MORE
@endcode
*/
-