omgui::TableLayout Class Reference

#include <omgui/tablelayout.h>

Detailed Description

TableLayout is a Panel which organizes child widgets in a tabular fashion. Children are organized within the TableLayout based on the TableLayoutInfo specified for each child.

A TableLayout's minimum size is defined to be the largest of these two values:

The minimum size (if any) specified by TableLayout::set_min_size or by the initializer parameters
The calculated minimum layout size

A TableLayout's maximum size is specified by TableLayout::set_max_size or by the initializer parameters. There is no such thing as a maximum layout size, so unless a maximum size is specified through the previously mentioned methods, there will be no maximum size.


Public Types
typedef omgui::api::TableLayout	api_type
typedef omgui::event_traits < Widget >	event_traits
typedef TableLayoutInitializer	Initializer
Public Member Functions
void	add_ref ()
	Increments the reference count for this Widget.
omgui::Connection	connect (event_id event, SlotBase *slot, int priority=SIGNAL_PRIORITY_NORMAL)
	Connects an event using this Widget's object_id. Calls omgui::Manager::connect with supplied arguments.
void	destroy ()
	Destroys this widget freeing all resources.
void	disable ()
void	enable (bool e)
	Enables or disables the widget. Disabled widgets cannot recieve user input.
void *	get_handle () const
object_id	get_id () const
api_type *	get_impl () const
omgui::Size	get_max_size () const
	Returns the maximum size of the Widget. A value of 0 for width or height indicates that there is no maximum size in that direction.
omgui::Size	get_min_size () const
	Returns the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction.
omgui::Size	get_natural_size () const
Pointer< Panel >	get_parent () const
Pointer< Window >	get_parent_window () const
omgui::Point	get_position () const
omgui::Rect	get_rect () const
omgui::Size	get_size () const
void	hide ()
void	invalidate_cached_child_values ()
	Invalidates any cached child widget values which include minimum, maximum and natural sizes. These values can be cached by layout manager implementations for improved performance but must be invalidated when the value in the child widget changes so that the cached value can be updated.
bool	is_enabled () const
	Determines whether or not the widget is enabled. If any of a widget's parents are disabled, the widget is considered disabled.
bool	is_hidden () const
	Returns whether or not this Widget has been hidden.
bool	is_orphaned () const
bool	is_shown () const
	Returns whether or not the Widget is visible on the screen. If the Widget and all of its parent Widgets are not hidden then the Widget is shown.
void	release ()
	Decrements the reference count for this Widget. Once the count reaches 0 the Widget will be deleted.
void	remove_child (Widget *child)
TableLayout &	set_bottom_margin (int margin)
TableLayout &	set_column_gap (int gap)
TableLayout &	set_column_weight (int column, float weight)
TableLayout &	set_gap (int gap)
TableLayout &	set_left_margin (int margin)
TableLayout &	set_margins (int left, int top, int right, int bottom)
TableLayout &	set_margins (int margin)
void	set_max_size (const omgui::Size &s)
	Sets the maximum size of the widget. A value of 0 for width or height indicates that there is no maximum size in that direction.
void	set_min_size (const omgui::Size &s)
	Sets the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction. If the Widget's current size is less than the newly specified minimum size, the object will be resized so that its size is equal to the newly specified minimum size.
void	set_natural_size (const omgui::Size &s)
void	set_position (const omgui::Point &p)
	Sets the position of a widget. If the widget is a TopLevel widget, the position value is in screen coordinates, otherwise it is client coordinates.
void	set_rect (const omgui::Rect &r)
	Sets both the position and the size of the widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.
TableLayout &	set_right_margin (int margin)
TableLayout &	set_row_gap (int gap)
TableLayout &	set_row_weight (int row, float weight)
void	set_size (const omgui::Size &s)
	Sets the absolute size of this widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.
TableLayout &	set_top_margin (int margin)
void	set_widget_layout_info (Pointer< Widget > widget, const TableLayoutInfo &info)
	Specifies layout information for the given widget.
void	show (bool show=true, bool focus=false)
	Shows or hides a widget.
void	update_layout ()
	Refreshes the layout by recalculating widget sizes and positions. Call after the visibility, layout information, mininum or maximum size of a child widget has changed, or if child widgets have been removed or added.
Static Public Member Functions
static Pointer< TableLayout >	create (const Initializer &initializer, object_id id=OBJECT_ID_ANY)
Protected Member Functions
void	initialize (const Initializer &initializer)
	Constructs the native widget using the given initialization data.
	TableLayout (object_id id, api_type *impl)
	TableLayout (object_id id)
Private Attributes
api_type *	m_impl

Member Typedef Documentation

typedef omgui::api::TableLayout omgui::TableLayout::api_type

Reimplemented from omgui::Panel.

typedef omgui::event_traits<Widget> omgui::Widget::event_traits [inherited]

Reimplemented in omgui::Button, omgui::Notebook, omgui::TextWidget, and omgui::Window.

typedef TableLayoutInitializer omgui::TableLayout::Initializer

Constructor & Destructor Documentation

omgui::TableLayout::TableLayout ( object_id id ) [protected]

omgui::TableLayout::TableLayout	(	object_id	id,
		api_type *	impl
	)			`[protected]`

Member Function Documentation

void Widget::add_ref ( ) [virtual, inherited]

Increments the reference count for this Widget.

Implements omgui::RefCountable.

omgui::Connection Widget::connect	(	event_id	event,
		SlotBase *	slot,
		int	priority = `SIGNAL_PRIORITY_NORMAL`
	)			`[inherited]`

Connects an event using this Widget's object_id. Calls omgui::Manager::connect with supplied arguments.

Pointer< TableLayout > omgui::TableLayout::create	(	const Initializer &	initializer,
		object_id	id = `OBJECT_ID_ANY`
	)			`[static]`

Creates a TableLayout with the given object_id. An id of OBJECT_ID_ANY means that the widget will be assigned an autmoatically generated unique id.

void Widget::destroy ( ) [inherited]

Destroys this widget freeing all resources.

void Widget::disable ( ) [inherited]

void Widget::enable ( bool e ) [inherited]

Enables or disables the widget. Disabled widgets cannot recieve user input.

void * Widget::get_handle ( ) const [inherited]

Returns:: A native handle for the widget. This value is returned as a void*, and how you use this value is dependant on the port you are working with. For win32, simply casting the return value to a HWND is sufficient.

Todo:: Casting a pointer type to a type that isn't a pointer may not work under all circumstances

object_id omgui::Object::get_id ( ) const [inherited]

Returns:: This object's unique identifier

Reimplemented in omgui::MenuItem.

TableLayout::api_type * omgui::TableLayout::get_impl ( ) const

Reimplemented from omgui::Panel.

omgui::Size Widget::get_max_size ( ) const [inherited]

Returns the maximum size of the Widget. A value of 0 for width or height indicates that there is no maximum size in that direction.

Returns:: Maximum size of the widget.

omgui::Size Widget::get_min_size ( ) const [inherited]

Returns the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction.

Returns:: Minimum size of the widget.

omgui::Size Widget::get_natural_size ( ) const [inherited]

Returns:: Natural size of the widget. The natural size is used by layout managers to determine how large to make widgets which are not expanded. Unless a natural size is explicitly specified by a call to set_natural_size or through an inintializer, this value is a calculated value and can vary from widget to widget and from port to port.

Pointer< Panel > Widget::get_parent ( ) const [inherited]

This function returns the parent Panel of this Widget. In the case where this Widget is the Content Panel of a Window, this function will return an empty pointer.

Returns:: The parent of this widget

Pointer< Window > Widget::get_parent_window ( ) const [inherited]

This function returns the Window which this Widget is either directly or indirectly a child of. In the case where this Widget is a Window, this function returns the owner Window, or an empty pointer if the Window is unowned.

Returns:: The Window which contains this widget.

omgui::Point Widget::get_position ( ) const [inherited]

Returns:: Position of the widget. If the widget is a TLW TLW, the position is in screen coordinates. Otherwise, the position is in client coordinates.

omgui::Rect Widget::get_rect ( ) const [inherited]

Returns:: Position and Size of this widget as a rectangle.

omgui::Size Widget::get_size ( ) const [inherited]

Returns:: Absolute size of the widget

void Widget::hide ( ) [inherited]

void omgui::TableLayout::initialize ( const Initializer & initializer ) [protected]

Constructs the native widget using the given initialization data.

void omgui::Panel::invalidate_cached_child_values ( ) [inherited]

Invalidates any cached child widget values which include minimum, maximum and natural sizes. These values can be cached by layout manager implementations for improved performance but must be invalidated when the value in the child widget changes so that the cached value can be updated.

bool Widget::is_enabled ( ) const [inherited]

Determines whether or not the widget is enabled. If any of a widget's parents are disabled, the widget is considered disabled.

Returns:: Whether or not the widget is enabled

bool Widget::is_hidden ( ) const [inherited]

Returns whether or not this Widget has been hidden.

If show(true) has been called the Widget is considered not to be hidden. If show(false) or hide() have been called the Widget is considered hidden. A Widget is also considered hidden if it was created without specifying show in its initializer. The hidden state of the parent Widget has no effect on the hidden state of this Widget.

Note:: The return value is not equivilant to !is_shown().

Todo:: Implement for gtk2 and cocoa

bool omgui::Panel::is_orphaned ( ) const [inherited]

Returns:: Whether or not this panel is orphaned.

bool Widget::is_shown ( ) const [inherited]

Returns whether or not the Widget is visible on the screen. If the Widget and all of its parent Widgets are not hidden then the Widget is shown.

Note:: The return value is not equivilant to !is_hidden().

Todo:: Verify the newly documented behavior for this function on gtk2 and cocoa ports

void Widget::release ( ) [virtual, inherited]

Decrements the reference count for this Widget. Once the count reaches 0 the Widget will be deleted.

Implements omgui::RefCountable.

