omgui::cocoa::Notebook Class Reference

#include <omgui/cocoa/notebook.h>

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

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)
void	append_page (NotebookPage page, const string &name)
void	create (const omgui::initializer::PanelData &params)
void	create (const omgui::initializer::NotebookData &params)
NSTabViewItem *	create_page (NotebookPage page, const string &name)
void	destroy ()
virtual void	enable (bool sensitive)
const ChildList &	get_child_list () const
virtual void *	get_handle () const
virtual omgui::Size	get_max_size () const
virtual omgui::Size	get_min_size () const
virtual omgui::Size	get_natural_size () const
NotebookPage	get_page (int index) const
int	get_page_count () const
int	get_page_index (NotebookPage page) const
string	get_page_name (NotebookPage page) const
virtual Pointer< omgui::Panel >	get_parent () const
virtual Pointer< omgui::Window >	get_parent_window () const
virtual omgui::Point	get_position () const
virtual omgui::Rect	get_rect () const
NotebookPage	get_selected_page () const
virtual omgui::Size	get_size () const
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
void	insert_page (int where, NotebookPage page, const string &name)
void	invalidate_cached_child_values ()
virtual bool	is_enabled () const
virtual bool	is_hidden () const
bool	is_orphaned () const
virtual bool	is_shown () const
	Notebook (omgui::Notebook *wrapper=0)
void	remove_child (const Pointer< omgui::Widget > &child)
NotebookPage	remove_page (NotebookPage page)
bool	select_next_page ()
bool	select_previous_page ()
void	set_max_size (const omgui::Size &)
void	set_min_size (const omgui::Size &)
virtual void	set_natural_size (const omgui::Size &)
void	set_page_name (NotebookPage page, const string &name)
virtual void	set_position (const omgui::Point &)
void	set_rect (const omgui::Rect &)
bool	set_selected_page (NotebookPage page)
virtual void	set_size (const omgui::Size &)
virtual void	show (bool show, bool activate)
void	update_layout ()
Public Attributes
Panel *	m_current_page
omgui::Size	m_max_size
omgui::Size	m_min_size
Protected Member Functions
void	create (const omgui::initializer::WidgetData &params, id widget)
void	send_event (const omgui::event_id event_id)
Protected Attributes
omgui::Size	m_natural_size
id	m_object

---

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.

---

Constructor & Destructor Documentation

omgui::cocoa::Notebook::Notebook

(

omgui::Notebook *

wrapper = 0

)

---

Member Function Documentation

void omgui::common::Panel::add_child

(

const Pointer< omgui::Widget > &

child

)

[virtual, inherited]

Implements omgui::api::Panel.

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

Implements omgui::api::Notebook.

void omgui::cocoa::Widget::create	(	const omgui::initializer::WidgetData &	params,
		id	widget
	)			[protected, inherited]

Todo:

m_enable

Todo:

What's if we're adding the widget later to a container?

Todo:

else?

Todo:

do_layout?

void omgui::cocoa::Panel::create

(

const omgui::initializer::PanelData &

params

)

[inherited]

void omgui::cocoa::Notebook::create

(

const omgui::initializer::NotebookData &

params

)

[virtual]

Implements omgui::api::Notebook.

NSTabViewItem * omgui::cocoa::Notebook::create_page	(	NotebookPage	page,
		const string &	name
	)

void omgui::cocoa::Panel::destroy

(

)

[virtual, inherited]

Reimplemented from omgui::cocoa::Widget.

void omgui::cocoa::Widget::enable

(

bool

sensitive

)

[virtual, inherited]

Todo:

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

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

(

)

const [virtual, inherited]

Implements omgui::api::Panel.

virtual void* omgui::cocoa::Widget::get_handle

(

)

const [inline, virtual, inherited]

Implements omgui::api::Widget.

omgui::Size omgui::cocoa::Widget::get_max_size

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

omgui::Size omgui::cocoa::Widget::get_min_size

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::TableLayout.

omgui::Size omgui::cocoa::Widget::get_natural_size

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

NotebookPage omgui::cocoa::Notebook::get_page

(

int

index

)

const [virtual]

Todo:

Implement

Implements omgui::api::Notebook.

int omgui::cocoa::Notebook::get_page_count

(

)

const [virtual]

Todo:

Implement

Implements omgui::api::Notebook.

int omgui::cocoa::Notebook::get_page_index

(

NotebookPage

page

)

const [virtual]

Todo:

Implement

Implements omgui::api::Notebook.

string omgui::cocoa::Notebook::get_page_name

(

NotebookPage

page

)

const [virtual]

Todo:

Implement

Implements omgui::api::Notebook.

Pointer< omgui::Panel > omgui::cocoa::Widget::get_parent

(

)

const [virtual, inherited]

Todo:

What should I do if the parent doesn't respond to omguiWidget ?

Implements omgui::api::Widget.

Pointer< omgui::Window > omgui::cocoa::Widget::get_parent_window

(

)

const [virtual, inherited]

Todo:

What should I do if the parent doesn't respond to omguiWidget ?

Implements omgui::api::Widget.

omgui::Point omgui::cocoa::Widget::get_position

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

omgui::Rect omgui::cocoa::Widget::get_rect

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

NotebookPage omgui::cocoa::Notebook::get_selected_page

(

)

const [virtual]

Implements omgui::api::Notebook.

omgui::Size omgui::cocoa::Widget::get_size

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

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

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

Implements omgui::api::Notebook.

void omgui::common::Panel::invalidate_cached_child_values

(

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

bool omgui::cocoa::Widget::is_enabled

(

)

const [virtual, inherited]

Todo:

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

bool omgui::cocoa::Widget::is_hidden

(

)

const [virtual, inherited]

Todo:

is that correct?

Implements omgui::api::Widget.

bool omgui::common::Panel::is_orphaned

(

)

const [virtual, inherited]

Implements omgui::api::Panel.

bool omgui::cocoa::Widget::is_shown

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

void omgui::common::Panel::remove_child

(

const Pointer< omgui::Widget > &

child

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

NotebookPage omgui::cocoa::Notebook::remove_page

(

NotebookPage

page

)

[virtual]

Todo:

Implement

Implements omgui::api::Notebook.

bool omgui::cocoa::Notebook::select_next_page

(

)

[virtual]

Todo:

Implement

Implements omgui::api::Notebook.

bool omgui::cocoa::Notebook::select_previous_page

(

)

[virtual]

Todo:

Implement

Implements omgui::api::Notebook.

void omgui::cocoa::Widget::send_event

(

const omgui::event_id

event_id

)

[protected, inherited]

void omgui::cocoa::Panel::set_max_size

(

const omgui::Size &

size

)

[virtual, inherited]

Reimplemented from omgui::cocoa::Widget.

void omgui::cocoa::Panel::set_min_size

(

const omgui::Size &

size

)

[virtual, inherited]

Reimplemented from omgui::cocoa::Widget.

void omgui::cocoa::Widget::set_natural_size

(

const omgui::Size &

size

)

[virtual, inherited]

Implements omgui::api::Widget.

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

Todo:

Implement

Implements omgui::api::Notebook.

void omgui::cocoa::Widget::set_position

(

const omgui::Point &

s

)

[virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

void omgui::cocoa::Notebook::set_rect

(

const omgui::Rect &

rect

)

[virtual]

Reimplemented from omgui::cocoa::Widget.

bool omgui::cocoa::Notebook::set_selected_page

(

NotebookPage

page

)

[virtual]

Todo:

Implement

Implements omgui::api::Notebook.

void omgui::cocoa::Widget::set_size

(

const omgui::Size &

s

)

[virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

void omgui::cocoa::Widget::show	(	bool	show,
		bool	activate
	)			[virtual, inherited]

Todo:

activate

Implements omgui::api::Widget.

Reimplemented in omgui::cocoa::Window.

void omgui::common::Panel::update_layout

(

)

[virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

---

Member Data Documentation

Panel* omgui::cocoa::Notebook::m_current_page

omgui::Size omgui::cocoa::Widget::m_max_size [inherited]

omgui::Size omgui::cocoa::Widget::m_min_size [inherited]

omgui::Size omgui::cocoa::Widget::m_natural_size [protected, inherited]

id omgui::cocoa::Widget::m_object [protected, inherited]