Hildon::TextView Class Reference
[Widgets]

A text view widget, derived from Gtk::TextView, with additional features specific to the Hildon framework. More...

Inheritance diagram for Hildon::TextView:

[legend]

List of all members.

Public Member Functions
virtual	~TextView ()
HildonTextView *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonTextView *	gobj () const
	Provides access to the underlying C GtkObject.
	TextView ()
void	set_buffer (const Glib::RefPtr< Gtk::TextBuffer > &buffer)
	Sets buffer as the buffer being displayed by text_view.
Glib::RefPtr< Gtk::TextBuffer >	get_buffer ()
	Returns: a Gtk::TextBuffer.
Glib::RefPtr< const Gtk::TextBuffer >	get_buffer () const
	Returns: a Gtk::TextBuffer.
void	set_placeholder (const Glib::ustring &text)
	Sets the placeholder text in text_view to text.
Related Functions
(Note that these are not member functions.)
Hildon::TextView *	wrap (HildonTextView *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A text view widget, derived from Gtk::TextView, with additional features specific to the Hildon framework.

Besides all the features inherited from Gtk::TextView, a Hildon::TextView can also have a placeholder text. This text will be shown if the text view is empty and doesn't have the input focus, but it's otherwise ignored. Thus, calls to Hildon::TextView::get_buffer() will never return the placeholder text, not even when it's being displayed.

Although Hildon::TextView is derived from Gtk::TextView, Gtk::TextView::get_buffer() and Gtk::TextView::set_buffer() must never be used to get/set the buffer in this widget. Hildon::TextView::get_buffer() and Hildon::TextView::set_buffer() must be used instead.

---

Constructor & Destructor Documentation

virtual Hildon::TextView::~TextView

(

)

[virtual]

Reimplemented from Gtk::TextView.

Hildon::TextView::TextView

(

)

Reimplemented from Gtk::TextView.

---

Member Function Documentation

HildonTextView* Hildon::TextView::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

const HildonTextView* Hildon::TextView::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

void Hildon::TextView::set_buffer

(

const Glib::RefPtr< Gtk::TextBuffer > &

buffer

)

Sets buffer as the buffer being displayed by text_view.

The previous buffer displayed by the text view is unreferenced, and a reference is added to buffer. If you owned a reference to buffer before passing it to this function, you must remove that reference yourself

{2,2}

Deprecated: use gtk_text_view_set_buffer() instead

Parameters:

buffer

A Gtk::TextBuffer.

Reimplemented from Gtk::TextView.

Glib::RefPtr<Gtk::TextBuffer> Hildon::TextView::get_buffer

(

)

Returns: a Gtk::TextBuffer.

Returns:

A Gtk::TextBuffer

{2,2}

Deprecated: use gtk_text_view_get_buffer() instead.

Reimplemented from Gtk::TextView.

Glib::RefPtr<const Gtk::TextBuffer> Hildon::TextView::get_buffer

(

)

const

Returns: a Gtk::TextBuffer.

Returns:

A Gtk::TextBuffer

{2,2}

Deprecated: use gtk_text_view_get_buffer() instead.

Reimplemented from Gtk::TextView.

void Hildon::TextView::set_placeholder

(

const Glib::ustring &

text

)

Sets the placeholder text in text_view to text.

{2,2}

Deprecated: use hildon_gtk_text_view_set_placeholder_text() instead

Parameters:

text

The new text.

---

Friends And Related Function Documentation

Hildon::TextView * wrap	(	HildonTextView *	object,
		bool	take_copy = false
	)			[related]

A Glib::wrap() method for this object.

Parameters:

	object	The C instance.
	take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:

A C++ instance that wraps this C instance.

---

The documentation for this class was generated from the following file:

• text-view.h