BLayoutBuilder::Base subclass for building BCardLayouts. More...

Inherits BLayoutBuilder::Base< ParentBuilder >.

Public Types
typedef Cards< ThisBuilder >	CardBuilder

typedef Grid< ThisBuilder >	GridBuilder

typedef Group< ThisBuilder >	GroupBuilder

typedef Split< ThisBuilder >	SplitBuilder

typedef Cards< ParentBuilder >	ThisBuilder

Public Member Functions
Constructors
	Cards ()
	Creates a builder for BCardLayout.

	Cards (BWindow *window)
	Creates a new builder for BCardLayout, and attaches it to a window.

	Cards (BView *view)
	Creates a new builder for BCardLayout, and attaches it to a view.

	Cards (BCardLayout *layout)
	Creates a builder targeting an existing BCardLayout.

	Cards (BCardView *view)
	Creates a builder targeting an existing BCardView.

Accessors
BCardLayout *	Layout () const

BView *	View () const

ThisBuilder &	GetLayout (BCardLayout **_layout)

ThisBuilder &	GetView (BView **_view)

	operator BCardLayout * ()
	Cast this builder into the layout object it represents.

Adding BViews and BLayoutItems
ThisBuilder &	Add (BView *view)
	Add a view to the underlying BCardLayout.

ThisBuilder &	Add (BLayoutItem *item)
	Add a item to the underlying BCardLayout.

Adding BLayouts and their BView Pairs
A set of methods that add a BLayout or BView subclass and return a BLayoutBuilder::Base subclass representing the newly added object. These methods push a new builder on top of the stack, you will not be using `this` builder again until you call End().
GroupBuilder	AddGroup (orientation orientation, float spacing=B_USE_DEFAULT_SPACING)

GroupBuilder	AddGroup (BGroupView *groupView)

GroupBuilder	AddGroup (BGroupLayout *groupLayout)

GridBuilder	AddGrid (float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING)

GridBuilder	AddGrid (BGridLayout *gridLayout)

GridBuilder	AddGrid (BGridView *gridView)

SplitBuilder	AddSplit (orientation orientation, float spacing=B_USE_DEFAULT_SPACING)

SplitBuilder	AddSplit (BSplitView *splitView)

CardBuilder	AddCards ()

CardBuilder	AddCards (BCardLayout *cardLayout)

CardBuilder	AddCards (BCardView *cardView)

Explicit Sizes and Alignment
ThisBuilder &	SetExplicitMinSize (BSize size)

ThisBuilder &	SetExplicitMaxSize (BSize size)

ThisBuilder &	SetExplicitPreferredSize (BSize size)

ThisBuilder &	SetExplicitAlignment (BAlignment alignment)

Visible Item
ThisBuilder &	SetVisibleItem (int32 index)
	Set the current visible item to the item at index.

Public Member Functions inherited from BLayoutBuilder::Base< ParentBuilder >
ParentBuilder &	End ()
	Returns this builder's parent.

void	SetParent (ParentBuilder *parent)
	Internal method for use by BLayoutBuilder::Base subclasses, this is essential to the builder stack semantics.

Detailed Description

template<typename ParentBuilder>
class BLayoutBuilder::Cards< ParentBuilder >

BLayoutBuilder::Base subclass for building BCardLayouts.

Since: Haiku R1

The BCardLayout class is a simple BLayout subclass that arranges the items as a stack of cards with only one card being on top and visible to the user.

For a detailed view on the properties, see the class description.

Member Typedef Documentation

◆ CardBuilder

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::CardBuilder

Shorthand for builders returned by this builder's AddCards() methods.

Since: Haiku R1

◆ GridBuilder

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::GridBuilder

Shorthand for builders returned by this builder's AddGrid() methods.

Since: Haiku R1

◆ GroupBuilder

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::GroupBuilder

Shorthand for builders returned by this builder's AddGroup() methods.

Since: Haiku R1

◆ SplitBuilder

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::SplitBuilder

Shorthand for builders returned by this builder's AddSplit() methods.

