omgui::TableLayoutInfo Class Reference

#include <omgui/tablelayout.h>

List of all members.

---

Detailed Description

Layout flags for the TableLayout layout manager. The default flags specify that the widget will be centered both vertically and horizontally within its alloted space and will not be expanded in either direction.

Todo:

Add a reference, or "See also" link, pointing to the enum documentation for layout flags

Public Member Functions
TableLayoutInfo &	add_flags (int flags)
TableLayoutInfo &	anchor (int column, int row)
TableLayoutInfo &	anchor (int left, int top, int right, int bottom)
TableLayoutInfo &	bottom_anchor (int row)
TableLayoutInfo &	flags (int flags)
	Specify flags controlling the placement of objects within the layout.
const omgui::common::tablelayoutdetails::LayoutData &	get_data () const
int	get_flags () const
TableLayoutInfo &	left_anchor (int column)
TableLayoutInfo &	operator= (const TableLayoutInfo &other)
TableLayoutInfo &	padding (int left, int top, int right, int bottom)
TableLayoutInfo &	padding (int pad)
TableLayoutInfo &	padding_bottom (int pad)
TableLayoutInfo &	padding_left (int pad)
TableLayoutInfo &	padding_right (int pad)
TableLayoutInfo &	padding_top (int pad)
TableLayoutInfo &	remove_flags (int flags)
TableLayoutInfo &	right_anchor (int column)
	TableLayoutInfo (const TableLayoutInfo &other)
	TableLayoutInfo ()
TableLayoutInfo &	top_anchor (int row)
	~TableLayoutInfo ()
Private Attributes
omgui::common::tablelayoutdetails::LayoutData *	m_data

---

Constructor & Destructor Documentation

omgui::TableLayoutInfo::TableLayoutInfo

(

)

omgui::TableLayoutInfo::~TableLayoutInfo

(

)

omgui::TableLayoutInfo::TableLayoutInfo

(

const TableLayoutInfo &

other

)

---

Member Function Documentation

TableLayoutInfo & omgui::TableLayoutInfo::add_flags

(

int

flags

)

Adds the given flags to the current flags.

TableLayoutInfo & omgui::TableLayoutInfo::anchor	(	int	column,
		int	row
	)

Equivilant to anchor(column, row, column, row)

TableLayoutInfo & omgui::TableLayoutInfo::anchor	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Specifies the placement of the widget within the layout. Placing a widget within the TableLayout is done by specifying "anchor values" for each side of the widget. The anchor value for a given side of the widget specifies the index of the group that side will anchor to. For example, anchoring the left side of the widget to column 1 means that the widget's left side will anchor to the left side of column 1. An anchor value of 2 for the widget's right side means that the right side of the widget will anchor to the right side of column 2. In this case, the widget can be said to be "spanning" from column 1 to column 2. If both the right and left anchor values are the same, the widget is occupying only that column, or it is not spanning any columns.

Parameters:

	left	Specifies which column the left edge of the widget should anchor to
	top	Specifies which row the top edge of the widget should anchor to
	right	Specifies which column the right edge of the widget should anchor to
	bottom	Specifies which row the bottom edge of the widget should anchor to

Note:

If you specify a combination of anchoring values using this function or any combiation of the left_anchor, right_anchor, top_anchor, and bottom_anchor functions, the right and bottom anchoring values must be greater than or equal to the left and top anchoring values. Any combination where this condition does not hold results in undefined behavior.

TableLayoutInfo & omgui::TableLayoutInfo::bottom_anchor

(

int

row

)

Specifies the bottom anchoring value

TableLayoutInfo & omgui::TableLayoutInfo::flags

(

int

flags

)

Specify flags controlling the placement of objects within the layout.

Parameters:

flags

A combination of omgui::flags::LAYOUT_FLAGS

const common::tablelayoutdetails::LayoutData & omgui::TableLayoutInfo::get_data

(

)

const

int omgui::TableLayoutInfo::get_flags

(

)

const

Returns:

The current combination of layout flags

TableLayoutInfo & omgui::TableLayoutInfo::left_anchor

(

int

column

)

Specifies the left anchoring value

TableLayoutInfo & omgui::TableLayoutInfo::operator=

(

const TableLayoutInfo &

other

)

TableLayoutInfo & omgui::TableLayoutInfo::padding	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

TableLayoutInfo & omgui::TableLayoutInfo::padding

(

int

pad

)

TableLayoutInfo & omgui::TableLayoutInfo::padding_bottom

(

int

pad

)

TableLayoutInfo & omgui::TableLayoutInfo::padding_left

(

int

pad

)

TableLayoutInfo & omgui::TableLayoutInfo::padding_right

(

int

pad

)

TableLayoutInfo & omgui::TableLayoutInfo::padding_top

(

int

pad

)

TableLayoutInfo & omgui::TableLayoutInfo::remove_flags

(

int

flags

)

Removes the given flags from the current flags if they exist in the current flags.

TableLayoutInfo & omgui::TableLayoutInfo::right_anchor

(

int

column

)

Specifies the right anchoring value

TableLayoutInfo & omgui::TableLayoutInfo::top_anchor

(

int

row

)

Specifies the top anchoring value

---

Member Data Documentation

omgui::common::tablelayoutdetails::LayoutData* omgui::TableLayoutInfo::m_data [private]