libgnomecanvasmm
Public Types | Public Member Functions | Protected Member Functions | Related Functions

Gnome::Canvas::RichText Class Reference

#include <rich-text.h>

Inheritance diagram for Gnome::Canvas::RichText:
Gnome::Canvas::Item Object

List of all members.

Public Types

typedef Gtk::TextIter iterator

Public Member Functions

virtual ~RichText ()
GnomeCanvasRichText * gobj ()
 Provides access to the underlying C GtkObject.
const GnomeCanvasRichText * gobj () const
 Provides access to the underlying C GtkObject.
 RichText (Group &parent, double x, double y, const Glib::ustring &text)
 RichText (Group &parent)
void cut_clipboard ()
void copy_clipboard ()
void paste_clipboard ()
void set_buffer (const Glib::RefPtr< Gtk::TextBuffer > &buffer)
Glib::RefPtr< Gtk::TextBuffer > get_buffer () const
void get_iter_location (const iterator &iter, Gdk::Rectangle &location) const
iterator get_iter_at_location (int x, int y) const
Glib::SignalProxy1< void,
const Glib::RefPtr
< Gtk::TextTag > & > 
signal_tag_changed ()
Glib::PropertyProxy
< Glib::ustring > 
property_text ()
 Text to display.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_text () const
 Text to display.
Glib::PropertyProxy< double > property_x ()
 X position.
Glib::PropertyProxy_ReadOnly
< double > 
property_x () const
 X position.
Glib::PropertyProxy< double > property_y ()
 Y position.
Glib::PropertyProxy_ReadOnly
< double > 
property_y () const
 Y position.
Glib::PropertyProxy< double > property_width ()
 Width for text box.
Glib::PropertyProxy_ReadOnly
< double > 
property_width () const
 Width for text box.
Glib::PropertyProxy< double > property_height ()
 Height for text box.
Glib::PropertyProxy_ReadOnly
< double > 
property_height () const
 Height for text box.
Glib::PropertyProxy< bool > property_editable ()
 Is this rich text item editable?.
Glib::PropertyProxy_ReadOnly
< bool > 
property_editable () const
 Is this rich text item editable?.
Glib::PropertyProxy< bool > property_visible ()
 Is this rich text item visible?.
Glib::PropertyProxy_ReadOnly
< bool > 
property_visible () const
 Is this rich text item visible?.
Glib::PropertyProxy< bool > property_cursor_visible ()
 Is the cursor visible in this rich text item?.
Glib::PropertyProxy_ReadOnly
< bool > 
property_cursor_visible () const
 Is the cursor visible in this rich text item?.
Glib::PropertyProxy< bool > property_cursor_blink ()
 Does the cursor blink in this rich text item?.
Glib::PropertyProxy_ReadOnly
< bool > 
property_cursor_blink () const
 Does the cursor blink in this rich text item?.
Glib::PropertyProxy< bool > property_grow_height ()
 Should the text box height grow if the text does not fit?.
Glib::PropertyProxy_ReadOnly
< bool > 
property_grow_height () const
 Should the text box height grow if the text does not fit?.
Glib::PropertyProxy
< Gtk::WrapMode > 
property_wrap_mode ()
 Wrap mode for multiline text.
Glib::PropertyProxy_ReadOnly
< Gtk::WrapMode > 
property_wrap_mode () const
 Wrap mode for multiline text.
Glib::PropertyProxy
< Gtk::Justification > 
property_justification ()
 Justification mode.
Glib::PropertyProxy_ReadOnly
< Gtk::Justification > 
property_justification () const
 Justification mode.
Glib::PropertyProxy
< Gtk::DirectionType > 
property_direction ()
 Text direction.
Glib::PropertyProxy_ReadOnly
< Gtk::DirectionType > 
property_direction () const
 Text direction.
Glib::PropertyProxy
< Gtk::AnchorType > 
property_anchor ()
 Anchor point for text.
