omgui::common::Panel Class Reference

#include <omgui/common/panel.h>

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

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

List of all members.

Public Types

typedef
omgui::initializer::PanelData 
data_type
 Initialization data used for Panel.
typedef
omgui::initializer::WidgetData 
data_type
 Initialization data used for Widgets.
typedef omgui::Panel wrapper_type
typedef omgui::Widget wrapper_type

Public Member Functions

void add_child (const Pointer< omgui::Widget > &child)
virtual void destroy ()=0
virtual void enable (bool e)=0
const ChildListget_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 Pointer< omgui::Panelget_parent () const =0
virtual Pointer< omgui::Windowget_parent_window () const =0
virtual omgui::Point get_position () const =0
virtual omgui::Rect get_rect () const =0
virtual omgui::Size get_size () const =0
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 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 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_position (const omgui::Point &)=0
virtual void set_rect (const omgui::Rect &)=0
virtual void set_size (const omgui::Size &)=0
virtual void show (bool show, bool focus)=0
void update_layout ()

Private Attributes

ChildList m_children


Member Typedef Documentation

Initialization data used for Panel.

Reimplemented from omgui::api::Widget.

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

Reimplemented from omgui::api::Widget.

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


Member Function Documentation

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

Implements omgui::api::Panel.

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

virtual void omgui::api::Widget::enable ( bool  e  )  [pure virtual, inherited]

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

Implements omgui::api::Panel.

virtual void* omgui::api::Widget::get_handle (  )  const [pure virtual, inherited]

virtual omgui::Size omgui::api::Widget::get_max_size (  )  const [pure virtual, inherited]

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

virtual omgui::Size omgui::api::Widget::get_natural_size (  )  const [pure virtual, inherited]

virtual Pointer<omgui::Panel> omgui::api::Widget::get_parent (  )  const [pure virtual, inherited]

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

virtual omgui::Point omgui::api::Widget::get_position (  )  const [pure virtual, inherited]

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

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

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::common::Panel::invalidate_cached_child_values (  )  [virtual]

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

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

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

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

Implements omgui::api::Panel.

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

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

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.

virtual void omgui::api::Widget::set_max_size ( const omgui::Size  )  [pure virtual, inherited]

virtual void omgui::api::Widget::set_min_size ( const omgui::Size  )  [pure virtual, inherited]

virtual void omgui::api::Widget::set_natural_size ( const omgui::Size  )  [pure virtual, inherited]

virtual void omgui::api::Widget::set_position ( const omgui::Point  )  [pure virtual, inherited]

virtual void omgui::api::Widget::set_rect ( const omgui::Rect  )  [pure virtual, inherited]

virtual void omgui::api::Widget::set_size ( const omgui::Size  )  [pure virtual, inherited]

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

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

Implements omgui::api::Panel.

Reimplemented in omgui::common::TableLayout.


Member Data Documentation

Todo:
Consider whether storing this is really necessary. The gui kits will undoubtedly do it themselves as well.


doxygen SourceForge.net Logo