X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..2b3416df5d2fe261c67dfc08156ab5745e28c1af:/interface/wrapsizer.h diff --git a/interface/wrapsizer.h b/interface/wrapsizer.h index e79832704c..3109e8cd6e 100644 --- a/interface/wrapsizer.h +++ b/interface/wrapsizer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wrapsizer.h -// Purpose: documentation for wxWrapSizer class +// Purpose: interface of wxWrapSizer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,26 +9,25 @@ /** @class wxWrapSizer @wxheader{wrapsizer.h} - - A wrap sizer lays out its items in a single line, like a box sizer -- as long - as there is space available in that direction. Once all available space in + + A wrap sizer lays out its items in a single line, like a box sizer -- as long + as there is space available in that direction. Once all available space in the primary direction has been used, a new line is added and items are added there. - + So a wrap sizer has a primary orientation for adding items, and adds lines - as needed in the secondary direction. - + as needed in the secondary direction. + @library{wxcore} @category{winlayout} - - @seealso - wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview" + + @see wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview" */ class wxWrapSizer : public wxBoxSizer { public: /** - Constructor for a wxWrapSizer. @e orient determines the primary direction of + Constructor for a wxWrapSizer. @a orient determines the primary direction of the sizer (the most common case being @c wxHORIZONTAL). The flags parameter may have the value @c wxEXTEND_LAST_ON_EACH_LINE which will cause the last item on each line to use any remaining space on that line. @@ -36,13 +35,13 @@ public: wxWrapSizer(int orient, int flags); /** - Not used by an application. This is the mechanism by which sizers can inform + Not used by an application. This is the mechanism by which sizers can inform sub-items of the first determined size component. The sub-item can then better - determine its size requirements. - + determine its size requirements. Returns @true if the information was used (and the sub-item min size was updated). */ bool InformFirstDirection(int direction, int size, int availableOtherDir); }; +