Since: Haiku R1

◆ ThisBuilder

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::ThisBuilder

Shorthand representing the type of this.

Since: Haiku R1

Constructor & Destructor Documentation

◆ Cards() [1/5]

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::Cards

inline

Creates a builder for BCardLayout.

Since: Haiku R1

◆ Cards() [2/5]

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::Cards ( BWindow * window )

inline

Creates a new builder for BCardLayout, and attaches it to a window.

Since: Haiku R1

References B_PANEL_BACKGROUND_COLOR, BLayout::Owner(), BWindow::SetLayout(), and BView::SetViewColor().

◆ Cards() [3/5]

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::Cards ( BView * view )

inline

Creates a new builder for BCardLayout, and attaches it to a view.

Since: Haiku R1

References B_PANEL_BACKGROUND_COLOR, BView::SetLayout(), and BView::SetViewColor().

◆ Cards() [4/5]

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::Cards ( BCardLayout * layout )

inline

Creates a builder targeting an existing BCardLayout.

Since: Haiku R1

◆ Cards() [5/5]

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::Cards ( BCardView * view )

inline

Creates a builder targeting an existing BCardView.

Since: Haiku R1

Member Function Documentation

◆ Add() [1/2]

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::Add ( BLayoutItem * item )

inline

Add a item to the underlying BCardLayout.

The layout item will be added as a card at the end of the stack.

Parameters

item	The BLayoutItem to be added. The underlying BCardLayout will take ownership of the object.

Since: Haiku R1

◆ Add() [2/2]

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::Add ( BView * view )

inline

Add a view to the underlying BCardLayout.

The layout item will be added as a card at the end of the stack.

Parameters

view	The BView to be added. The underlying BCardLayout will take ownership of the object.

Since: Haiku R1