Glib::PropertyProxy_ReadOnly
< Gtk::AnchorType > 
property_anchor () const
 Anchor point for text.
Glib::PropertyProxy< int > property_pixels_above_lines ()
 Number of pixels to put above lines.
Glib::PropertyProxy_ReadOnly< int > property_pixels_above_lines () const
 Number of pixels to put above lines.
Glib::PropertyProxy< int > property_pixels_below_lines ()
 Number of pixels to put below lines.
Glib::PropertyProxy_ReadOnly< int > property_pixels_below_lines () const
 Number of pixels to put below lines.
Glib::PropertyProxy< int > property_pixels_inside_wrap ()
 Number of pixels to put inside the wrap.
Glib::PropertyProxy_ReadOnly< int > property_pixels_inside_wrap () const
 Number of pixels to put inside the wrap.
Glib::PropertyProxy< int > property_left_margin ()
 Number of pixels in the left margin.
Glib::PropertyProxy_ReadOnly< int > property_left_margin () const
 Number of pixels in the left margin.
Glib::PropertyProxy< int > property_right_margin ()
 Number of pixels in the right margin.
Glib::PropertyProxy_ReadOnly< int > property_right_margin () const
 Number of pixels in the right margin.
Glib::PropertyProxy< int > property_indent ()
 Number of pixels for indentation.
Glib::PropertyProxy_ReadOnly< int > property_indent () const
 Number of pixels for indentation.

Protected Member Functions

virtual void on_tag_changed (const Glib::RefPtr< Gtk::TextTag > &tag)

Related Functions

(Note that these are not member functions.)
Gnome::Canvas::RichTextwrap (GnomeCanvasRichText *object, bool take_copy=false)
 A Glib::wrap() method for this object.

Member Typedef Documentation

typedef Gtk::TextIter Gnome::Canvas::RichText::iterator

Constructor & Destructor Documentation

virtual Gnome::Canvas::RichText::~RichText ( ) [virtual]
Gnome::Canvas::RichText::RichText ( Group parent,
double  x,
double  y,
const Glib::ustring &  text 
)
Gnome::Canvas::RichText::RichText ( Group parent) [explicit]

Member Function Documentation

void Gnome::Canvas::RichText::copy_clipboard ( )
void Gnome::Canvas::RichText::cut_clipboard ( )
Glib::RefPtr<Gtk::TextBuffer> Gnome::Canvas::RichText::get_buffer ( ) const
iterator Gnome::Canvas::RichText::get_iter_at_location ( int  x,
int  y 
) const
void Gnome::Canvas::RichText::get_iter_location ( const iterator iter,
Gdk::Rectangle &  location 
) const
const GnomeCanvasRichText* Gnome::Canvas::RichText::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gnome::Canvas::Item.

GnomeCanvasRichText* Gnome::Canvas::RichText::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gnome::Canvas::Item.

virtual void Gnome::Canvas::RichText::on_tag_changed ( const Glib::RefPtr< Gtk::TextTag > &  tag) [protected, virtual]
void Gnome::Canvas::RichText::paste_clipboard ( )
Glib::PropertyProxy<Gtk::AnchorType> Gnome::Canvas::RichText::property_anchor ( )

Anchor point for text.

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<Gtk::AnchorType> Gnome::Canvas::RichText::property_anchor ( ) const

Anchor point for text.

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::Canvas::RichText::property_cursor_blink ( )

Does the cursor blink in this rich text item?.

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::Canvas::RichText::property_cursor_blink ( ) const

Does the cursor blink in this rich text item?.

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::Canvas::RichText::property_cursor_visible ( )

Is the cursor visible in this rich text item?.

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::Canvas::RichText::property_cursor_visible ( ) const

Is the cursor visible in this rich text item?.

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<Gtk::DirectionType> Gnome::Canvas::RichText::property_direction ( )

