BGridLayoutBuilder Class Reference

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

Public Member Functions
	BGridLayoutBuilder (BGridLayout *layout)
	Create a new layout builder that operates on a layout.
	BGridLayoutBuilder (BGridView *view)
	Create a new layout builder that operates on a view.
	BGridLayoutBuilder (float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING)
	Create a new layout builder with a new underlying BGridLayout.
BGridLayoutBuilder &	Add (BLayoutItem *item, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1)
	Add a BLayoutItem to the underlying BGridLayout.
BGridLayoutBuilder &	Add (BView *view, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1)
	Add a view to the underlying BGridLayout.
BGridLayoutBuilder &	GetGridLayout (BGridLayout **_layout)
	Get a reference to the underlying BGridLayout.
BGridLayoutBuilder &	GetView (BView **_view)
	Get a reference to the owning BView.
BGridLayout *	GridLayout () const
	Get a reference to the underlying BGridLayout.
	operator BGridLayout * ()
	Casts the builder to the underlying BGridLayout.
BGridLayoutBuilder &	SetColumnWeight (int32 column, float weight)
	Set the weight for column to weight.
BGridLayoutBuilder &	SetInsets (float left, float top, float right, float bottom)
	Set the insets for the layout.
BGridLayoutBuilder &	SetRowWeight (int32 row, float weight)
	Set the weight of row to weight.
BView *	View () const
	Get a reference to the owning BView.

Detailed Description

Deprecated helper class that helps building a BGridLayout.

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

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

BGridLayoutBuilder() [1/3]

BGridLayoutBuilder::BGridLayoutBuilder	(	float	horizontal = B_USE_DEFAULT_SPACING,
		float	vertical = B_USE_DEFAULT_SPACING
	)

Create a new layout builder with a new underlying BGridLayout.

Parameters

horizontal	Horizontal spacing.
vertical	Vertical Spacing

Since

Haiku R1

BGridLayoutBuilder() [2/3]

BGridLayoutBuilder::BGridLayoutBuilder

(

BGridLayout *

layout

)

Create a new layout builder that operates on a layout.

Parameters

layout

The existing layout you want the builder to alter.

Since

Haiku R1

BGridLayoutBuilder() [3/3]

BGridLayoutBuilder::BGridLayoutBuilder

(

BGridView *

view

)

Create a new layout builder that operates on a view.

Parameters

view	The existing grid view you want the builder to alter.

Since

Haiku R1

Member Function Documentation

Add() [1/2]

BGridLayoutBuilder & BGridLayoutBuilder::Add	(	BLayoutItem *	item,
		int32	column,
		int32	row,
		int32	columnCount = 1,
		int32	rowCount = 1
	)

Add a BLayoutItem to the underlying BGridLayout.

Parameters

item	The BLayoutItem to add.
column	The column number (zero-index) to use.
row	The row number (zero-index) to use.
columnCount	The number of columns to span over.
rowCount	The number of rows to span over.

Returns

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

Since

Haiku R1

Add() [2/2]

BGridLayoutBuilder & BGridLayoutBuilder::Add	(	BView *	view,
		int32	column,
		int32	row,
		int32	columnCount = 1,
		int32	rowCount = 1
	)

Add a view to the underlying BGridLayout.

Parameters

view	The BView to add.
column	The column number (zero-based) to use.
row	The row number (zero-based) to use.
columnCount	The number of columns to span over.
rowCount	The number of rows to span over.

Returns

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

Since

Haiku R1

GetGridLayout()

BGridLayoutBuilder & BGridLayoutBuilder::GetGridLayout

(

BGridLayout **

_layout

)

Get a reference to the underlying BGridLayout.

Parameters

[out]

_layout

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

Returns

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

Since

Haiku R1

GetView()

BGridLayoutBuilder & BGridLayoutBuilder::GetView

(

BView **

_view

)

Get a reference to the owning BView.

Parameters

[out]

_view

The variable to store the borrowed pointer to the owning BView.

Returns

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

Since

Haiku R1

GridLayout()

BGridLayout * BGridLayoutBuilder::GridLayout

(

)

const

Get a reference to the underlying BGridLayout.

Returns

A borrowed pointer to the current underlaying layout.

Since

Haiku R1

operator BGridLayout *()

BGridLayoutBuilder::operator BGridLayout *

(

)

Casts the builder to the underlying BGridLayout.

Convenience method for the GridLayout() method.

Since

Haiku R1

SetColumnWeight()

BGridLayoutBuilder & BGridLayoutBuilder::SetColumnWeight	(	int32	column,
		float	weight
	)

Set the weight for column to weight.

Parameters

column	The column to set.
weight	The weight to set.

Returns

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

Since

Haiku R1

SetInsets()

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

Set the insets for the layout.

Parameters

left	The left inset as a float.
top	The top inset as a float.
right	The right inset as a float.
bottom	The bottom inset as a float.

Returns

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

Since

Haiku R1

SetRowWeight()

BGridLayoutBuilder & BGridLayoutBuilder::SetRowWeight	(	int32	row,
		float	weight
	)

Set the weight of row to weight.

Parameters

row	The row number.
weight	The weight to set.

Returns

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

Since

Haiku R1

View()

BView * BGridLayoutBuilder::View

(

)

const

Get a reference to the owning BView.

Returns the same BView* as BLayout::Owner(), this method is inherited from BLayoutItem.

Returns

A borrowed pointer to the owning BView.

Since

Haiku R1