GnomeCanvasRichText

GnomeCanvasRichText — Rich text canvas item

Synopsis


#include <libgnomecanvas/libgnomecanvas.h>


struct      GnomeCanvasRichText;
void        gnome_canvas_rich_text_cut_clipboard
                                            (GnomeCanvasRichText *text);
void        gnome_canvas_rich_text_copy_clipboard
                                            (GnomeCanvasRichText *text);
void        gnome_canvas_rich_text_paste_clipboard
                                            (GnomeCanvasRichText *text);
void        gnome_canvas_rich_text_set_buffer
                                            (GnomeCanvasRichText *text,
                                             GtkTextBuffer *buffer);
GtkTextBuffer* gnome_canvas_rich_text_get_buffer
                                            (GnomeCanvasRichText *text);
void        gnome_canvas_rich_text_get_iter_location
                                            (GnomeCanvasRichText *text,
                                             const GtkTextIter *iter,
                                             GdkRectangle *location);
void        gnome_canvas_rich_text_get_iter_at_location
                                            (GnomeCanvasRichText *text,
                                             GtkTextIter *iter,
                                             gint x,
                                             gint y);

Object Hierarchy


  GObject
   +----GtkObject
         +----GnomeCanvasItem
               +----GnomeCanvasRichText

Properties


  "anchor"               GtkAnchorType        : Read / Write
  "cursor-blink"         gboolean             : Read / Write
  "cursor-visible"       gboolean             : Read / Write
  "direction"            GtkDirectionType     : Read / Write
  "editable"             gboolean             : Read / Write
  "grow-height"          gboolean             : Read / Write
  "height"               gdouble              : Read / Write
  "indent"               gint                 : Read / Write
  "justification"        GtkJustification     : Read / Write
  "left-margin"          gint                 : Read / Write
  "pixels-above-lines"   gint                 : Read / Write
  "pixels-below-lines"   gint                 : Read / Write
  "pixels-inside-wrap"   gint                 : Read / Write
  "right-margin"         gint                 : Read / Write
  "text"                 gchararray           : Read / Write
  "visible"              gboolean             : Read / Write
  "width"                gdouble              : Read / Write
  "wrap-mode"            GtkWrapMode          : Read / Write
  "x"                    gdouble              : Read / Write
  "y"                    gdouble              : Read / Write

Signal Prototypes


"tag-changed"
            void        user_function      (GnomeCanvasRichText *canvasrichtext,
                                            GObject *arg1,
                                            gpointer user_data);

Description

A canvas item that displays a GtkTextBuffer which is a flexible text display and editing widget. Consult GtkTextBuffer info in the GTK+ Reference documentation for more details.

Details

struct GnomeCanvasRichText

struct GnomeCanvasRichText;

This structure should not be accessed directly. Use the object's properties and functions for querying or changing its parameters.


gnome_canvas_rich_text_cut_clipboard ()

void        gnome_canvas_rich_text_cut_clipboard
                                            (GnomeCanvasRichText *text);

text :

gnome_canvas_rich_text_copy_clipboard ()

void        gnome_canvas_rich_text_copy_clipboard
                                            (GnomeCanvasRichText *text);

text :

gnome_canvas_rich_text_paste_clipboard ()

void        gnome_canvas_rich_text_paste_clipboard
                                            (GnomeCanvasRichText *text);

text :

gnome_canvas_rich_text_set_buffer ()

void        gnome_canvas_rich_text_set_buffer
                                            (GnomeCanvasRichText *text,
                                             GtkTextBuffer *buffer);

text :
buffer :

gnome_canvas_rich_text_get_buffer ()

GtkTextBuffer* gnome_canvas_rich_text_get_buffer
                                            (GnomeCanvasRichText *text);

text :
Returns :

gnome_canvas_rich_text_get_iter_location ()

void        gnome_canvas_rich_text_get_iter_location
                                            (GnomeCanvasRichText *text,
                                             const GtkTextIter *iter,
                                             GdkRectangle *location);

text :
iter :
location :

gnome_canvas_rich_text_get_iter_at_location ()

void        gnome_canvas_rich_text_get_iter_at_location
                                            (GnomeCanvasRichText *text,
                                             GtkTextIter *iter,
                                             gint x,
                                             gint y);

text :
iter :
x :
y :

Properties

"anchor" (GtkAnchorType : Read / Write)

Anchor point for text.

"cursor-blink" (gboolean : Read / Write)

Does the cursor blink in this rich text item?

"cursor-visible" (gboolean : Read / Write)

Is the cursor visible?

"direction" (GtkDirectionType : Read / Write)

Direction of displayed rich text.

"editable" (gboolean : Read / Write)

Is this rich text item editable?

"grow-height" (gboolean : Read / Write)

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

"height" (gdouble : Read / Write)

Height for text box.

"indent" (gint : Read / Write)

Number of pixels for indentation.

"justification" (GtkJustification : Read / Write)

Justification mode.

"left-margin" (gint : Read / Write)

Number of pixels in the left margin.

"pixels-above-lines" (gint : Read / Write)

Number of pixels to put above lines.

"pixels-below-lines" (gint : Read / Write)

Number of pixels to put below lines.

"pixels-inside-wrap" (gint : Read / Write)

Number of pixels to put inside the wrap.

"right-margin" (gint : Read / Write)

Number of pixels in the right margin.

"text" (gchararray : Read / Write)

Text to display.

"visible" (gboolean : Read / Write)

Is this rich text item visible?

"width" (gdouble : Read / Write)

Width for text box.

"wrap-mode" (GtkWrapMode : Read / Write)

Wrap mode for multiline text.

"x" (gdouble : Read / Write)

X position.

"y" (gdouble : Read / Write)

Y position.

Signals

The "tag-changed" signal

void        user_function                  (GnomeCanvasRichText *canvasrichtext,
                                            GObject *arg1,
                                            gpointer user_data);

canvasrichtext :the object which received the signal.
arg1 :
user_data :user data set when the signal handler was connected.