libgnomecanvasmm
Public Types | Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gnome::Canvas::RichText Class Reference

#include <rich-text.h>

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

Public Types

typedef Gtk::TextIter iterator
 

Public Member Functions

virtual ~RichText ()
 
GnomeCanvasRichText * gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GnomeCanvasRichText * gobj () const
 Provides access to the underlying C GtkObject. More...
 
 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. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_text () const
 Text to display. More...
 
Glib::PropertyProxy< double > property_x ()
 X position. More...
 
Glib::PropertyProxy_ReadOnly
< double > 
property_x () const
 X position. More...
 
Glib::PropertyProxy< double > property_y ()
 Y position. More...
 
Glib::PropertyProxy_ReadOnly
< double > 
property_y () const
 Y position. More...
 
Glib::PropertyProxy< double > property_width ()
 Width for text box. More...
 
Glib::PropertyProxy_ReadOnly
< double > 
property_width () const
 Width for text box. More...
 
Glib::PropertyProxy< double > property_height ()
 Height for text box. More...
 
Glib::PropertyProxy_ReadOnly
< double > 
property_height () const
 Height for text box. More...
 
Glib::PropertyProxy< bool > property_editable ()
 Is this rich text item editable?. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_editable () const
 Is this rich text item editable?. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Is this rich text item visible?. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_visible () const
 Is this rich text item visible?. More...
 
Glib::PropertyProxy< bool > property_cursor_visible ()
 Is the cursor visible in this rich text item?. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_cursor_visible () const
 Is the cursor visible in this rich text item?. More...
 
Glib::PropertyProxy< bool > property_cursor_blink ()
 Does the cursor blink in this rich text item?. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_cursor_blink () const
 Does the cursor blink in this rich text item?. More...
 
Glib::PropertyProxy< bool > property_grow_height ()
 Should the text box height grow if the text does not fit?. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_grow_height () const
 Should the text box height grow if the text does not fit?. More...
 
Glib::PropertyProxy
< Gtk::WrapMode > 
property_wrap_mode ()
 Wrap mode for multiline text. More...
 
Glib::PropertyProxy_ReadOnly
< Gtk::WrapMode > 
property_wrap_mode () const
 Wrap mode for multiline text. More...
 
Glib::PropertyProxy
< Gtk::Justification > 
property_justification ()
 Justification mode. More...
 
Glib::PropertyProxy_ReadOnly
< Gtk::Justification > 
property_justification () const
 Justification mode. More...
 
Glib::PropertyProxy
< Gtk::DirectionType > 
property_direction ()
 Text direction. More...
 
Glib::PropertyProxy_ReadOnly
< Gtk::DirectionType > 
property_direction () const
 Text direction. More...
 
Glib::PropertyProxy
< Gtk::AnchorType > 
property_anchor ()
 Anchor point for text. More...
 
Glib::PropertyProxy_ReadOnly
< Gtk::AnchorType > 
property_anchor () const
 Anchor point for text. More...
 
Glib::PropertyProxy< int > property_pixels_above_lines ()
 Number of pixels to put above lines. More...
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_above_lines () const
 Number of pixels to put above lines. More...
 
Glib::PropertyProxy< int > property_pixels_below_lines ()
 Number of pixels to put below lines. More...
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_below_lines () const
 Number of pixels to put below lines. More...
 
Glib::PropertyProxy< int > property_pixels_inside_wrap ()
 Number of pixels to put inside the wrap. More...
 
Glib::PropertyProxy_ReadOnly< int > property_pixels_inside_wrap () const
 Number of pixels to put inside the wrap. More...
 
Glib::PropertyProxy< int > property_left_margin ()
 Number of pixels in the left margin. More...
 
Glib::PropertyProxy_ReadOnly< int > property_left_margin () const
 Number of pixels in the left margin. More...
 
Glib::PropertyProxy< int > property_right_margin ()
 Number of pixels in the right margin. More...
 
Glib::PropertyProxy_ReadOnly< int > property_right_margin () const
 Number of pixels in the right margin. More...
 
Glib::PropertyProxy< int > property_indent ()
 Number of pixels for indentation. More...
 
Glib::PropertyProxy_ReadOnly< int > property_indent () const
 Number of pixels for indentation. More...
 
- Public Member Functions inherited from Gnome::Canvas::Item
virtual ~Item ()
 
GnomeCanvasItem * gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GnomeCanvasItem * gobj () const
 Provides access to the underlying C GtkObject. More...
 