void omgui::Panel::remove_child ( Widget * child ) [inherited]

Removes a child window from this panel. This function will automatically be called by the library when needed. You should never have to call it yourself.

TableLayout & omgui::TableLayout::set_bottom_margin ( int margin )

Sets the bottom margin

TableLayout & omgui::TableLayout::set_column_gap ( int gap )

Specifies the amount of gap inbetween columns

TableLayout & omgui::TableLayout::set_column_weight	(	int	column,
		float	weight
	)

Returns:: The layout information for the given widget.

Precondition:: Widget must be a child of this TableLayout.

Sets the weight value for a given column

TableLayout & omgui::TableLayout::set_gap ( int gap )

Specifies the amount of gap inbetween rows and columns

TableLayout & omgui::TableLayout::set_left_margin ( int margin )

Sets the left margin

TableLayout & omgui::TableLayout::set_margins	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Sets the margins for all sides

TableLayout & omgui::TableLayout::set_margins ( int margin )

Sets the margins for all sides

void Widget::set_max_size ( const omgui::Size & s ) [inherited]

Sets the maximum size of the widget. A value of 0 for width or height indicates that there is no maximum size in that direction.

If the Widget's current size is greater than the newly specified maximum size, the object will be resized so that its size is equal to the newly specified maximum size.

void Widget::set_min_size ( const omgui::Size & s ) [inherited]

Sets the minimum size of the Widget. A value of 0 for width or height indicates that there is no minimum size in that direction. If the Widget's current size is less than the newly specified minimum size, the object will be resized so that its size is equal to the newly specified minimum size.

If a child of this Widget has a minimum size larger than the minimum size of this Widget, the minimum size of this Widget will be effectively equal to the minimum size of that child Widget. This has an important implication for Windows and their content panels. If a Window has a minimum size of X, and a Panel A with minimum size Y > X is specified as the Window's content panel, the minimum content size of the Window is effectively Y. If a new Panel B with minimum size Z < Y is specified as the Window's content panel, the effective minimum content size for the window will be Y.

If an Widget is specified with a minimum size that is larger than the Widgets maximum size, or if a maximum size is later specified which is smaller than an existing minimum size, the minimum size will always take precedence over the maximal size. A minimum size of (100,100) and a maximal size of (50,50) results in a minimum size of (100,100) and a maximum size of (100,100). If the minimum size is later changed to (25,25), the maximum size is again (50,50) and the minimum size is (25,25). This case also applies to Window's and their content panels. A content panel's minimum size always takes precedence over a Window's maximum content size.

void Widget::set_natural_size ( const omgui::Size & s ) [inherited]

Sets the natural size for this widget. The natural size is used by layout managers to determine how large to make widgets which are not expanded. The default natural size has a width and height of 0, which means that an acceptible natural size will be calculated for the width and height. You can override the calculated value by specifying your own value for the width and or height.

void Widget::set_position ( const omgui::Point & p ) [inherited]

Sets the position of a widget. If the widget is a TopLevel widget, the position value is in screen coordinates, otherwise it is client coordinates.

void Widget::set_rect ( const omgui::Rect & r ) [inherited]

Sets both the position and the size of the widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.

TableLayout & omgui::TableLayout::set_right_margin ( int margin )

Sets the right margin

TableLayout & omgui::TableLayout::set_row_gap ( int gap )

Specifies the amount of gap inbetween rows

TableLayout & omgui::TableLayout::set_row_weight	(	int	row,
		float	weight
	)

Sets the weight value for a given row

void Widget::set_size ( const omgui::Size & s ) [inherited]

Sets the absolute size of this widget. If the widget is a TopLevel widget, the value is in screen coordinates, otherwise it is client coordinates.

If the size value specified is smaller than the minimum size or larger than the maximum size, the size value actually set will be equal to the minimum size or maximum size respectively.

TableLayout & omgui::TableLayout::set_top_margin ( int margin )

Sets the top margin

void omgui::TableLayout::set_widget_layout_info	(	Pointer< Widget >	widget,
		const TableLayoutInfo &	info
	)

Specifies layout information for the given widget.

Precondition:: Widget must be a child of this TableLayout.

void Widget::show	(	bool	show = `true`,
		bool	focus = `false`
	)			`[inherited]`

Shows or hides a widget.

Note:: If this widget is a Panel which is currently functioning as a NotebookPage, this function will have no effect. Panel's which are NotebookPages are shown and hidden by the Notebook itself.

Reimplemented in omgui::TopLevel.

void omgui::Panel::update_layout ( ) [inherited]

Refreshes the layout by recalculating widget sizes and positions. Call after the visibility, layout information, mininum or maximum size of a child widget has changed, or if child widgets have been removed or added.

Todo:: Child widgets need to invalidate the cached min, max, and natural sizes in their parent TableLayout if their min max or natural size changes so that update_layout functions correctly.

Member Data Documentation

api_type* omgui::TableLayout::m_impl [private]

Reimplemented from omgui::Panel.

omgui::TableLayout Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation