Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::TextView Class Reference

Inheritance diagram for Hildon::TextView:

Inheritance graph
[legend]

List of all members.


Detailed Description

Widget representing a text view in the Hildon framework.

Hildon::TextView is a text view. It is derived from the Gtk::TextView widget and provides additional commodities 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.

Public Member Functions

Glib::RefPtr< const
Gtk::TextBuffer
get_buffer () const
Glib::RefPtr<Gtk::TextBufferget_buffer ()
const HildonTextView* gobj () const
 Provides access to the underlying C GtkObject.
HildonTextView* gobj ()
 Provides access to the underlying C GtkObject.
void set_buffer (const Glib::RefPtr<Gtk::TextBuffer>& buffer)
void set_placeholder (const Glib::ustring& text)
 TextView ()
virtual ~TextView ()

Related Functions

(Note that these are not member functions.)

Hildon::TextViewwrap (HildonTextView* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

virtual Hildon::TextView::~TextView (  )  [virtual]

Reimplemented from Gtk::TextView.

Hildon::TextView::TextView (  ) 

Reimplemented from Gtk::TextView.


Member Function Documentation

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

Reimplemented from Gtk::TextView.

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

Reimplemented from Gtk::TextView.

const HildonTextView* Hildon::TextView::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

HildonTextView* Hildon::TextView::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

void Hildon::TextView::set_buffer ( const Glib::RefPtr< Gtk::TextBuffer > &  buffer  ) 

Reimplemented from Gtk::TextView.

void Hildon::TextView::set_placeholder ( const Glib::ustring 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:

Generated for hildonmm by Doxygen 1.5.6 © 1997-2001