]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: wrapsizer.h | |
e54c96f1 | 3 | // Purpose: interface of wxWrapSizer |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
526954c5 | 6 | // Licence: wxWindows licence |
23324ae1 FM |
7 | ///////////////////////////////////////////////////////////////////////////// |
8 | ||
9 | /** | |
10 | @class wxWrapSizer | |
7c913512 FM |
11 | |
12 | A wrap sizer lays out its items in a single line, like a box sizer -- as long | |
f41d6c8c FM |
13 | as there is space available in that direction. |
14 | Once all available space in the primary direction has been used, a new line | |
15 | is added and items are added there. | |
7c913512 | 16 | |
23324ae1 | 17 | So a wrap sizer has a primary orientation for adding items, and adds lines |
7c913512 FM |
18 | as needed in the secondary direction. |
19 | ||
23324ae1 FM |
20 | @library{wxcore} |
21 | @category{winlayout} | |
7c913512 | 22 | |
f41d6c8c | 23 | @see wxBoxSizer, wxSizer, @ref overview_sizer |
23324ae1 FM |
24 | */ |
25 | class wxWrapSizer : public wxBoxSizer | |
26 | { | |
27 | public: | |
28 | /** | |
f41d6c8c FM |
29 | Constructor for a wxWrapSizer. |
30 | ||
31 | @a orient determines the primary direction of the sizer (the most common | |
32 | case being @c wxHORIZONTAL). The flags parameter can be a combination of | |
33 | the values @c wxEXTEND_LAST_ON_EACH_LINE which will cause the last item | |
34 | on each line to use any remaining space on that line and @c wxREMOVE_LEADING_SPACES | |
35 | which removes any spacer elements from the beginning of a row. | |
36 | ||
37 | Both of these flags are on by default. | |
23324ae1 | 38 | */ |
4fc3ee30 | 39 | wxWrapSizer(int orient = wxHORIZONTAL, |
95b4a59e | 40 | int flags = wxWRAPSIZER_DEFAULT_FLAGS); |
23324ae1 FM |
41 | |
42 | /** | |
f41d6c8c FM |
43 | Not used by an application. |
44 | ||
45 | This is the mechanism by which sizers can inform sub-items of the first | |
46 | determined size component. | |
47 | The sub-item can then better determine its size requirements. | |
48 | ||
23324ae1 FM |
49 | Returns @true if the information was used (and the sub-item min size was |
50 | updated). | |
51 | */ | |
95b4a59e FM |
52 | virtual bool InformFirstDirection(int direction, int size, |
53 | int availableOtherDir); | |
4fc3ee30 VZ |
54 | |
55 | protected: | |
56 | /** | |
57 | Can be overridden in the derived classes to treat some normal items as | |
58 | spacers. | |
59 | ||
60 | This method is used to determine whether the given @a item should be | |
61 | considered to be a spacer for the purposes of @c wxREMOVE_LEADING_SPACES | |
62 | implementation. By default only returns @true for the real spacers. | |
63 | */ | |
64 | virtual bool IsSpaceItem(wxSizerItem *item) const; | |
23324ae1 | 65 | }; |
e54c96f1 | 66 |