omgui::gtk2::Notebook Class Reference

#include <omgui/gtk2/notebook.h>

Inherits omgui::gtk2::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)
virtual void destroy ()
virtual void enable (bool sensitive)
const ChildListget_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 omgui::Panelget_parent () const
virtual Pointer< omgui::Windowget_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::Widgetget_wrapper ()
const omgui::Widgetget_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 =0
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 send_event (omgui::event_id)
virtual void set_max_size (const omgui::Size &)
virtual 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 &)
virtual 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

int m_last_height
int m_last_width

Protected Member Functions

void create (const omgui::initializer::WidgetData &, GtkWidget *)

Protected Attributes

GtkWidgetm_widget


Member Typedef Documentation

Initialization data used for Notebook.

Reimplemented from omgui::api::Panel.

Initialization data used for Panel.

Reimplemented from omgui::api::Widget.

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

Reimplemented from omgui::api::Panel.

Reimplemented from omgui::api::Widget.

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


Constructor & Destructor Documentation

omgui::gtk2::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::gtk2::Notebook::append_page ( NotebookPage  page,
const string name 
) [virtual]

Todo:
string -> UTF8

Implements omgui::api::Notebook.

void omgui::gtk2::Widget::create ( const omgui::initializer::WidgetData params,
GtkWidget widget 
) [protected, inherited]

Todo:
Fix logic later

Todo:
Uncomment after all set_{min,max}_size methods are aware of the DEFAULT_* values

Todo:
Make sure nothing above realizes the control, and change order appropriately if something does. E.g show() is in all derived class create()'s instead of here.

void omgui::gtk2::Panel::create ( const omgui::initializer::PanelData params  )  [inherited]

void omgui::gtk2::Notebook::create ( const omgui::initializer::NotebookData params  )  [virtual]

Todo:
Use factory params

Todo:
IMPLEMENT

Note:
Show is always last - it might realize the widget (if params.m_show == true), and we don't want that to happen before all other data is set.

Implements omgui::api::Notebook.

void omgui::gtk2::Widget::destroy (  )  [virtual, inherited]

Todo:
I (RM) blindly changed this, see if it works

Implements omgui::api::Widget.

void omgui::gtk2::Widget::enable ( bool  sensitive  )  [virtual, inherited]

Implements omgui::api::Widget.

const ChildList & omgui::common::Panel::get_child_list (  )  const [virtual, inherited]

Implements omgui::api::Panel.

virtual void* omgui::gtk2::Widget::get_handle (  )  const [inline, virtual, inherited]

Implements omgui::api::Widget.

virtual omgui::Size omgui::gtk2::Widget::get_max_size (  )  const [inline, virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Window.

omgui::Size omgui::gtk2::Widget::get_min_size (  )  const [virtual, inherited]

virtual omgui::Size omgui::gtk2::Widget::get_natural_size (  )  const [inline, virtual, inherited]

Implements omgui::api::Widget.

NotebookPage omgui::gtk2::Notebook::get_page ( int  index  )  const [virtual]

Todo:
throw something instead

Implements omgui::api::Notebook.

int omgui::gtk2::Notebook::get_page_count (  )  const [virtual]

Implements omgui::api::Notebook.

int omgui::gtk2::Notebook::get_page_index ( NotebookPage  page  )  const [virtual]

Todo:
Doesn't work right with proof sample

Todo:
throw something instead

Implements omgui::api::Notebook.

string omgui::gtk2::Notebook::get_page_name ( NotebookPage  page  )  const [virtual]

Todo:
UTF8 -> string

Implements omgui::api::Notebook.

boost::shared_ptr< omgui::Panel > omgui::gtk2::Panel::get_parent (  )  const [virtual, inherited]

Reimplemented from omgui::gtk2::Widget.

Pointer< omgui::Window > omgui::gtk2::Widget::get_parent_window (  )  const [virtual, inherited]

Implements omgui::api::Widget.

virtual omgui::Point omgui::gtk2::Widget::get_position (  )  const [inline, virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Window.

omgui::Rect omgui::gtk2::Widget::get_rect (  )  const [virtual, inherited]

Implements omgui::api::Widget.

NotebookPage omgui::gtk2::Notebook::get_selected_page (  )  const [virtual]

Implements omgui::api::Notebook.

omgui::Size omgui::gtk2::Widget::get_size (  )  const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::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::gtk2::Notebook::insert_page ( int  where,
NotebookPage  page,
const string name 
) [virtual]

Todo:
string -> UTF8

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::gtk2::Widget::is_enabled (  )  const [virtual, inherited]

Implements omgui::api::Widget.

virtual bool omgui::api::Widget::is_hidden (  )  const [pure virtual, inherited]

bool omgui::common::Panel::is_orphaned (  )  const [virtual, inherited]

Implements omgui::api::Panel.

bool omgui::gtk2::Widget::is_shown (  )  const [virtual, inherited]

Implements omgui::api::Widget.

void omgui::common::Panel::remove_child ( const Pointer< omgui::Widget > &  child  )  [virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

NotebookPage omgui::gtk2::Notebook::remove_page ( NotebookPage  page  )  [virtual]

Implements omgui::api::Notebook.

bool omgui::gtk2::Notebook::select_next_page (  )  [virtual]

Todo:
event emission

Todo:
correct return value based on event emission and if a next page existed

Implements omgui::api::Notebook.

bool omgui::gtk2::Notebook::select_previous_page (  )  [virtual]

Todo:
event emission

Todo:
correct return value based on event emission and if a previous page existed

Implements omgui::api::Notebook.

void omgui::gtk2::Widget::send_event ( omgui::event_id  event_id  )  [inherited]

virtual void omgui::gtk2::Widget::set_max_size ( const omgui::Size  )  [inline, virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Window.

void omgui::gtk2::Widget::set_min_size ( const omgui::Size s  )  [virtual, inherited]

Todo:
Does passing 0,0 set it to "as small as possible" in the terms we want?

Todo:
Do we want this?

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Window.

virtual void omgui::gtk2::Widget::set_natural_size ( const omgui::Size  )  [inline, virtual, inherited]

Implements omgui::api::Widget.

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

Todo:
string -> UTF8

Implements omgui::api::Notebook.

void omgui::gtk2::Panel::set_position ( const omgui::Point pos  )  [virtual, inherited]

Reimplemented from omgui::gtk2::Widget.

void omgui::gtk2::Widget::set_rect ( const omgui::Rect rect  )  [virtual, inherited]

Implements omgui::api::Widget.

bool omgui::gtk2::Notebook::set_selected_page ( NotebookPage  page  )  [virtual]

Todo:
event emission

Todo:
proper return value based on event emission

Implements omgui::api::Notebook.

void omgui::gtk2::Widget::set_size ( const omgui::Size s  )  [virtual, inherited]

Todo:
Do we want to enforce allocation instead? Yes.

Todo:
Deal with DEFAULT_* values

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::TableLayout, and omgui::gtk2::Window.

void omgui::gtk2::Panel::show ( bool  show,
bool  activate 
) [virtual, inherited]

Reimplemented from omgui::gtk2::Widget.

void omgui::common::Panel::update_layout (  )  [virtual, inherited]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.


Member Data Documentation

GtkWidget* omgui::gtk2::Widget::m_widget [protected, inherited]


doxygen SourceForge.net Logo