Hildon::Entry Class Reference
[Widgets]

A text entry widget. More...

Inheritance diagram for Hildon::Entry:

[legend]

List of all members.

Public Member Functions
virtual	~Entry ()
HildonEntry*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonEntry*	gobj () const
	Provides access to the underlying C GtkObject.
	Entry (Gtk::Hildon::SizeType size)
void	set_text (const Glib::ustring& text)
	Sets the text in entry to text, replacing its current contents.
Glib::ustring	get_text () const
	Gets the current text in entry.
void	set_placeholder (const Glib::ustring& text)
	Sets the placeholder text in entry to text.
Related Functions
(Note that these are not member functions.)
Hildon::Entry*	wrap (HildonEntry* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A text entry widget.

Hildon::Entry is a text entry. It is derived from Gtk::Entry and provides additional commodities specific to the Hildon framework.

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

Although Hildon::Entry is derived from Gtk::Entry, Gtk::Entry::get_text() and Gtk::Entry::set_text() must never be used to get/set the text in this widget. Hildon::Entry::get_text() and Hildon::Entry::set_text() must be used instead.

---

Constructor& Destructor Documentation

virtual Hildon::Entry::~Entry

(

)

[virtual]

Reimplemented from Gtk::Entry.

Hildon::Entry::Entry

(

Gtk::Hildon::SizeType

size

)

[explicit]

---

Member Function Documentation

HildonEntry* Hildon::Entry::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Entry.

const HildonEntry* Hildon::Entry::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Entry.

void Hildon::Entry::set_text

(

const Glib::ustring &

text

)

Sets the text in entry to text, replacing its current contents.

Note that you must never use gtk_entry_set_text() to set the text of a Hildon::Entry.

Parameters:

text

The new text.

Reimplemented from Gtk::Entry.

Glib::ustring Hildon::Entry::get_text

(

)

const

Gets the current text in entry.

Note that you must never use gtk_entry_get_text() to get the text from a Hildon::Entry.

Also note that placeholder text (set using set_placeholder()) is never returned. Only text set by set_text() or typed by the user is considered.

Returns:

The text in entry. This text must not be modified or freed.

.

Reimplemented from Gtk::Entry.

void Hildon::Entry::set_placeholder

(

const Glib::ustring &

text

)

Sets the placeholder text in entry to text.

Parameters:

text

The new text.

---

Friends And Related Function Documentation

Hildon::Entry* wrap	(	HildonEntry *	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:

• entry.h