RtEditor - Rich text editor which uses a subset of the txt2tags markup. More...

#include <libgda-uimm/rteditor.h>

Inheritance diagram for Gnome::GdaUI::RtEditor:

List of all members.

Public Member Functions
virtual	~RtEditor ()
GdauiRtEditor*	gobj ()
	Provides access to the underlying C GtkObject.
const GdauiRtEditor*	gobj () const
	Provides access to the underlying C GtkObject.
	RtEditor ()
	Creates a new Gdaui::RtEditor widget.
Glib::ustring	get_contents () const
	Get the contents of editor, using the markup syntax.
void	set_contents (const Glib::ustring& markup, int length=-1)
	Set editor's contents.
void	set_editable (bool editable)
	Set editor's editability.
Glib::SignalProxy0< void >	signal_changed ()
Glib::PropertyProxy_ReadOnly < Glib::RefPtr < Gtk::TextBuffer > >	property_buffer () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_in_scrolled_window ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_in_scrolled_window () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_no_background ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_no_background () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_show_markup ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_show_markup () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Protected Member Functions
virtual void	on_changed ()
Related Functions
(Note that these are not member functions.)
Gnome::GdaUI::RtEditor*	wrap (GdauiRtEditor* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

RtEditor - Rich text editor which uses a subset of the txt2tags markup.

The text entered in the editor can be formatted using bold, underline, title, ... attributes and then extracted using a subset of the txt2tags markup. Use this widget to edit textual fields where some markup is desirable to organize the text.

---

Constructor & Destructor Documentation

virtual Gnome::GdaUI::RtEditor::~RtEditor

(

)

[virtual]

Gnome::GdaUI::RtEditor::RtEditor

(

)

Creates a new Gdaui::RtEditor widget.

Since libgda-uimm 4.2:

.2

Returns:

The new widget.

---

Member Function Documentation

Glib::ustring Gnome::GdaUI::RtEditor::get_contents

(

)

const

Get the contents of editor, using the markup syntax.

Since libgda-uimm 4.2:

.2

Returns:

A new string, or 0 if there was an error.

GdauiRtEditor* Gnome::GdaUI::RtEditor::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

const GdauiRtEditor* Gnome::GdaUI::RtEditor::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

virtual void Gnome::GdaUI::RtEditor::on_changed

(

)

[protected, virtual]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gtk::TextBuffer> > Gnome::GdaUI::RtEditor::property_buffer

(

)

const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::GdaUI::RtEditor::property_in_scrolled_window

(

)

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gnome::GdaUI::RtEditor::property_in_scrolled_window

(

)

const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::GdaUI::RtEditor::property_no_background

(

)

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gnome::GdaUI::RtEditor::property_no_background

(

)

const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::GdaUI::RtEditor::property_show_markup

(

)

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gnome::GdaUI::RtEditor::property_show_markup

(

)

const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:

A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gnome::GdaUI::RtEditor::set_contents	(	const Glib::ustring &	markup,
		int	length = -1
	)

Set editor's contents.

If length is -1, markup must be nul-terminated

Since libgda-uimm 4.2:

.2

Parameters:

markup	The text to set in editor, using the markup syntax (must be valid UTF-8).
length	Length of text in bytes.

void Gnome::GdaUI::RtEditor::set_editable

(

bool

editable

)

Set editor's editability.

Since libgda-uimm 4.2:

.2

Parameters:

editable

Whether it's editable.

Glib::SignalProxy0< void > Gnome::GdaUI::RtEditor::signal_changed

(

)

Prototype:

void on_my_changed()

---

Friends And Related Function Documentation

Gnome::GdaUI::RtEditor* wrap	(	GdauiRtEditor *	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.