void move (double dx, double dy)
 Moves a canvas item by creating an affine transformation matrix for translation by using the specified values. More...
 
void raise (int positions)
 Raises the item in its parent's stack by the specified number of positions. More...
 
void lower (int positions)
 Lowers the item in its parent's stack by the specified number of positions. More...
 
void raise_to_top ()
 Raises an item to the top of its parent's stack. More...
 
void lower_to_bottom ()
 Lowers an item to the bottom of its parent's stack. More...
 
int grab (unsigned int event_mask, const Gdk::Cursor &cursor, guint32 etime)
 
int grab (unsigned int event_mask, guint32 etime)
 
void ungrab (guint32 etime)
 Ungrabs the item, which must have been grabbed in the canvas, and ungrabs the mouse. More...
 
void w2i (double &x, double &y)
 Converts a coordinate pair from world coordinates to item-relative coordinates. More...
 
void i2w (double &x, double &y)
 Converts a coordinate pair from item-relative coordinates to world coordinates. More...
 
void grab_focus ()
 Makes the specified item take the keyboard focus, so all keyboard events will be sent to it. More...
 
void get_bounds (double &x1, double &y1, double &x2, double &y2) const
 Queries the bounding box of a canvas item. More...
 
void show ()
 Shows a canvas item. More...
 
void hide ()
 Hides a canvas item. More...
 
void affine_relative (const Art::AffineTrans &affine)
 
void affine_absolute (const Art::AffineTrans &affine)
 
Art::AffineTrans get_i2w_affine () const
 
Art::AffineTrans get_i2c_affine () const
 
void reparent (Group &new_group)
 Changes the parent of the specified item to be the new group. More...
 
Canvasget_canvas () const
 Returns the canvas we're on. More...
 
virtual void update_vfunc (double *affine, ArtSVP *clip_path, int flags)
 
virtual void realize_vfunc ()
 
virtual void unrealize_vfunc ()
 
virtual void map_vfunc ()
 
virtual void unmap_vfunc ()
 
virtual ArtUta * coverage_vfunc ()
 
virtual void draw_vfunc (const Glib::RefPtr< Gdk::Drawable > &drawable, int x, int y, int width, int height)
 
virtual void render_vfunc (GnomeCanvasBuf *buf)
 
virtual double point_vfunc (double x, double y, int cx, int cy, GnomeCanvasItem **actual_item)
 
virtual void bounds_vfunc (double *x1, double *y1, double *x2, double *y2)
 
Glib::SignalProxy1< bool,
GdkEvent * > 
signal_event ()
 
Groupget_parent_group ()
 
const Groupget_parent_group () const
 
Glib::PropertyProxy< Group * > property_parent ()
 You rarely need to use properties because there are get_ and set_ methods for almost all of them. More...
 
Glib::PropertyProxy_ReadOnly
< Group * > 
property_parent () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them. More...
 

Protected Member Functions

virtual void on_tag_changed (const Glib::RefPtr< Gtk::TextTag > &tag)
 
- Protected Member Functions inherited from Gnome::Canvas::Item
virtual bool on_event (GdkEvent *p1)
 
void item_construct (Group &group)
 
void item_construct (Group &group, const gchar *first_arg_name, va_list ap)
 
void set (const gchar *first_arg_name,...)
 
void request_update ()
 To be used only by item implementations. More...
 
void reset_bounds ()
 Resets the bounding box of a canvas item to an empty rectangle. More...
 
void update_svp (ArtSVP **p_svp, ArtSVP *new_svp)
 Sets the svp to the new value, requesting repaint on what's changed. More...
 
void update_svp_clip (ArtSVP **p_svp, ArtSVP *new_svp, ArtSVP *clip_svp)
 Sets the svp to the new value, clipping if necessary, and requesting repaint on what's changed. More...
 
void request_redraw_svp (const ArtSVP *svp)
 Request redraw of the svp if in aa mode, or the entire item in in xlib mode. More...
 
void update_bbox (int x1, int y1, int x2, int y2)
 Sets the bbox to the new value, requesting full repaint. More...
 

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. More...
 

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
GnomeCanvasRichText* Gnome::Canvas::RichText::gobj ( )
inline

Provides access to the underlying C GtkObject.

const GnomeCanvasRichText* Gnome::Canvas::RichText::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

virtual void Gnome::Canvas::RichText::on_tag_changed ( const Glib::RefPtr< Gtk::TextTag > &  tag)
protectedvirtual
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<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_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_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<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_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_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: