VStackLayout is a vertical StackLayout. More...
#include <StackLayout.h>
Inheritance diagram for VStackLayout:
Static Public Member Functions | |
| static VStackLayout * | Create (LayoutControl *parent=0) |
| Creates a Vertical StackLayout Layout Manager. More... | |
 Static Public Member Functions inherited from StackLayout | |
| static StackLayout * | Create (LayoutDirection direction=LD_TopToBottom, LayoutControl *parent=0) |
| Creates a StackLayout Layout Manager. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from StackLayout | |
| LayoutDirection | GetDirection () const |
| Gets the layout direction. More... | |
| void | SetDirection (LayoutDirection direction) |
| Sets the layout direction. More... | |
| void | AddSpacing (int size) |
| Adds a Spacing item to the stack. More... | |
| void | AddStretch (int stretch=0) |
| Adds a blank item with a given Stretch Factor to the stack. More... | |
| void | AddControl (LayoutControl *ctl, int stretch=0, LayoutAlignment alignment=Align_None) |
| Adds a control to the stack. More... | |
| void | AddLayout (LayoutManager *layout, int stretch=0) |
| Adds a child LayoutManager to the stack. More... | |
| void | SetSpacing (int spacing) |
| Sets the horizontal and vertical spacing between items in the layout. More... | |
| int | GetSpacing () const |
| Gets the spacing between items in the layout. More... | |
| bool | SetStretchFactor (LayoutControl *ctl, int stretch) |
| Sets the stretch factor for a given control. More... | |
| bool | SetStretchFactor (LayoutManager *layout, int stretch) |
| Sets the stretch factor for a given layout. More... | |
| void | SetStretchFactor (int index, int stretch) |
| Sets the stretch factor for the item at a given index. More... | |
| int | GetStretchFactor (int index) const |
| Retrieves the stretch factor for the item at a given index. More... | |
| virtual BSize | GetDesiredSize () const override |
| Returns the desired size for this layout item. More... | |
| virtual BSize | GetMinimumSize () const override |
| Returns the minimum size for this layout item. More... | |
| virtual BSize | GetMaximumSize () const override |
| Returns the maximum size for this layout item. More... | |
| virtual bool | HasHeightForWidth () const override |
| Returns whether this layout's preferred height depends on its width. More... | |
| virtual int | GetHeightForWidth (int width) const override |
| Returns the preferred height for this layout item, given the width. More... | |
| virtual int | GetMinimumHeightForWidth (int width) const override |
| Returns the minimum height for this layout item, given the width. More... | |
| virtual LayoutOrientations | GetExpandingOrientations () const override |
| Returns whether this layout item can make use of more space than GetDesiredSize(). More... | |
| virtual void | Invalidate () override |
| Resets the layout's rectangle then calls Update() More... | |
| virtual void | SetDirty () override |
| Resets the layout's rectangle then calls Update() More... | |
| virtual LayoutItem * | ItemAt (int index) const override |
| Retrieves the item at index in the layout and returns the item. More... | |
| virtual LayoutItem * | TakeAt (int index) override |
| Removes the item at index from the layout, and returns the item. More... | |
| virtual size_t | Count () const override |
| Returns the number of items in this layout. More... | |
| virtual void | SetGeometry (const BRect &rect) override |
| Sets the geometry for this layout item to the given rectangle. More... | |
| Public Member Functions inherited from LayoutManager | |
| virtual void | AddItem (LayoutItem *item)=0 |
| Adds a LayoutItem to this Layout Manager. More... | |
| virtual int | IndexOf (LayoutControl *ctl) const |
| Searches for the control in this layout (not including child layouts). More... | |
| virtual int | IndexOf (LayoutItem *item) const |
| Searches for the LayoutItem in this layout (not including child layouts). More... | |
| void | WindowSizeDoLayout (const BSize &size) |
| Notifies this LayoutManager that the Window size has changed and all child items should be laid out accordingly. More... | |
| void | VisibleDoLayout () |
| Notifies this LayoutManager that the layout has changed visibility and all child items should be laid out accordingly. More... | |
| void | ItemSizeDoLayout () |
| Notifies this LayoutManager that a child has changed size and all child items should be laid out accordingly. More... | |
| LayoutManager * | GetMainLayout () |
| Retrieves the main LayoutManager associated with this Layout Manager. More... | |
| LayoutManager * | GetSharedSizeGroupBoundary () |
| Retrieves the next Shared Size Group Boundary associated with this Layout Manager. More... | |
| LayoutManager * | GetParentLayout () const |
| Retrieves the parent LayoutManager associated with this Layout Manager. More... | |
| void | SetParentLayout (LayoutManager *) |
| Sets the parent LayoutManager for this Layout Manager. More... | |
| LayoutControl * | GetParentControl () const |
| Retrieves the parent LayoutControl associated with this Layout Manager. More... | |
| void | SetParentControl (LayoutControl *) |
| Sets the parent LayoutControl for this Layout Manager. More... | |
| int | GetMargin () const |
| Retrieves the margin for the LayoutManager, but only if all 4 margins are the same. Otherwise, -1 is returned. More... | |
| void | SetMargin (int margin) |
| Sets the 4 margins for the LayoutManager to the same value. More... | |
| void | SetLayoutMargins (int left, int top, int right, int bottom) |
| Sets the 4 margins for the LayoutManager. More... | |
| void | SetLayoutMargins (const Margins &margins) |
| Sets the margins for the LayoutManager. More... | |
| void | GetLayoutMargins (int *left, int *top, int *right, int *bottom) const |
| Gets the 4 margins for the LayoutManager. More... | |
| Margins | GetLayoutMargins () const |
| Gets the 4 margins for the LayoutManager. More... | |
| BRect | GetContentsRect () const |
| Gets the bounding rectangle for the contents in the LayoutManager. More... | |
| bool | SetAlignment (LayoutControl *ctl, LayoutAlignment alignment) |
| Sets the alignment for a child control. More... | |
| bool | SetAlignment (LayoutManager *layout, LayoutAlignment alignment) |
| Sets the alignment for a child layout. More... | |
| bool | Activate () |
| Invalidates the layout item then updates it. More... | |
| void | Update () |
| Invalidates the layout item without updating it. More... | |
| void | RemoveControl (LayoutControl *ctl) |
| Removes a child control. More... | |
| void | RemoveItem (LayoutItem *item) |
| Removes a child item. More... | |
| int | GetTotalHeightForWidth (int width) const |
| Retrieves the required height for a given width. More... | |
| BSize | GetTotalMinimumSize () const |
| Retrieves the total minimum size for the layout. More... | |
| BSize | GetTotalMaximumSize () const |
| Retrieves the total maximum size for the layout. More... | |
| BSize | GetTotalDesiredSize () const |
| Retrieves the total desired size for the layout. More... | |
| void | SetEnabled (bool) |
| Sets whether the layout is enabled. More... | |
| bool | IsEnabled () const |
| Determines whether the layout is enabled. More... | |
| void | SetTopLevel (bool) |
| Sets whether the layout is top-level. More... | |
| bool | IsTopLevel () const |
| Determines whether the layout is top-level. More... | |
| void | SetSharedSizeGroupBoundary (bool) |
| Sets whether the layout is a Shared Group Boundary. More... | |
| bool | IsSharedSizeGroupBoundary () const |
| Determines whether the layout is a Shared Group Boundary. More... | |
| virtual bool | IsEmpty () const override |
| Returns whether the layout item is empty. More... | |
| virtual bool | IsVisible () const override |
| Returns whether the layout item is visible. More... | |
| virtual BRect | GetGeometry () const override |
| Retrieves the geometry for this layout item. More... | |
| virtual LayoutManager * | GetLayout () override |
| If the concrete item is a LayoutManager, it can be retrieved using GetLayout(). More... | |
| Public Member Functions inherited from LayoutItem | |
| virtual BSize | GetSize () const |
| Returns the geometry's size for this layout item. More... | |
| virtual LayoutControl * | GetControl () |
| If the concrete item is a LayoutControl, it can be retrieved using GetControl(). More... | |
| LayoutAlignment | GetAlignment () const |
| Returns the alignment within the layout for this layout item. More... | |
| void | SetAlignment (LayoutAlignment alignment) |
| Sets the alignment within the layout for this layout item. More... | |
| Public Member Functions inherited from RefCounted< IRefCounted > | |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
| UInt32 | AddRef () const |
| UInt32 | Release () const |
| RefCounted () | |
| RefCounted (RefCounted const &rhs) | |
| RefCounted & | operator= (RefCounted const &rhs) |
| UInt32 | GetRefCount () const |
| Protected Member Functions inherited from RefCounted< IRefCounted > | |
| virtual | ~RefCounted () |
| Protected Member Functions inherited from IRefCounted | |
| virtual | ~IRefCounted () |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
Detailed Description
VStackLayout is a vertical StackLayout.
Member Function Documentation
|
static |
Creates a Vertical StackLayout Layout Manager.
- Parameters
-
[in] parent The parent LayoutControl
- Returns
- A pointer to the new StackLayout object.
The documentation for this class was generated from the following file: