a few typo-fix and cosmetic changes to wxFlexGridSizer docs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58568 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-01-31 21:23:43 +00:00
parent 9174364320
commit a008d6e585

View File

@@ -1410,7 +1410,6 @@ enum wxFlexSizerGrowMode
wxFLEX_GROWMODE_ALL wxFLEX_GROWMODE_ALL
}; };
/** /**
@class wxFlexGridSizer @class wxFlexGridSizer
@@ -1454,10 +1453,10 @@ public:
there is extra space available to the sizer. there is extra space available to the sizer.
The @a proportion parameter has the same meaning as the stretch factor The @a proportion parameter has the same meaning as the stretch factor
for the sizers() except that if all proportions are 0, then all columns for the sizers (see wxBoxSizer) except that if all proportions are 0,
are resized equally (instead of not being resized at all). then all columns are resized equally (instead of not being resized at all).
Notice that the row must not be already growable, if you need to change Notice that the column must not be already growable, if you need to change
the proportion you must call RemoveGrowableCol() first and then make it the proportion you must call RemoveGrowableCol() first and then make it
growable (with a different proportion) again. You can use IsColGrowable() growable (with a different proportion) again. You can use IsColGrowable()
to check whether a column is already growable. to check whether a column is already growable.
@@ -1474,7 +1473,7 @@ public:
void AddGrowableRow(size_t idx, int proportion = 0); void AddGrowableRow(size_t idx, int proportion = 0);
/** /**
Returns a wxOrientation value that specifies whether the sizer flexibly Returns a ::wxOrientation value that specifies whether the sizer flexibly
resizes its columns, rows, or both (default). resizes its columns, rows, or both (default).
@return @return
@@ -1492,8 +1491,8 @@ public:
direction if there is one. direction if there is one.
The behaviour of the elements in the flexible direction (i.e. both rows The behaviour of the elements in the flexible direction (i.e. both rows
and columns by default, or rows only if GetFlexibleDirection() is @c and columns by default, or rows only if GetFlexibleDirection() is
wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed @c wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed
by their proportion as specified in the call to AddGrowableRow() or by their proportion as specified in the call to AddGrowableRow() or
AddGrowableCol(). What happens in the other direction depends on the AddGrowableCol(). What happens in the other direction depends on the
value of returned by this function as described below. value of returned by this function as described below.
@@ -1529,12 +1528,12 @@ public:
bool IsRowGrowable(size_t idx); bool IsRowGrowable(size_t idx);
/** /**
Specifies that column idx is no longer growable. Specifies that the @a idx column index is no longer growable.
*/ */
void RemoveGrowableCol(size_t idx); void RemoveGrowableCol(size_t idx);
/** /**
Specifies that row idx is no longer growable. Specifies that the @a idx row index is no longer growable.
*/ */
void RemoveGrowableRow(size_t idx); void RemoveGrowableRow(size_t idx);
@@ -1543,6 +1542,7 @@ public:
Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH
(which is the default value). Any other value is ignored. (which is the default value). Any other value is ignored.
See GetFlexibleDirection() for the explanation of these values. See GetFlexibleDirection() for the explanation of these values.
Note that this method does not trigger relayout. Note that this method does not trigger relayout.
*/ */