interface/wx/wrapsizer.h

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