omgui::Window Class Reference

#include <omgui/window.h>

Inherits omgui::TopLevel.

List of all members.

Detailed Description

A Window is a top level Widget. It has a title bar, which can also be called a caption, and contains a Content Panel.

Event Objects:

omgui::WindowCloseEvent

Events:

omgui::event_traits<Window>


Public Types
typedef omgui::api::Window	api_type
typedef omgui::event_traits < Window >	event_traits
typedef WindowInitializer	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.
Pointer< omgui::Panel >	get_content_panel () const
omgui::Size	get_content_size () const
void *	get_handle () const
object_id	get_id () const
api_type *	get_impl () const
omgui::Size	get_max_content_size () 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.
Pointer< MenuBar >	get_menu_bar () const
omgui::Size	get_min_content_size () const
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
string	get_title () const
string	get_window_placement () const
void	hide ()
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_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.
Pointer< omgui::Panel >	set_content_panel (const Pointer< omgui::Panel > &p)
void	set_content_size (const omgui::Size &s)
	Sets the client size of the widget.
void	set_max_content_size (const omgui::Size &size)
	Sets the maximum size for the content of this window. That is to say that the content panel of this Window will never be larger than the maximum content size.
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_menu_bar (const Pointer< MenuBar > &menubar)
void	set_min_content_size (const omgui::Size &size)
	Sets the minimum size for the content of this window. That is to say that the content panel of this Window will never be smaller than the minimum content size.
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.
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.
void	set_title (const string &t)
	Sets the title of the widgets caption.
void	set_window_placement (const string &placement)
void	show (bool show=true, bool focus=true)
	Shows or hides a widget.
Static Public Member Functions
static Pointer< Window >	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.
	Window (object_id id, api_type *impl)
	Window (object_id id)
Private Attributes
api_type *	m_impl

Member Typedef Documentation

typedef omgui::api::Window omgui::Window::api_type

Reimplemented from omgui::TopLevel.

typedef omgui::event_traits<Window> omgui::Window::event_traits

Reimplemented from omgui::Widget.

typedef WindowInitializer omgui::Window::Initializer

Constructor & Destructor Documentation

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

omgui::Window::Window	(	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< Window > omgui::Window::create	(	const Initializer &	initializer,
		object_id	id = `OBJECT_ID_ANY`
	)			`[static]`

Creates a Window 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.

Pointer< omgui::Panel > omgui::Window::get_content_panel ( ) const

Returns:: This window's content panel

Size omgui::TopLevel::get_content_size ( ) const [inherited]

Returns:: The client size of the widget.

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.

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

Reimplemented from omgui::TopLevel.

omgui::Size omgui::Window::get_max_content_size ( ) const

Returns:: The maximum allowable content size

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.

Pointer<MenuBar> omgui::Window::get_menu_bar ( ) const

Returns the MenuBar assocated with this Window. If no MenuBar has been associated, an empty pointer will be returned. Modifciations to the menu bar will be immediately reflected in the Window.

omgui::Size omgui::Window::get_min_content_size ( ) const

Returns:: The minimum allowable content size

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

string omgui::TopLevel::get_title ( ) const [inherited]

Returns:: The title of the widgets caption.

string omgui::Window::get_window_placement ( ) const

This function returns a string describing the placement of this Window. It is meant to be used in conjunction with set_window_placement to remember a Window's position over application instances. Save this string somewhere, load it, and use set_window_placement the next time the application runs to put the Window exactly where the user had it the last time they ran the application.

All relevant information relating to window position will be handled by get_window_placement and set_window_placement. This information includes:

Size and Position
Whether the Window was Maximized or Minimized (Zoomed or Unzoomed for Mac OS)
Visibility

As an example, a Window has a Rect of (100,100 400,400) when not maximized but is currently maximized, the string returned will describe that the window is currently maximized, that its restored size and position is (100,100 400,400), and that the window is visible.

Note:: The contents of the string are implementation defined. Modifying the string will most likely result in undefined behavior.

Returns:: A string describing the placement of this Window.

void Widget::hide ( ) [inherited]

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

Constructs the native widget using the given initialization data.

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 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.

Pointer< omgui::Panel > omgui::Window::set_content_panel ( const Pointer< omgui::Panel > & p )

Sets the content panel for this window

Returns:: The old content panel, which is now orphaned and hidden

void omgui::TopLevel::set_content_size ( const omgui::Size & s ) [inherited]

Sets the client size of the widget.

void omgui::Window::set_max_content_size ( const omgui::Size & size )

Sets the maximum size for the content of this window. That is to say that the content panel of this Window will never be larger than the maximum content size.

If the content panel's size is currently larger than the new maximum content size, the Window will be resized so the content size of the panel is equal to the newly specified maximum content size.

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 omgui::Window::set_menu_bar ( const Pointer< MenuBar > & menubar )

Sets the MenuBar to use in this Window. Only one MenuBar can be associated with the Window at one time.

void omgui::Window::set_min_content_size ( const omgui::Size & size )

Sets the minimum size for the content of this window. That is to say that the content panel of this Window will never be smaller than the minimum content size.

If the content panel's size is currently smaller than the new minimum content size, the Window will be resized so the content size of the panel is equal to the newly specified minimum content 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.

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.

void omgui::TopLevel::set_title ( const string & t ) [inherited]

Sets the title of the widgets caption.

void omgui::Window::set_window_placement ( const string & placement )

Sets the placement of this Window.

Parameters:

placement

A string describing the placement of this window. This string must have been returned by a previous call to get_window_placement.

void omgui::TopLevel::show	(	bool	show = `true`,
		bool	focus = `true`
	)			`[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 from omgui::Widget.

Member Data Documentation

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

Reimplemented from omgui::TopLevel.

omgui::Window 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