omgui::gtk2::TextBox Class Reference

#include <omgui/gtk2/textbox.h>

Inherits omgui::gtk2::Widget, and omgui::common::TextBox.

List of all members.

Public Types
typedef omgui::initializer::TextBoxData	data_type
	Initialization data used for TextBoxes.
typedef omgui::initializer::TextWidgetData	data_type
	Initialization data used for TextWidgets.
typedef omgui::initializer::WidgetData	data_type
	Initialization data used for Widgets.
typedef omgui::TextBox	wrapper_type
typedef omgui::TextWidget	wrapper_type
typedef omgui::Widget	wrapper_type
Public Member Functions
void	create (const omgui::initializer::TextBoxData &params)
virtual void	delete_range (const omgui::TextRange &)
virtual void	destroy ()
virtual void	enable (bool sensitive)
virtual void *	get_handle () const
virtual omgui::text_range_t	get_insertion_point () const
virtual omgui::text_range_t	get_length () const
virtual omgui::Size	get_max_size () const
virtual omgui::Size	get_min_size () const
virtual omgui::Size	get_natural_size () 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
virtual bool	get_selection_bounds (omgui::TextRange &) const
virtual omgui::TextRange	get_selection_range () const
virtual omgui::Size	get_size () const
virtual string	get_text (const omgui::TextRange &) const
virtual string	get_text () 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
virtual omgui::text_range_t	insert_text (const string &)
virtual omgui::text_range_t	insert_text (const string &, omgui::text_range_t)
virtual bool	is_enabled () const
virtual bool	is_hidden () const =0
virtual bool	is_read_only () const
virtual bool	is_shown () const
void	send_event (omgui::event_id)
virtual void	set_insertion_point (omgui::text_range_t)
virtual void	set_max_length (omgui::text_range_t)
virtual void	set_max_size (const omgui::Size &)
virtual void	set_min_size (const omgui::Size &)
virtual void	set_natural_size (const omgui::Size &)
virtual void	set_position (const omgui::Point &)
virtual void	set_read_only (bool)
virtual void	set_rect (const omgui::Rect &)
virtual void	set_selection_bounds (const omgui::TextRange &)
virtual void	set_selection_range (const omgui::TextRange &)
virtual void	set_size (const omgui::Size &)
virtual void	set_text (const string &)
virtual void	show (bool show, bool activate)
	TextBox (omgui::TextBox *wrapper=0)
Protected Member Functions
void	create (const omgui::initializer::WidgetData &, GtkWidget *)
Protected Attributes
GtkTextBuffer *	m_buffer
GtkWidget *	m_text
GtkWidget *	m_widget

---

Member Typedef Documentation

typedef omgui::initializer::TextBoxData omgui::api::TextBox::data_type [inherited]

Initialization data used for TextBoxes.

Reimplemented from omgui::api::TextWidget.

typedef omgui::initializer::TextWidgetData omgui::api::TextWidget::data_type [inherited]

Initialization data used for TextWidgets.

Reimplemented from omgui::api::Widget.

Reimplemented in omgui::api::EntryBox, omgui::api::SecureEntryBox, and omgui::api::TextBox.

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::TextBox omgui::api::TextBox::wrapper_type [inherited]

Reimplemented from omgui::api::TextWidget.

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

Reimplemented from omgui::api::Widget.

Reimplemented in omgui::api::EntryBox, omgui::api::SecureEntryBox, and omgui::api::TextBox.

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::gtk2::TextBox::TextBox

(

omgui::TextBox *

wrapper = 0

)

---

Member Function Documentation

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::TextBox::create

(

const omgui::initializer::TextBoxData &

params

)

[virtual]

Todo:

Use factory params

Todo:

Use correct border

Todo:

throw earlier or clean up m_text

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

void omgui::gtk2::TextBox::delete_range

(

const omgui::TextRange &

r

)

[virtual]

Note:

What happens if both args are END?

Implements omgui::api::TextWidget.

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.

virtual void* omgui::gtk2::Widget::get_handle

(

)

const [inline, virtual, inherited]

Implements omgui::api::Widget.

omgui::text_range_t omgui::gtk2::TextBox::get_insertion_point

(

)

const [virtual]

Implements omgui::api::TextWidget.

omgui::text_range_t omgui::gtk2::TextBox::get_length

(

)

const [virtual]

Implements omgui::api::TextWidget.

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]

Implements omgui::api::Widget.

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

virtual omgui::Size omgui::gtk2::Widget::get_natural_size

(

)

const [inline, virtual, inherited]

Implements omgui::api::Widget.

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

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Panel.

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.

bool omgui::gtk2::TextBox::get_selection_bounds

(

omgui::TextRange &

range

)

const [virtual]

Implements omgui::api::TextWidget.

omgui::TextRange omgui::gtk2::TextBox::get_selection_range

(

)

const [virtual]

Implements omgui::api::TextWidget.

omgui::Size omgui::gtk2::Widget::get_size

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

Reimplemented in omgui::gtk2::Window.

string omgui::gtk2::TextBox::get_text

(

const omgui::TextRange &

r

)

const [virtual]

Note:

What happens if both args are END?

Can we do this with a shared pointer somehow?

Todo:

UTF8 -> string

Implements omgui::api::TextWidget.

string omgui::gtk2::TextBox::get_text

(

)

const [virtual]

Note:

Can we do this with a shared pointer somehow?

Todo:

UTF8 -> string

Implements omgui::api::TextWidget.

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

omgui::text_range_t omgui::gtk2::TextBox::insert_text

(

const string &

str

)

[virtual]

Todo:

string -> UTF8

Implements omgui::api::TextWidget.

omgui::text_range_t omgui::gtk2::TextBox::insert_text	(	const string &	str,
		omgui::text_range_t	pos
	)			[virtual]

Todo:

Do we allow negative positions? If not, remove the if block

Todo:

string -> UTF8

Implements omgui::api::TextWidget.

bool omgui::gtk2::Widget::is_enabled

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

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

(

)

const [pure virtual, inherited]

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

bool omgui::gtk2::TextBox::is_read_only

(

)

const [virtual]

Implements omgui::api::TextWidget.

bool omgui::gtk2::Widget::is_shown

(

)

const [virtual, inherited]

Implements omgui::api::Widget.

void omgui::gtk2::Widget::send_event

(

omgui::event_id

event_id

)

[inherited]

void omgui::gtk2::TextBox::set_insertion_point

(

omgui::text_range_t

pos

)

[virtual]

Todo:

Should the focusing postcondition remain in effect?

Implements omgui::api::TextWidget.

void omgui::gtk2::TextBox::set_max_length

(

omgui::text_range_t

len

)

[virtual]

Todo:

IMPLEMENT

Implements omgui::api::TextWidget.

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::Widget::set_position

(

const omgui::Point &

pos

)

[virtual, inherited]

Implements omgui::api::Widget.

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

void omgui::gtk2::TextBox::set_read_only

(

bool

b

)

[virtual]

Implements omgui::api::TextWidget.

void omgui::gtk2::Widget::set_rect

(

const omgui::Rect &

rect

)

[virtual, inherited]

Implements omgui::api::Widget.

void omgui::gtk2::TextBox::set_selection_bounds

(

const omgui::TextRange &

range

)

[virtual]

Todo:

Do we need to normalize?

Implements omgui::api::TextWidget.

void omgui::gtk2::TextBox::set_selection_range

(

const omgui::TextRange &

range

)

[virtual]

Implements omgui::api::TextWidget.

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::TextBox::set_text

(

const string &

str

)

[virtual]

Todo:

string -> UTF8

Implements omgui::api::TextWidget.

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

Implements omgui::api::Widget.

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

---

Member Data Documentation

GtkTextBuffer* omgui::gtk2::TextBox::m_buffer [protected]

GtkWidget* omgui::gtk2::TextBox::m_text [protected]

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