Text direction.

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<Gtk::DirectionType> Gnome::Canvas::RichText::property_direction ( ) const

Text direction.

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::Canvas::RichText::property_editable ( )

Is this rich text item editable?.

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::Canvas::RichText::property_editable ( ) const

Is this rich text item editable?.

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::Canvas::RichText::property_grow_height ( )

Should the text box height grow if the text does not fit?.

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::Canvas::RichText::property_grow_height ( ) const

Should the text box height grow if the text does not fit?.

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<double> Gnome::Canvas::RichText::property_height ( )

Height for text box.

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<double> Gnome::Canvas::RichText::property_height ( ) const

Height for text box.

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<int> Gnome::Canvas::RichText::property_indent ( )

Number of pixels for indentation.

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<int> Gnome::Canvas::RichText::property_indent ( ) const

Number of pixels for indentation.

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<Gtk::Justification> Gnome::Canvas::RichText::property_justification ( )

Justification mode.

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<Gtk::Justification> Gnome::Canvas::RichText::property_justification ( ) const

Justification mode.

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<int> Gnome::Canvas::RichText::property_left_margin ( )

Number of pixels in the left margin.

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<int> Gnome::Canvas::RichText::property_left_margin ( ) const

Number of pixels in the left margin.

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<int> Gnome::Canvas::RichText::property_pixels_above_lines ( )

Number of pixels to put above lines.

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<int> Gnome::Canvas::RichText::property_pixels_above_lines ( ) const

Number of pixels to put above lines.

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<int> Gnome::Canvas::RichText::property_pixels_below_lines ( ) const

Number of pixels to put below lines.

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<int> Gnome::Canvas::RichText::property_pixels_below_lines ( )

Number of pixels to put below lines.

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<int> Gnome::Canvas::RichText::property_pixels_inside_wrap ( )

Number of pixels to put inside the wrap.

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<int> Gnome::Canvas::RichText::property_pixels_inside_wrap ( ) const

Number of pixels to put inside the wrap.

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<int> Gnome::Canvas::RichText::property_right_margin ( )

Number of pixels in the right margin.

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<int> Gnome::Canvas::RichText::property_right_margin ( ) const

Number of pixels in the right margin.

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<Glib::ustring> Gnome::Canvas::RichText::property_text ( )

Text to display.

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<Glib::ustring> Gnome::Canvas::RichText::property_text ( ) const

Text to display.

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::Canvas::RichText::property_visible ( )

Is this rich text item visible?.

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::Canvas::RichText::property_visible ( ) const

Is this rich text item visible?.

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<double> Gnome::Canvas::RichText::property_width ( )

Width for text box.

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<double> Gnome::Canvas::RichText::property_width ( ) const

Width for text box.

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<Gtk::WrapMode> Gnome::Canvas::RichText::property_wrap_mode ( )

Wrap mode for multiline text.

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<Gtk::WrapMode> Gnome::Canvas::RichText::property_wrap_mode ( ) const

Wrap mode for multiline text.

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<double> Gnome::Canvas::RichText::property_x ( ) const

X position.

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<double> Gnome::Canvas::RichText::property_x ( )

X position.

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<double> Gnome::Canvas::RichText::property_y ( )

Y position.

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<double> Gnome::Canvas::RichText::property_y ( ) const

Y position.

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::Canvas::RichText::set_buffer ( const Glib::RefPtr< Gtk::TextBuffer > &  buffer)
Glib::SignalProxy1< void,const Glib::RefPtr<Gtk::TextTag>& > Gnome::Canvas::RichText::signal_tag_changed ( )
Prototype:
void on_my_tag_changed(const Glib::RefPtr<Gtk::TextTag>& tag)

Friends And Related Function Documentation

Gnome::Canvas::RichText * wrap ( GnomeCanvasRichText *  object,
bool  take_copy = false 
) [related]

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

Parameters:
objectThe C instance.
take_copyFalse 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: