BSplitLayoutBuilder Class Reference

Deprecated helper class that helps building a BSplitView. More...

Public Member Functions
	BSplitLayoutBuilder (BSplitView *view)
	Create a new layout builder that operates on an existing view.
	BSplitLayoutBuilder (orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING)
	Create a new layout builder with an underlying BSplitView.
BSplitLayoutBuilder &	Add (BLayoutItem *item)
	Add a BLayoutItem to the underlying BSplitView.
BSplitLayoutBuilder &	Add (BLayoutItem *item, float weight)
	Add a BLayoutItem to the underlying BSplitView.
BSplitLayoutBuilder &	Add (BView *view)
	Add a view to the underlying BSplitView.
BSplitLayoutBuilder &	Add (BView *view, float weight)
	Add a view to the underlying BSplitView.
BSplitLayoutBuilder &	GetSplitView (BSplitView **view)
	Get a reference to the underlying BSplitView.
	operator BSplitView * ()
	Cast the builder to the underlying BSplitView.
BSplitLayoutBuilder &	SetCollapsible (bool collapsible)
	Set the collapsability of the most recently added item.
BSplitLayoutBuilder &	SetInsets (float left, float top, float right, float bottom)
	Set the insets of the underlying BSplitView.
BSplitView *	SplitView () const
	Get a reference to the underlying BSplitView.

Detailed Description

Deprecated helper class that helps building a BSplitView.

The modern builder can be found in BLayoutBuilder::Split<>.

Warning

This class is deprecated and should not be used in new projects. It may be removed in newer releases.

Since

Haiku R1

Constructor & Destructor Documentation

BSplitLayoutBuilder() [1/2]

BSplitLayoutBuilder::BSplitLayoutBuilder	(	orientation	orientation = B_HORIZONTAL,
		float	spacing = B_USE_DEFAULT_SPACING
	)

Create a new layout builder with an underlying BSplitView.

Parameters

orientation	The orientation of the split view.
spacing	The spacing of items within the split view.

Since

Haiku R1

BSplitLayoutBuilder() [2/2]

BSplitLayoutBuilder::BSplitLayoutBuilder

(

BSplitView *

view

)

Create a new layout builder that operates on an existing view.

Parameters

view	The existing view you want the builder to alter.

Since

Haiku R1

Member Function Documentation

Add() [1/4]

BSplitLayoutBuilder & BSplitLayoutBuilder::Add

(

BLayoutItem *

item

)

Add a BLayoutItem to the underlying BSplitView.

Parameters

item	The BLayoutItem to add.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

Add() [2/4]

BSplitLayoutBuilder & BSplitLayoutBuilder::Add	(	BLayoutItem *	item,
		float	weight
	)

Add a BLayoutItem to the underlying BSplitView.

Parameters

item	The BLayoutItem to add.
weight	The weight of the item.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

Add() [3/4]

BSplitLayoutBuilder & BSplitLayoutBuilder::Add

(

BView *

view

)

Add a view to the underlying BSplitView.

Parameters

view	The BView to add.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

Add() [4/4]

BSplitLayoutBuilder & BSplitLayoutBuilder::Add	(	BView *	view,
		float	weight
	)

Add a view to the underlying BSplitView.

Parameters

view	The BView to add.
weight	The weight of the item.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

GetSplitView()

BSplitLayoutBuilder & BSplitLayoutBuilder::GetSplitView

(

BSplitView **

view

)

Get a reference to the underlying BSplitView.

Parameters

[out]

view

The variable to store a borrowed pointer to the underlying view.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

operator BSplitView *()

BSplitLayoutBuilder::operator BSplitView *

(

)

Cast the builder to the underlying BSplitView.

Convenience method for the SplitView() method.

Since

Haiku R1

SetCollapsible()

BSplitLayoutBuilder & BSplitLayoutBuilder::SetCollapsible

(

bool

collapsible

)

Set the collapsability of the most recently added item.

Parameters

collapsible

true if the item is collapsible, false otherwise.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

SetInsets()

BSplitLayoutBuilder & BSplitLayoutBuilder::SetInsets	(	float	left,
		float	top,
		float	right,
		float	bottom
	)

Set the insets of the underlying BSplitView.

Parameters

left	The left inset.
top	The top inset.
right	The right inset.
bottom	The bottom inset.

Returns

The method returns a self reference, so that calls to the builder may be chained.

Since

Haiku R1

SplitView()

BSplitView * BSplitLayoutBuilder::SplitView

(

)

const

Get a reference to the underlying BSplitView.

Returns

A borrowed pointer to the current underlaying view.

Since

Haiku R1