◆ AddCards() [1/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::CardBuilder BLayoutBuilder::Cards< ParentBuilder >::AddCards

inline

BLayoutBuilder::Group<ParentBuilder>::AddCards( float weight)

Returns: A CardBuilder representing the new BCardLayout.

Since: Haiku R1

References BLayoutBuilder::Base< ParentBuilder >::SetParent(), and BLayoutBuilder::Cards< ParentBuilder >::View().

◆ AddCards() [2/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::CardBuilder BLayoutBuilder::Cards< ParentBuilder >::AddCards ( BCardLayout * cardLayout )

inline

BLayoutBuilder::Group<ParentBuilder>::AddCards( BCardLayout* cardLayout, float weight)

Parameters

cardLayout The existing layout that will be added to the underlying BSplitView.

Returns: A CardBuilder representing the cardLayout.

Since: Haiku R1

References BLayoutBuilder::Base< ParentBuilder >::SetParent(), and BLayoutBuilder::Cards< ParentBuilder >::View().

◆ AddCards() [3/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::CardBuilder BLayoutBuilder::Cards< ParentBuilder >::AddCards ( BCardView * cardView )

inline

BLayoutBuilder::Group<ParentBuilder>::AddCards( BCardView* cardView, float weight)

Parameters

cardView The existing view that will be added to the underlying BSplitView.

Returns: A CardBuilder representing the layout of t he cardView.

Since: Haiku R1

References BLayoutBuilder::Base< ParentBuilder >::SetParent(), and BLayoutBuilder::Cards< ParentBuilder >::View().

◆ AddGrid() [1/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GridBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGrid ( BGridLayout * gridLayout )

inline

BLayoutBuilder::Group<ParentBuilder>::AddGrid( BGridLayout* gridLayout, float weight)

Parameters

gridLayout The BGridLayout to be added and used to construct the returned GridBuilder.

Returns: A GridBuilder representing gridLayout.

Since: Haiku R1

References BLayoutBuilder::Grid< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddGrid() [2/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GridBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGrid ( BGridView * gridView )

inline

BLayoutBuilder::Group<ParentBuilder>::AddGrid( BGridView* gridView, float weight)

Parameters

gridView The BGridView to be added and used to construct the returned GridBuilder.

Returns: A GridBuilder representing the layout of the gridView.

Since: Haiku R1

References BLayoutBuilder::Grid< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddGrid() [3/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GridBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGrid	(	float	horizontalSpacing = `B_USE_DEFAULT_SPACING`,
		float	verticalSpacing = `B_USE_DEFAULT_SPACING`
	)

inline

BLayoutBuilder::Group<ParentBuilder>::AddGrid( float horizontalSpacing, float verticalSpacing, float weight)

Shorthand for builders returned by this builder's AddGrid() methods.

Since: Haiku R1 BLayoutBuilder::Group<ParentBuilder>::AddGrid( float horizontalSpacing, float verticalSpacing, float weight)

Parameters

horizontalSpacing	The horizontal spacing for the new BGridLayout.
verticalSpacing	The vertical spacing for the new BGridLayout.

Returns: A GridBuilder representing the newly created BGridLayout.

Since: Haiku R1

References BLayoutBuilder::Grid< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddGroup() [1/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GroupBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGroup ( BGroupLayout * groupLayout )

inline

BLayoutBuilder::Group<ParentBuilder>::AddGroup(BGroupView* groupView, float weight)

Parameters

groupLayout The BGroupLayout to be added.

Returns: A GroupBuilder representing the groupLayout.

Since: Haiku R1

References BLayoutBuilder::Group< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddGroup() [2/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GroupBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGroup ( BGroupView * groupView )

inline

BLayoutBuilder::Group<ParentBuilder>::AddGroup( BGroupLayout* groupLayout, float weight)

Parameters

groupView The BGroupView to be added.

Returns: A GroupBuilder representing the layout of the groupView.

Since: Haiku R1

References BLayoutBuilder::Group< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddGroup() [3/3]

template<typename ParentBuilder >

Cards< ParentBuilder >::GroupBuilder BLayoutBuilder::Cards< ParentBuilder >::AddGroup	(	orientation	orientation,
		float	spacing = `B_USE_DEFAULT_SPACING`
	)

inline

BLayoutBuilder::Group<ParentBuilder>::AddGroup( orientation orientation, float spacing, float weight)

Parameters

orientation	The orientation to use for the new BGroupLayout.
spacing	The spacing to use for the new BGroupLayout.

Returns: A GroupBuilder representing the newly created BGroupLayout.

Since: Haiku R1

References BLayoutBuilder::Group< ParentBuilder >::Layout(), and BLayoutBuilder::Base< ParentBuilder >::SetParent().

◆ AddSplit() [1/2]

template<typename ParentBuilder >

Cards< ParentBuilder >::SplitBuilder BLayoutBuilder::Cards< ParentBuilder >::AddSplit ( BSplitView * splitView )

inline

BLayoutBuilder::Group<ParentBuilder>::AddSplit( BSplitView* splitView, float weight)

Parameters

splitView The BSplitView to be added.

Returns: A SplitBuilder representing the splitView.

Since: Haiku R1

References BLayoutBuilder::Base< ParentBuilder >::SetParent(), and BLayoutBuilder::Split< ParentBuilder >::View().

◆ AddSplit() [2/2]

template<typename ParentBuilder >

Cards< ParentBuilder >::SplitBuilder BLayoutBuilder::Cards< ParentBuilder >::AddSplit	(	orientation	orientation,
		float	spacing = `B_USE_DEFAULT_SPACING`
	)

inline

BLayoutBuilder::Group<ParentBuilder>::AddSplit( orientation orientation, float spacing, float weight)

Parameters

orientation	The orientation of the new BSplitView.
spacing	The spacing of the new BSplitView.

Returns: A SplitBuilder representing the new BSplitView.

Since: Haiku R1

References BLayoutBuilder::Base< ParentBuilder >::SetParent(), and BLayoutBuilder::Split< ParentBuilder >::View().

◆ GetLayout()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::GetLayout ( BCardLayout ** _layout )

inline

Get the layout this builder represents.

Parameters

[out] _layout The layout this builder represents.

Since: Haiku R1

◆ GetView()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::GetView ( BView ** _view )

inline

Get a pointer to the BView this builder's layout is attached to.

Parameters

[out] _view The BView this builder's layout is attached to.

Since: Haiku R1

◆ Layout()

template<typename ParentBuilder >

BCardLayout * BLayoutBuilder::Cards< ParentBuilder >::Layout

inline

Get a pointer to the layout this builder represents.

Since: Haiku R1

◆ operator BCardLayout *()

template<typename ParentBuilder >

BLayoutBuilder::Cards< ParentBuilder >::operator BCardLayout *

inline

Cast this builder into the layout object it represents.

Since: Haiku R1

◆ SetExplicitAlignment()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::SetExplicitAlignment ( BAlignment alignment )

inline

Set the explicit alignment of the underlying layout.

Since: Haiku R1

References BLayoutBuilder::Cards< ParentBuilder >::SetExplicitAlignment().

Referenced by BLayoutBuilder::Cards< ParentBuilder >::SetExplicitAlignment().

◆ SetExplicitMaxSize()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMaxSize ( BSize size )

inline

Set the explicit maximum size of the underlying layout.

Since: Haiku R1

References BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMaxSize().

Referenced by BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMaxSize().

◆ SetExplicitMinSize()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMinSize ( BSize size )

inline

Set the explicit minimum size of the underlying layout.

Since: Haiku R1

References BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMinSize().

Referenced by BLayoutBuilder::Cards< ParentBuilder >::SetExplicitMinSize().

◆ SetExplicitPreferredSize()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::SetExplicitPreferredSize ( BSize size )

inline

Set the explicit preferred size of the underlying layout.

Since: Haiku R1

References BLayoutBuilder::Cards< ParentBuilder >::SetExplicitPreferredSize().

Referenced by BLayoutBuilder::Cards< ParentBuilder >::SetExplicitPreferredSize().

◆ SetVisibleItem()

template<typename ParentBuilder >

Cards< ParentBuilder >::ThisBuilder & BLayoutBuilder::Cards< ParentBuilder >::SetVisibleItem ( int32 index )

inline

Set the current visible item to the item at index.

See also: BCardLayout::SetVisibleItem(int32)

References BLayoutBuilder::Cards< ParentBuilder >::SetVisibleItem().

Referenced by BLayoutBuilder::Cards< ParentBuilder >::SetVisibleItem().

◆ View()

template<typename ParentBuilder >

BView * BLayoutBuilder::Cards< ParentBuilder >::View

inline

Get a pointer to the BView this builder's layout is attached to.

Since: Haiku R1

Referenced by BLayoutBuilder::Cards< ParentBuilder >::AddCards(), BLayoutBuilder::Group< ParentBuilder >::AddCards(), BLayoutBuilder::Split< ParentBuilder >::AddCards(), and BLayoutBuilder::Grid< ParentBuilder >::AddCards().

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CardBuilder

◆ GridBuilder

◆ GroupBuilder

◆ SplitBuilder

◆ ThisBuilder

Constructor & Destructor Documentation

◆ Cards() [1/5]

◆ Cards() [2/5]

◆ Cards() [3/5]

◆ Cards() [4/5]

◆ Cards() [5/5]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ AddCards() [1/3]

◆ AddCards() [2/3]

◆ AddCards() [3/3]

◆ AddGrid() [1/3]

◆ AddGrid() [2/3]

◆ AddGrid() [3/3]

◆ AddGroup() [1/3]

◆ AddGroup() [2/3]

◆ AddGroup() [3/3]

◆ AddSplit() [1/2]

◆ AddSplit() [2/2]

◆ GetLayout()

◆ GetView()

◆ Layout()

◆ operator BCardLayout *()

◆ SetExplicitAlignment()

◆ SetExplicitMaxSize()

◆ SetExplicitMinSize()

◆ SetExplicitPreferredSize()

◆ SetVisibleItem()

◆ View()