omgui::common::Notebook Class Reference

#include <omgui/common/notebook.h>

Inherits omgui::common::Panel, and omgui::api::Notebook.

Inherited by omgui::cocoa::Notebook [virtual], omgui::gtk2::Notebook [virtual], and omgui::win32::Notebook [virtual].

List of all members.

Public Types
typedef omgui::initializer::NotebookData	data_type
	Initialization data used for Notebook.
typedef omgui::initializer::PanelData	data_type
	Initialization data used for Panel.
typedef omgui::initializer::WidgetData	data_type
	Initialization data used for Widgets.
typedef omgui::Notebook	wrapper_type
typedef omgui::Panel	wrapper_type
typedef omgui::Widget	wrapper_type
Public Member Functions
void	add_child (const Pointer< omgui::Widget > &child)
virtual void	append_page (NotebookPage page, const string &name)=0
virtual void	create (const data_type &init_params)=0
virtual void	destroy ()=0
virtual void	enable (bool e)=0
const ChildList &	get_child_list () const
virtual void *	get_handle () const =0
virtual omgui::Size	get_max_size () const =0
virtual omgui::Size	get_min_size () const =0
virtual omgui::Size	get_natural_size () const =0
virtual NotebookPage	get_page (int index) const =0
virtual int	get_page_count () const =0
virtual int	get_page_index (NotebookPage page) const =0
virtual string	get_page_name (NotebookPage page) const =0
virtual Pointer< omgui::Panel >	get_parent () const =0
virtual Pointer< omgui::Window >	get_parent_window () const =0
virtual omgui::Point	get_position () const =0
virtual omgui::Rect	get_rect () const =0
virtual NotebookPage	get_selected_page () const =0
virtual omgui::Size	get_size () const =0
template<typename T>
T *	get_wrapper ()
template<typename T>
const T *	get_wrapper () const
omgui::Widget *	get_wrapper ()
const omgui::Widget *	get_wrapper () const
omgui::object_id	get_wrapper_id () const
virtual void	insert_page (int where, NotebookPage page, const string &name)=0
void	invalidate_cached_child_values ()
virtual bool	is_enabled () const =0
virtual bool	is_hidden () const =0
bool	is_orphaned () const
virtual bool	is_shown () const =0
void	remove_child (const Pointer< omgui::Widget > &child)
virtual NotebookPage	remove_page (NotebookPage page)=0
virtual bool	select_next_page ()=0
virtual bool	select_previous_page ()=0
virtual void	set_max_size (const omgui::Size &)=0
virtual void	set_min_size (const omgui::Size &)=0
virtual void	set_natural_size (const omgui::Size &)=0
virtual void	set_page_name (NotebookPage page, const string &name)=0
virtual void	set_position (const omgui::Point &)=0
virtual void	set_rect (const omgui::Rect &)=0
virtual bool	set_selected_page (NotebookPage page)=0
virtual void	set_size (const omgui::Size &)=0
virtual void	show (bool show, bool focus)=0
void	update_layout ()

---

Member Typedef Documentation

typedef omgui::initializer::NotebookData omgui::api::Notebook::data_type [inherited]

Initialization data used for Notebook.

Reimplemented from omgui::api::Panel.

typedef omgui::initializer::PanelData omgui::api::Panel::data_type [inherited]

Initialization data used for Panel.

Reimplemented from omgui::api::Widget.

Reimplemented in omgui::api::Notebook, and omgui::api::TableLayout.

typedef omgui::initializer::WidgetData omgui::api::Widget::data_type [inherited]

Initialization data used for Widgets.

Reimplemented in omgui::api::Button, omgui::api::ComboBox, omgui::api::EntryBox, omgui::api::Notebook, omgui::api::Panel, omgui::api::SecureEntryBox, omgui::api::TableLayout, omgui::api::TextBox, omgui::api::TextWidget, and omgui::api::Window.

typedef omgui::Notebook omgui::api::Notebook::wrapper_type [inherited]

Reimplemented from omgui::api::Panel.

typedef omgui::Panel omgui::api::Panel::wrapper_type [inherited]

Reimplemented from omgui::api::Widget.

Reimplemented in omgui::api::Notebook, and omgui::api::TableLayout.

typedef omgui::Widget omgui::api::Widget::wrapper_type [inherited]

Reimplemented in omgui::api::Button, omgui::api::ComboBox, omgui::api::EntryBox, omgui::api::Notebook, omgui::api::Panel, omgui::api::SecureEntryBox, omgui::api::TableLayout, omgui::api::TextBox, omgui::api::TextWidget, omgui::api::TopLevel, and omgui::api::Window.

---

Member Function Documentation

void omgui::common::Panel::add_child

(

const Pointer< omgui::Widget > &

child

)

[virtual, inherited]

