]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sizer.tex
Further stream tests, doc updates and minor clean-ups.
[wxWidgets.git] / docs / latex / wx / sizer.tex
index c588beb1eba792eef4b4d5ac0481088f5f3e278f..8401f7fb86f7cfe59b94b4918dad39a2c95b6ab4 100644 (file)
@@ -4,18 +4,19 @@ wxSizer is the abstract base class used for laying out subwindows in a window. Y
 cannot use wxSizer directly; instead, you'll have to use \helpref{wxBoxSizer}{wxboxsizer}
 or \helpref{wxStaticBoxSizer}{wxstaticboxsizer}.
 
-The layout algorithm used by sizers in wxWindows closely related to layout
+The layout algorithm used by sizers in wxWindows is closely related to layout
 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is
 based upon the idea of the individual subwindows reporting their minimal required
 size and their ability to get stretched if the size of the parent window has changed.
 This will most often mean, that the programmer does not set the original size of
-the dialog in the beginning, rather the top-most sizer will get queried and it will
-then query its children. Its children can be normal windows or other sizers, so that
-a hierachy of sizer can be constructed. Note that sizer are not derived from wxWindows
-and thus do not interfere with tab ordering and require very little resources compared
+a dialog in the beginning, rather the dialog will assigned a sizer and this sizer
+will be queried about the recommended size. The sizer in turn will query its
+children, which can be normal windows, empty space or other sizers, so that
+a hierarchy of sizers can be constructed. Note that wxSizer does not derive from wxWindow
+and thus do not interfere with tab ordering and requires very little resources compared
 to a real window on screen.
 
-What makes sizers so well fitted for use in wxWindows, is the fact that every control
+What makes sizers so well fitted for use in wxWindows is the fact that every control
 reports its own minimal size and the algorithm can handle differences in font sizes
 or different window (dialog item) sizes on different platforms without problems. If e.g.
 the standard font as well as the overall design of Motif widgets requires more space than
@@ -66,7 +67,7 @@ sizer and thus to create hierarchies of sizers (typically a vertical box as the
 horizontal boxes on the level beneath).}
 
 \docparam{width and height}{The dimension of a spacer to be added to the sizer. Adding spacers to sizers
-gives more flexilibilty in the design of dialogs; imagine for example a vertical box with two buttons at the
+gives more flexilibilty in the design of dialogs; imagine for example a horizontal box with two buttons at the
 bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable
 using the {\it option} flag and the result will be that the left button will be aligned with the left
 side of the dialog and the right button with the right side - the space in between will shrink and grow with
@@ -77,7 +78,7 @@ to indicate if a child of a sizer can change its size in the main orientation of
 0 stands for not changable and a value of more than zero in interpreted relative to the value of other
 children of the same wxBoxSizer. You might, e.g., have a horizontal wxBoxSizer with three children, two
 of which are supposed to change their size with the sizer, then the two stretchable windows would get a
-value of 1 each to make them grow and shrink equally with the sizer's vertical dimension.}
+value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.}
 
 \docparam{flag}{This parameter can be used to set a number of flags which can be combined using
 the binary OR operator |. Two main behaviours are defined using these flags: One is the border
@@ -87,9 +88,12 @@ determine the child window's behaviour if the size of the sizer changes, but - i
 the {\it option} flag - not in the main orientation, but the respectively other orientation. So
 if you created a wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the
 sizer changes its horizontal size. A child may get resized to completely fill out the new size (using
-either wxGROW or wxEXPAND), may get centered (wxCENTER or wxCENTRE) or may get aligned to either
-side (wxALIGN\_LEFT and wxALIGN\_TOP are set to 0 and thus represent the default, wxALIGN\_RIGHT and
-wxALIGN\_BOTTOM have their obvious meaning.}
+either wxGROW or wxEXPAND), may get proportionally resized (wxSHAPED), may get centered (wxALIGN\_CENTER
+or wxALIGN\_CENTRE) or may get aligned to either side (wxALIGN\_LEFT and wxALIGN\_TOP are set to 0
+and thus represent the default, wxALIGN\_RIGHT and wxALIGN\_BOTTOM have their obvious meaning).
+With proportional resize, a child may also be centered in the main orientation using
+wxALIGN\_CENTER\_VERTICAL (same as wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL
+(same as wxALIGN\_CENTRE\_HORIZONTAL) flags.}
 
 \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}