wxWidgets/interface/wx/wrapsizer.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

77 lines
2.5 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: wrapsizer.h
// Purpose: interface of wxWrapSizer
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// flags for wxWrapSizer
enum
{
wxEXTEND_LAST_ON_EACH_LINE,
wxREMOVE_LEADING_SPACES,
wxWRAPSIZER_DEFAULT_FLAGS
};
/**
@class wxWrapSizer
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.
@library{wxcore}
@category{winlayout}
@see wxBoxSizer, wxSizer, @ref overview_sizer
*/
class wxWrapSizer : public wxBoxSizer
{
public:
/**
Constructor for a wxWrapSizer.
@a orient determines the primary direction of the sizer (the most common
case being @c wxHORIZONTAL). The flags parameter can be a combination of
the values @c wxEXTEND_LAST_ON_EACH_LINE which will cause the last item
on each line to use any remaining space on that line and @c wxREMOVE_LEADING_SPACES
which removes any spacer elements from the beginning of a row.
Both of these flags are on by default.
*/
wxWrapSizer(int orient = wxHORIZONTAL,
int flags = wxWRAPSIZER_DEFAULT_FLAGS);
/**
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.
Returns @true if the information was used (and the sub-item min size was
updated).
*/
virtual bool InformFirstDirection(int direction, int size,
int availableOtherDir);
virtual void RecalcSizes();
virtual wxSize CalcMin();
protected:
/**
Can be overridden in the derived classes to treat some normal items as
spacers.
This method is used to determine whether the given @a item should be
considered to be a spacer for the purposes of @c wxREMOVE_LEADING_SPACES
implementation. By default only returns @true for the real spacers.
*/
virtual bool IsSpaceItem(wxSizerItem *item) const;
};