interface/wrapsizer.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wrapsizer.h
   3 // Purpose:     documentation for wxWrapSizer class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxWrapSizer
  11     @wxheader{wrapsizer.h}
  12
  13     A wrap sizer lays out its items in a single line, like a box sizer -- as long
  14     as there is space available in that direction. Once all available space in
  15     the primary direction has been used, a new line is added and items are added
  16     there.
  17
  18     So a wrap sizer has a primary orientation for adding items, and adds lines
  19     as needed in the secondary direction.
  20
  21     @library{wxcore}
  22     @category{winlayout}
  23
  24     @seealso
  25     wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview"
  26 */
  27 class wxWrapSizer : public wxBoxSizer
  28 {
  29 public:
  30     /**
  31         Constructor for a wxWrapSizer. @e orient determines the primary direction of
  32         the sizer (the most common case being @c wxHORIZONTAL). The flags
  33         parameter may have the value @c wxEXTEND_LAST_ON_EACH_LINE which will
  34         cause the last item on each line to use any remaining space on that line.
  35     */
  36     wxWrapSizer(int orient, int flags);
  37
  38     /**
  39         Not used by an application. This is the mechanism by which sizers can inform
  40         sub-items of the first determined size component. The sub-item can then better
  41         determine its size requirements.
  42
  43         Returns @true if the information was used (and the sub-item min size was
  44         updated).
  45     */
  46     bool InformFirstDirection(int direction, int size,
  47                               int availableOtherDir);
  48 };