Implements omgui::api::Panel.

virtual void omgui::api::Notebook::append_page	(	NotebookPage	page,
		const string &	name
	)			[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual void omgui::api::Notebook::create

(

const data_type &

init_params

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual void omgui::api::Widget::destroy

(

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Panel, omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual void omgui::api::Widget::enable

(

bool

e

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, and omgui::win32::Widget.

const ChildList & omgui::common::Panel::get_child_list

(

)

const [virtual, inherited]

Implements omgui::api::Panel.

virtual void* omgui::api::Widget::get_handle

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual omgui::Size omgui::api::Widget::get_max_size

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual omgui::Size omgui::api::Widget::get_min_size

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::TableLayout, omgui::cocoa::Widget, omgui::common::TableLayout, omgui::gtk2::TableLayout, omgui::gtk2::Widget, omgui::gtk2::Window, omgui::win32::Notebook, omgui::win32::TableLayout, and omgui::win32::Widget.

virtual omgui::Size omgui::api::Widget::get_natural_size

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual NotebookPage omgui::api::Notebook::get_page

(

int

index

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual int omgui::api::Notebook::get_page_count

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual int omgui::api::Notebook::get_page_index

(

NotebookPage

page

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual string omgui::api::Notebook::get_page_name

(

NotebookPage

page

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual Pointer<omgui::Panel> omgui::api::Widget::get_parent

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Panel, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual Pointer<omgui::Window> omgui::api::Widget::get_parent_window

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual omgui::Point omgui::api::Widget::get_position

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual omgui::Rect omgui::api::Widget::get_rect

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual NotebookPage omgui::api::Notebook::get_selected_page

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual omgui::Size omgui::api::Widget::get_size

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

template<typename T>

T* omgui::common::Widget::get_wrapper

(

)

[inline, inherited]

Returns:

The wrapper object for this Widget casted to T*

template<typename T>

const T* omgui::common::Widget::get_wrapper

(

)

const [inline, inherited]

Returns:

The wrapper object for this Widget casted to const T *

omgui::Widget* omgui::common::Widget::get_wrapper

(

)

[inline, inherited]

Returns:

The wrapper object for this Widget

const omgui::Widget* omgui::common::Widget::get_wrapper

(

)

const [inline, inherited]

Returns:

The wrapper object for this Widget

omgui::object_id omgui::common::Widget::get_wrapper_id

(

)

const [inherited]

Returns:

The id of this Widget's wrapper object

virtual void omgui::api::Notebook::insert_page	(	int	where,
		NotebookPage	page,
		const string &	name
	)			[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

void omgui::common::Panel::invalidate_cached_child_values

(

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

virtual bool omgui::api::Widget::is_enabled

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual bool omgui::api::Widget::is_hidden

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, and omgui::win32::Widget.

bool omgui::common::Panel::is_orphaned

(

)

const [virtual, inherited]

Implements omgui::api::Panel.

virtual bool omgui::api::Widget::is_shown

(

)

const [pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, and omgui::win32::Widget.

void omgui::common::Panel::remove_child

(

const Pointer< omgui::Widget > &

child

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

virtual NotebookPage omgui::api::Notebook::remove_page

(

NotebookPage

page

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual bool omgui::api::Notebook::select_next_page

(

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual bool omgui::api::Notebook::select_previous_page

(

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual void omgui::api::Widget::set_max_size

(

const omgui::Size &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Panel, omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual void omgui::api::Widget::set_min_size

(

const omgui::Size &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Panel, omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual void omgui::api::Widget::set_natural_size

(

const omgui::Size &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual void omgui::api::Notebook::set_page_name	(	NotebookPage	page,
		const string &	name
	)			[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual void omgui::api::Widget::set_position

(

const omgui::Point &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Panel, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual void omgui::api::Widget::set_rect

(

const omgui::Rect &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::cocoa::TableLayout, omgui::cocoa::Widget, omgui::gtk2::Widget, and omgui::win32::Widget.

virtual bool omgui::api::Notebook::set_selected_page

(

NotebookPage

page

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Notebook, omgui::gtk2::Notebook, and omgui::win32::Notebook.

virtual void omgui::api::Widget::set_size

(

const omgui::Size &

)

[pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::TableLayout, omgui::gtk2::Widget, omgui::gtk2::Window, and omgui::win32::Widget.

virtual void omgui::api::Widget::show	(	bool	show,
		bool	focus
	)			[pure virtual, inherited]

Implemented in omgui::cocoa::Widget, omgui::cocoa::Window, omgui::gtk2::Panel, omgui::gtk2::Widget, omgui::gtk2::Window, omgui::win32::Panel, and omgui::win32::Widget.

void omgui::common::Panel::update_layout

(

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.