doc/reference/clutter/html/ClutterText.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterText</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Clutter Reference Manual">
   8 <link rel="up" href="ch02.html" title="Base actors">
   9 <link rel="prev" href="ClutterClone.html" title="ClutterClone">
  10 <link rel="next" href="ClutterCairoTexture.html" title="ClutterCairoTexture">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ClutterClone.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Clutter Reference Manual</th>
  21 <td><a accesskey="n" href="ClutterCairoTexture.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterText.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterText.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterText.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterText.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#ClutterText.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="ClutterText"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  41 <h2><span class="refentrytitle"><a name="ClutterText.top_of_page"></a>ClutterText</span></h2>
  42 <p>ClutterText — An actor for displaying and editing text</p>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  46 <div class="refsynopsisdiv">
  47 <a name="ClutterText.synopsis"></a><h2>Synopsis</h2>
  48 <pre class="synopsis">struct              <a class="link" href="ClutterText.html#ClutterText-struct" title="struct ClutterText">ClutterText</a>;
  49 struct              <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass">ClutterTextClass</a>;
  50 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()">clutter_text_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
  51 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterText.html#clutter-text-new-full" title="clutter_text_new_full ()">clutter_text_new_full</a>               (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
  52                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
  53                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  54 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterText.html#clutter-text-new-with-text" title="clutter_text_new_with_text ()">clutter_text_new_with_text</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
  55                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
  56 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="ClutterText.html#clutter-text-new-with-buffer" title="clutter_text_new_with_buffer ()">clutter_text_new_with_buffer</a>        (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);
  57
  58 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-buffer" title="clutter_text_set_buffer ()">clutter_text_set_buffer</a>             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  59                                                          <em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);
  60 <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> * <a class="link" href="ClutterText.html#clutter-text-get-buffer" title="clutter_text_get_buffer ()">clutter_text_get_buffer</a>             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()">clutter_text_set_text</a>               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  62                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()">clutter_text_set_markup</a>             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  64                                                          <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);
  65 const <span class="returnvalue">gchar</span> *       <a class="link" href="ClutterText.html#clutter-text-get-text" title="clutter_text_get_text ()">clutter_text_get_text</a>               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-activatable" title="clutter_text_set_activatable ()">clutter_text_set_activatable</a>        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  67                                                          <em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);
  68 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-activatable" title="clutter_text_get_activatable ()">clutter_text_get_activatable</a>        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  69 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()">clutter_text_set_attributes</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  70                                                          <em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);
  71 <span class="returnvalue">PangoAttrList</span> *     <a class="link" href="ClutterText.html#clutter-text-get-attributes" title="clutter_text_get_attributes ()">clutter_text_get_attributes</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  72 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()">clutter_text_set_color</a>              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  73                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  74 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-get-color" title="clutter_text_get_color ()">clutter_text_get_color</a>              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  75                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
  76 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()">clutter_text_set_ellipsize</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  77                                                          <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);
  78 <span class="returnvalue">PangoEllipsizeMode</span>  <a class="link" href="ClutterText.html#clutter-text-get-ellipsize" title="clutter_text_get_ellipsize ()">clutter_text_get_ellipsize</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  79 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()">clutter_text_set_font_name</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  80                                                          <em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);
  81 const <span class="returnvalue">gchar</span> *       <a class="link" href="ClutterText.html#clutter-text-get-font-name" title="clutter_text_get_font_name ()">clutter_text_get_font_name</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  82 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-font-description" title="clutter_text_set_font_description ()">clutter_text_set_font_description</a>   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  83                                                          <em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);
  84 <span class="returnvalue">PangoFontDescription</span> * <a class="link" href="ClutterText.html#clutter-text-get-font-description" title="clutter_text_get_font_description ()">clutter_text_get_font_description</a>
  85                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  86 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-password-char" title="clutter_text_set_password_char ()">clutter_text_set_password_char</a>      (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  87                                                          <em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);
  88 <span class="returnvalue">gunichar</span>            <a class="link" href="ClutterText.html#clutter-text-get-password-char" title="clutter_text_get_password_char ()">clutter_text_get_password_char</a>      (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  89 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-justify" title="clutter_text_set_justify ()">clutter_text_set_justify</a>            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  90                                                          <em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);
  91 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-justify" title="clutter_text_get_justify ()">clutter_text_get_justify</a>            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  92 <span class="returnvalue">PangoLayout</span> *       <a class="link" href="ClutterText.html#clutter-text-get-layout" title="clutter_text_get_layout ()">clutter_text_get_layout</a>             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  93 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-line-alignment" title="clutter_text_set_line_alignment ()">clutter_text_set_line_alignment</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  94                                                          <em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);
  95 <span class="returnvalue">PangoAlignment</span>      <a class="link" href="ClutterText.html#clutter-text-get-line-alignment" title="clutter_text_get_line_alignment ()">clutter_text_get_line_alignment</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  96 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()">clutter_text_set_line_wrap</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
  97                                                          <em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);
  98 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-line-wrap" title="clutter_text_get_line_wrap ()">clutter_text_get_line_wrap</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
  99 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-line-wrap-mode" title="clutter_text_set_line_wrap_mode ()">clutter_text_set_line_wrap_mode</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 100                                                          <em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);
 101 <span class="returnvalue">PangoWrapMode</span>       <a class="link" href="ClutterText.html#clutter-text-get-line-wrap-mode" title="clutter_text_get_line_wrap_mode ()">clutter_text_get_line_wrap_mode</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 102 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-max-length" title="clutter_text_set_max_length ()">clutter_text_set_max_length</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 103                                                          <em class="parameter"><code><span class="type">gint</span> max</code></em>);
 104 <span class="returnvalue">gint</span>                <a class="link" href="ClutterText.html#clutter-text-get-max-length" title="clutter_text_get_max_length ()">clutter_text_get_max_length</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 105 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()">clutter_text_set_selectable</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 106                                                          <em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);
 107 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-selectable" title="clutter_text_get_selectable ()">clutter_text_get_selectable</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 108 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-selection" title="clutter_text_set_selection ()">clutter_text_set_selection</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 109                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
 110                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
 111 <span class="returnvalue">gchar</span> *             <a class="link" href="ClutterText.html#clutter-text-get-selection" title="clutter_text_get_selection ()">clutter_text_get_selection</a>          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 112 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-selection-bound" title="clutter_text_set_selection_bound ()">clutter_text_set_selection_bound</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 113                                                          <em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);
 114 <span class="returnvalue">gint</span>                <a class="link" href="ClutterText.html#clutter-text-get-selection-bound" title="clutter_text_get_selection_bound ()">clutter_text_get_selection_bound</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 115 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-single-line-mode" title="clutter_text_set_single_line_mode ()">clutter_text_set_single_line_mode</a>   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 116                                                          <em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);
 117 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-single-line-mode" title="clutter_text_get_single_line_mode ()">clutter_text_get_single_line_mode</a>   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 118 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-use-markup" title="clutter_text_set_use_markup ()">clutter_text_set_use_markup</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 119                                                          <em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);
 120 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-use-markup" title="clutter_text_get_use_markup ()">clutter_text_get_use_markup</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 121
 122 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()">clutter_text_set_editable</a>           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 123                                                          <em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);
 124 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-editable" title="clutter_text_get_editable ()">clutter_text_get_editable</a>           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 125 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-insert-text" title="clutter_text_insert_text ()">clutter_text_insert_text</a>            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 126                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 127                                                          <em class="parameter"><code><span class="type">gssize</span> position</code></em>);
 128 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-insert-unichar" title="clutter_text_insert_unichar ()">clutter_text_insert_unichar</a>         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 129                                                          <em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);
 130 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-delete-chars" title="clutter_text_delete_chars ()">clutter_text_delete_chars</a>           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 131                                                          <em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);
 132 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-delete-text" title="clutter_text_delete_text ()">clutter_text_delete_text</a>            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 133                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
 134                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
 135 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-delete-selection" title="clutter_text_delete_selection ()">clutter_text_delete_selection</a>       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 136 <span class="returnvalue">gchar</span> *             <a class="link" href="ClutterText.html#clutter-text-get-chars" title="clutter_text_get_chars ()">clutter_text_get_chars</a>              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 137                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
 138                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
 139 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-cursor-color" title="clutter_text_set_cursor_color ()">clutter_text_set_cursor_color</a>       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 140                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 141 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-get-cursor-color" title="clutter_text_get_cursor_color ()">clutter_text_get_cursor_color</a>       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 142                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 143 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-selection-color" title="clutter_text_set_selection_color ()">clutter_text_set_selection_color</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 144                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 145 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-get-selection-color" title="clutter_text_get_selection_color ()">clutter_text_get_selection_color</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 146                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 147 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-selected-text-color" title="clutter_text_set_selected_text_color ()">clutter_text_set_selected_text_color</a>
 148                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 149                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 150 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-get-selected-text-color" title="clutter_text_get_selected_text_color ()">clutter_text_get_selected_text_color</a>
 151                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 152                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
 153 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-cursor-position" title="clutter_text_set_cursor_position ()">clutter_text_set_cursor_position</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 154                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>);
 155 <span class="returnvalue">gint</span>                <a class="link" href="ClutterText.html#clutter-text-get-cursor-position" title="clutter_text_get_cursor_position ()">clutter_text_get_cursor_position</a>    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 156 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-cursor-visible" title="clutter_text_set_cursor_visible ()">clutter_text_set_cursor_visible</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 157                                                          <em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);
 158 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-get-cursor-visible" title="clutter_text_get_cursor_visible ()">clutter_text_get_cursor_visible</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 159 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-cursor-size" title="clutter_text_set_cursor_size ()">clutter_text_set_cursor_size</a>        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 160                                                          <em class="parameter"><code><span class="type">gint</span> size</code></em>);
 161 <span class="returnvalue">guint</span>               <a class="link" href="ClutterText.html#clutter-text-get-cursor-size" title="clutter_text_get_cursor_size ()">clutter_text_get_cursor_size</a>        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 162
 163 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-activate" title="clutter_text_activate ()">clutter_text_activate</a>               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
 164 <span class="returnvalue">gint</span>                <a class="link" href="ClutterText.html#clutter-text-coords-to-position" title="clutter_text_coords_to_position ()">clutter_text_coords_to_position</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 165                                                          <em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
 166                                                          <em class="parameter"><code><span class="type">gfloat</span> y</code></em>);
 167 <span class="returnvalue">gboolean</span>            <a class="link" href="ClutterText.html#clutter-text-position-to-coords" title="clutter_text_position_to_coords ()">clutter_text_position_to_coords</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 168                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>,
 169                                                          <em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
 170                                                          <em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
 171                                                          <em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);
 172 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-set-preedit-string" title="clutter_text_set_preedit_string ()">clutter_text_set_preedit_string</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 173                                                          <em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
 174                                                          <em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
 175                                                          <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);
 176 <span class="returnvalue">void</span>                <a class="link" href="ClutterText.html#clutter-text-get-layout-offsets" title="clutter_text_get_layout_offsets ()">clutter_text_get_layout_offsets</a>     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 177                                                          <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
 178                                                          <em class="parameter"><code><span class="type">gint</span> *y</code></em>);
 179 </pre>
 180 </div>
 181 <div class="refsect1">
 182 <a name="ClutterText.object-hierarchy"></a><h2>Object Hierarchy</h2>
 183 <pre class="synopsis">
 184   GObject
 185    +----GInitiallyUnowned
 186          +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
 187                +----ClutterText
 188 </pre>
 189 </div>
 190 <div class="refsect1">
 191 <a name="ClutterText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 192 <p>
 193 ClutterText implements
 194  <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
 195 </div>
 196 <div class="refsect1">
 197 <a name="ClutterText.properties"></a><h2>Properties</h2>
 198 <pre class="synopsis">
 199   "<a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'>activatable</a>"              <span class="type">gboolean</span>              : Read / Write
 200   "<a class="link" href="ClutterText.html#ClutterText--attributes" title='The "attributes" property'>attributes</a>"               <span class="type">PangoAttrList</span>*        : Read / Write
 201   "<a class="link" href="ClutterText.html#ClutterText--buffer" title='The "buffer" property'>buffer</a>"                   <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>*    : Read / Write
 202   "<a class="link" href="ClutterText.html#ClutterText--color" title='The "color" property'>color</a>"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 203   "<a class="link" href="ClutterText.html#ClutterText--cursor-color" title='The "cursor-color" property'>cursor-color</a>"             <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 204   "<a class="link" href="ClutterText.html#ClutterText--cursor-color-set" title='The "cursor-color-set" property'>cursor-color-set</a>"         <span class="type">gboolean</span>              : Read
 205   "<a class="link" href="ClutterText.html#ClutterText--cursor-size" title='The "cursor-size" property'>cursor-size</a>"              <span class="type">gint</span>                  : Read / Write
 206   "<a class="link" href="ClutterText.html#ClutterText--cursor-visible" title='The "cursor-visible" property'>cursor-visible</a>"           <span class="type">gboolean</span>              : Read / Write
 207   "<a class="link" href="ClutterText.html#ClutterText--editable" title='The "editable" property'>editable</a>"                 <span class="type">gboolean</span>              : Read / Write
 208   "<a class="link" href="ClutterText.html#ClutterText--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <span class="type">PangoEllipsizeMode</span>    : Read / Write
 209   "<a class="link" href="ClutterText.html#ClutterText--font-description" title='The "font-description" property'>font-description</a>"         <span class="type">PangoFontDescription</span>*  : Read / Write
 210   "<a class="link" href="ClutterText.html#ClutterText--font-name" title='The "font-name" property'>font-name</a>"                <span class="type">gchar</span>*                : Read / Write
 211   "<a class="link" href="ClutterText.html#ClutterText--justify" title='The "justify" property'>justify</a>"                  <span class="type">gboolean</span>              : Read / Write
 212   "<a class="link" href="ClutterText.html#ClutterText--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">PangoAlignment</span>        : Read / Write
 213   "<a class="link" href="ClutterText.html#ClutterText--line-wrap" title='The "line-wrap" property'>line-wrap</a>"                <span class="type">gboolean</span>              : Read / Write
 214   "<a class="link" href="ClutterText.html#ClutterText--line-wrap-mode" title='The "line-wrap-mode" property'>line-wrap-mode</a>"           <span class="type">PangoWrapMode</span>         : Read / Write
 215   "<a class="link" href="ClutterText.html#ClutterText--max-length" title='The "max-length" property'>max-length</a>"               <span class="type">gint</span>                  : Read / Write
 216   "<a class="link" href="ClutterText.html#ClutterText--password-char" title='The "password-char" property'>password-char</a>"            <span class="type">guint</span>                 : Read / Write
 217   "<a class="link" href="ClutterText.html#ClutterText--position" title='The "position" property'>position</a>"                 <span class="type">gint</span>                  : Read / Write
 218   "<a class="link" href="ClutterText.html#ClutterText--selectable" title='The "selectable" property'>selectable</a>"               <span class="type">gboolean</span>              : Read / Write
 219   "<a class="link" href="ClutterText.html#ClutterText--selected-text-color" title='The "selected-text-color" property'>selected-text-color</a>"      <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 220   "<a class="link" href="ClutterText.html#ClutterText--selected-text-color-set" title='The "selected-text-color-set" property'>selected-text-color-set</a>"  <span class="type">gboolean</span>              : Read
 221   "<a class="link" href="ClutterText.html#ClutterText--selection-bound" title='The "selection-bound" property'>selection-bound</a>"          <span class="type">gint</span>                  : Read / Write
 222   "<a class="link" href="ClutterText.html#ClutterText--selection-color" title='The "selection-color" property'>selection-color</a>"          <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
 223   "<a class="link" href="ClutterText.html#ClutterText--selection-color-set" title='The "selection-color-set" property'>selection-color-set</a>"      <span class="type">gboolean</span>              : Read
 224   "<a class="link" href="ClutterText.html#ClutterText--single-line-mode" title='The "single-line-mode" property'>single-line-mode</a>"         <span class="type">gboolean</span>              : Read / Write
 225   "<a class="link" href="ClutterText.html#ClutterText--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
 226   "<a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'>use-markup</a>"               <span class="type">gboolean</span>              : Read / Write
 227 </pre>
 228 </div>
 229 <div class="refsect1">
 230 <a name="ClutterText.signals"></a><h2>Signals</h2>
 231 <pre class="synopsis">
 232   "<a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'>activate</a>"                                       : <code class="literal">Run Last</code>
 233   "<a class="link" href="ClutterText.html#ClutterText-cursor-event" title='The "cursor-event" signal'>cursor-event</a>"                                   : <code class="literal">Run Last</code>
 234   "<a class="link" href="ClutterText.html#ClutterText-delete-text" title='The "delete-text" signal'>delete-text</a>"                                    : <code class="literal">Action</code>
 235   "<a class="link" href="ClutterText.html#ClutterText-insert-text" title='The "insert-text" signal'>insert-text</a>"                                    : <code class="literal">Action</code>
 236   "<a class="link" href="ClutterText.html#ClutterText-text-changed" title='The "text-changed" signal'>text-changed</a>"                                   : <code class="literal">Run Last</code>
 237 </pre>
 238 </div>
 239 <div class="refsect1">
 240 <a name="ClutterText.description"></a><h2>Description</h2>
 241 <p>
 242 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is an actor that displays custom text using Pango
 243 as the text rendering engine.
 244 </p>
 245 <p>
 246 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> also allows inline editing of the text if the
 247 actor is set editable using <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.
 248 </p>
 249 <p>
 250 Selection using keyboard or pointers can be enabled using
 251 <a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()"><code class="function">clutter_text_set_selectable()</code></a>.
 252 </p>
 253 <p>
 254 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is available since Clutter 1.0
 255 </p>
 256 </div>
 257 <div class="refsect1">
 258 <a name="ClutterText.details"></a><h2>Details</h2>
 259 <div class="refsect2">
 260 <a name="ClutterText-struct"></a><h3>struct ClutterText</h3>
 261 <pre class="programlisting">struct ClutterText;</pre>
 262 <p>
 263 The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> struct contains only private data.
 264 </p>
 265 <p class="since">Since 1.0</p>
 266 </div>
 267 <hr>
 268 <div class="refsect2">
 269 <a name="ClutterTextClass"></a><h3>struct ClutterTextClass</h3>
 270 <pre class="programlisting">struct ClutterTextClass {
 271   /* signals, not vfuncs */
 272   void (* text_changed) (ClutterText           *self);
 273   void (* activate)     (ClutterText           *self);
 274   void (* cursor_event) (ClutterText           *self,
 275                          const ClutterGeometry *geometry);
 276 };
 277 </pre>
 278 <p>
 279 The <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass"><span class="type">ClutterTextClass</span></a> struct contains only private data.
 280 </p>
 281 <div class="variablelist"><table border="0">
 282 <col align="left" valign="top">
 283 <tbody>
 284 <tr>
 285 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.text-changed"></a>text_changed</code></em> ()</span></p></td>
 286 <td>class handler for the <a class="link" href="ClutterText.html#ClutterText-text-changed" title='The "text-changed" signal'><span class="type">"text-changed"</span></a> signal</td>
 287 </tr>
 288 <tr>
 289 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.activate"></a>activate</code></em> ()</span></p></td>
 290 <td>class handler for the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a> signal</td>
 291 </tr>
 292 <tr>
 293 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.cursor-event"></a>cursor_event</code></em> ()</span></p></td>
 294 <td>class handler for the <a class="link" href="ClutterText.html#ClutterText-cursor-event" title='The "cursor-event" signal'><span class="type">"cursor_event"</span></a> signal</td>
 295 </tr>
 296 </tbody>
 297 </table></div>
 298 <p class="since">Since 1.0</p>
 299 </div>
 300 <hr>
 301 <div class="refsect2">
 302 <a name="clutter-text-new"></a><h3>clutter_text_new ()</h3>
 303 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 304 <p>
 305 Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. This actor can be used to
 306 display and edit text.
 307 </p>
 308 <div class="variablelist"><table border="0">
 309 <col align="left" valign="top">
 310 <tbody><tr>
 311 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 312 <td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
 313 </tr></tbody>
 314 </table></div>
 315 <p class="since">Since 1.0</p>
 316 </div>
 317 <hr>
 318 <div class="refsect2">
 319 <a name="clutter-text-new-full"></a><h3>clutter_text_new_full ()</h3>
 320 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_full               (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
 321                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 322                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 323 <p>
 324 Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em> as the font
 325 description; <em class="parameter"><code>text</code></em> will be used to set the contents of the actor;
 326 and <em class="parameter"><code>color</code></em> will be used as the color to render <em class="parameter"><code>text</code></em>.
 327 </p>
 328 <p>
 329 This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
 330 <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a> and
 331 <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.
 332 </p>
 333 <div class="variablelist"><table border="0">
 334 <col align="left" valign="top">
 335 <tbody>
 336 <tr>
 337 <td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
 338 <td>a string with a font description</td>
 339 </tr>
 340 <tr>
 341 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 342 <td>the contents of the actor</td>
 343 </tr>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 346 <td>the color to be used to render <em class="parameter"><code>text</code></em>
 347 </td>
 348 </tr>
 349 <tr>
 350 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 351 <td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
 352 </tr>
 353 </tbody>
 354 </table></div>
 355 <p class="since">Since 1.0</p>
 356 </div>
 357 <hr>
 358 <div class="refsect2">
 359 <a name="clutter-text-new-with-text"></a><h3>clutter_text_new_with_text ()</h3>
 360 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_with_text          (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
 361                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 362 <p>
 363 Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em> as the font
 364 description; <em class="parameter"><code>text</code></em> will be used to set the contents of the actor.
 365 </p>
 366 <p>
 367 This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
 368 <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, and <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a>.
 369 </p>
 370 <div class="variablelist"><table border="0">
 371 <col align="left" valign="top">
 372 <tbody>
 373 <tr>
 374 <td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
 375 <td>a string with a font description. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 376 </td>
 377 </tr>
 378 <tr>
 379 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 380 <td>the contents of the actor</td>
 381 </tr>
 382 <tr>
 383 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 384 <td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
 385 </tr>
 386 </tbody>
 387 </table></div>
 388 <p class="since">Since 1.0</p>
 389 </div>
 390 <hr>
 391 <div class="refsect2">
 392 <a name="clutter-text-new-with-buffer"></a><h3>clutter_text_new_with_buffer ()</h3>
 393 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_with_buffer        (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
 394 <p>
 395 Creates a new entry with the specified text buffer.
 396 </p>
 397 <div class="variablelist"><table border="0">
 398 <col align="left" valign="top">
 399 <tbody>
 400 <tr>
 401 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 402 <td>The buffer to use for the new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</td>
 403 </tr>
 404 <tr>
 405 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 406 <td>a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 407 </td>
 408 </tr>
 409 </tbody>
 410 </table></div>
 411 <p class="since">Since 1.10</p>
 412 </div>
 413 <hr>
 414 <div class="refsect2">
 415 <a name="clutter-text-set-buffer"></a><h3>clutter_text_set_buffer ()</h3>
 416 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_buffer             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 417                                                          <em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
 418 <p>
 419 Set the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
 420 this widget.
 421 </p>
 422 <div class="variablelist"><table border="0">
 423 <col align="left" valign="top">
 424 <tbody>
 425 <tr>
 426 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 427 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 428 </td>
 429 </tr>
 430 <tr>
 431 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 432 <td>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>
 433 </td>
 434 </tr>
 435 </tbody>
 436 </table></div>
 437 <p class="since">Since 1.10</p>
 438 </div>
 439 <hr>
 440 <div class="refsect2">
 441 <a name="clutter-text-get-buffer"></a><h3>clutter_text_get_buffer ()</h3>
 442 <pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> * clutter_text_get_buffer             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 443 <p>
 444 Get the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
 445 this widget.
 446 </p>
 447 <div class="variablelist"><table border="0">
 448 <col align="left" valign="top">
 449 <tbody>
 450 <tr>
 451 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 452 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 453 </td>
 454 </tr>
 455 <tr>
 456 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 457 <td>A <span class="type">GtkEntryBuffer</span> object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 458 </td>
 459 </tr>
 460 </tbody>
 461 </table></div>
 462 <p class="since">Since 1.10</p>
 463 </div>
 464 <hr>
 465 <div class="refsect2">
 466 <a name="clutter-text-set-text"></a><h3>clutter_text_set_text ()</h3>
 467 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_text               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 468                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 469 <p>
 470 Sets the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
 471 </p>
 472 <p>
 473 If the <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a> property was set to <code class="literal">TRUE</code> it
 474 will be reset to <code class="literal">FALSE</code> as a side effect. If you want to
 475 maintain the <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a> you should use the
 476 <a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()"><code class="function">clutter_text_set_markup()</code></a> function instead
 477 </p>
 478 <div class="variablelist"><table border="0">
 479 <col align="left" valign="top">
 480 <tbody>
 481 <tr>
 482 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 483 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 484 </td>
 485 </tr>
 486 <tr>
 487 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 488 <td>the text to set. Passing <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is the same
 489 as passing "" (the empty string). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 490 </td>
 491 </tr>
 492 </tbody>
 493 </table></div>
 494 <p class="since">Since 1.0</p>
 495 </div>
 496 <hr>
 497 <div class="refsect2">
 498 <a name="clutter-text-set-markup"></a><h3>clutter_text_set_markup ()</h3>
 499 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_markup             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 500                                                          <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);</pre>
 501 <p>
 502 Sets <em class="parameter"><code>markup</code></em> as the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
 503 </p>
 504 <p>
 505 This is a convenience function for setting a string containing
 506 Pango markup, and it is logically equivalent to:
 507 </p>
 508 <p>
 509 </p>
 510 <div class="informalexample">
 511   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 512     <tbody>
 513       <tr>
 514         <td class="listing_lines" align="right"><pre>1
 515 2
 516 3</pre></td>
 517         <td class="listing_code"><pre class="programlisting"><span class="comment">/* the order is important */</span>
 518 <span class="function"><a href="ClutterText.html#clutter-text-set-text">clutter_text_set_text</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> markup</span><span class="symbol">);</span>
 519 <span class="function"><a href="ClutterText.html#clutter-text-set-use-markup">clutter_text_set_use_markup</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> TRUE</span><span class="symbol">);</span></pre></td>
 520       </tr>
 521     </tbody>
 522   </table>
 523 </div>
 524
 525 <p>
 526 </p>
 527 <div class="variablelist"><table border="0">
 528 <col align="left" valign="top">
 529 <tbody>
 530 <tr>
 531 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 532 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 533 </td>
 534 </tr>
 535 <tr>
 536 <td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
 537 <td>a string containing Pango markup.
 538 Passing <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is the same as passing "" (the empty string). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 539 </td>
 540 </tr>
 541 </tbody>
 542 </table></div>
 543 <p class="since">Since 1.0</p>
 544 </div>
 545 <hr>
 546 <div class="refsect2">
 547 <a name="clutter-text-get-text"></a><h3>clutter_text_get_text ()</h3>
 548 <pre class="programlisting">const <span class="returnvalue">gchar</span> *       clutter_text_get_text               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 549 <p>
 550 Retrieves a pointer to the current contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 551 actor.
 552 </p>
 553 <p>
 554 If you need a copy of the contents for manipulating, either
 555 use <code class="function">g_strdup()</code> on the returned string, or use:
 556 </p>
 557 <p>
 558 </p>
 559 <div class="informalexample">
 560   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 561     <tbody>
 562       <tr>
 563         <td class="listing_lines" align="right"><pre>1</pre></td>
 564         <td class="listing_code"><pre class="programlisting"><span class="normal">copy </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterText.html#clutter-text-get-chars">clutter_text_get_chars</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span></pre></td>
 565       </tr>
 566     </tbody>
 567   </table>
 568 </div>
 569
 570 <p>
 571 </p>
 572 <p>
 573 Which will return a newly allocated string.
 574 </p>
 575 <p>
 576 If the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is empty, this function will return
 577 an empty string, and not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 578 </p>
 579 <div class="variablelist"><table border="0">
 580 <col align="left" valign="top">
 581 <tbody>
 582 <tr>
 583 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 584 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 585 </td>
 586 </tr>
 587 <tr>
 588 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 589 <td>the contents of the actor. The returned
 590 string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should never be modified
 591 or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 592 </td>
 593 </tr>
 594 </tbody>
 595 </table></div>
 596 <p class="since">Since 1.0</p>
 597 </div>
 598 <hr>
 599 <div class="refsect2">
 600 <a name="clutter-text-set-activatable"></a><h3>clutter_text_set_activatable ()</h3>
 601 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_activatable        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 602                                                          <em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);</pre>
 603 <p>
 604 Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable.
 605 </p>
 606 <p>
 607 An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a>
 608 signal whenever the 'Enter' (or 'Return') key is pressed; if it is not
 609 activatable, a new line will be appended to the current content.
 610 </p>
 611 <p>
 612 An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> must also be set as editable using
 613 <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.
 614 </p>
 615 <div class="variablelist"><table border="0">
 616 <col align="left" valign="top">
 617 <tbody>
 618 <tr>
 619 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 620 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 621 </td>
 622 </tr>
 623 <tr>
 624 <td><p><span class="term"><em class="parameter"><code>activatable</code></em> :</span></p></td>
 625 <td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable</td>
 626 </tr>
 627 </tbody>
 628 </table></div>
 629 <p class="since">Since 1.0</p>
 630 </div>
 631 <hr>
 632 <div class="refsect2">
 633 <a name="clutter-text-get-activatable"></a><h3>clutter_text_get_activatable ()</h3>
 634 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_activatable        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 635 <p>
 636 Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is activatable or not.
 637 </p>
 638 <div class="variablelist"><table border="0">
 639 <col align="left" valign="top">
 640 <tbody>
 641 <tr>
 642 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 643 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 644 </td>
 645 </tr>
 646 <tr>
 647 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 648 <td>
 649 <code class="literal">TRUE</code> if the actor is activatable</td>
 650 </tr>
 651 </tbody>
 652 </table></div>
 653 <p class="since">Since 1.0</p>
 654 </div>
 655 <hr>
 656 <div class="refsect2">
 657 <a name="clutter-text-set-attributes"></a><h3>clutter_text_set_attributes ()</h3>
 658 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_attributes         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 659                                                          <em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);</pre>
 660 <p>
 661 Sets the attributes list that are going to be applied to the
 662 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> contents.
 663 </p>
 664 <p>
 665 The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will take a reference on the <span class="type">PangoAttrList</span>
 666 passed to this function.
 667 </p>
 668 <div class="variablelist"><table border="0">
 669 <col align="left" valign="top">
 670 <tbody>
 671 <tr>
 672 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 673 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 674 </td>
 675 </tr>
 676 <tr>
 677 <td><p><span class="term"><em class="parameter"><code>attrs</code></em> :</span></p></td>
 678 <td>a <span class="type">PangoAttrList</span> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset the attributes</td>
 679 </tr>
 680 </tbody>
 681 </table></div>
 682 <p class="since">Since 1.0</p>
 683 </div>
 684 <hr>
 685 <div class="refsect2">
 686 <a name="clutter-text-get-attributes"></a><h3>clutter_text_get_attributes ()</h3>
 687 <pre class="programlisting"><span class="returnvalue">PangoAttrList</span> *     clutter_text_get_attributes         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 688 <p>
 689 Gets the attribute list that was set on the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
 690 <a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()"><code class="function">clutter_text_set_attributes()</code></a>, if any.
 691 </p>
 692 <div class="variablelist"><table border="0">
 693 <col align="left" valign="top">
 694 <tbody>
 695 <tr>
 696 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 697 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 698 </td>
 699 </tr>
 700 <tr>
 701 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 702 <td>the attribute list, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if none was set. The
 703 returned value is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> and should not be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 704 </td>
 705 </tr>
 706 </tbody>
 707 </table></div>
 708 <p class="since">Since 1.0</p>
 709 </div>
 710 <hr>
 711 <div class="refsect2">
 712 <a name="clutter-text-set-color"></a><h3>clutter_text_set_color ()</h3>
 713 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_color              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 714                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 715 <p>
 716 Sets the color of the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
 717 </p>
 718 <p>
 719 The overall opacity of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will be the
 720 result of the alpha value of <em class="parameter"><code>color</code></em> and the composited
 721 opacity of the actor itself on the scenegraph, as returned
 722 by <a class="link" href="ClutterActor.html#clutter-actor-get-paint-opacity" title="clutter_actor_get_paint_opacity ()"><code class="function">clutter_actor_get_paint_opacity()</code></a>.
 723 </p>
 724 <div class="variablelist"><table border="0">
 725 <col align="left" valign="top">
 726 <tbody>
 727 <tr>
 728 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 729 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 730 </td>
 731 </tr>
 732 <tr>
 733 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 734 <td>a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>
 735 </td>
 736 </tr>
 737 </tbody>
 738 </table></div>
 739 <p class="since">Since 1.0</p>
 740 </div>
 741 <hr>
 742 <div class="refsect2">
 743 <a name="clutter-text-get-color"></a><h3>clutter_text_get_color ()</h3>
 744 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_color              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 745                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 746 <p>
 747 Retrieves the text color as set by <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.
 748 </p>
 749 <div class="variablelist"><table border="0">
 750 <col align="left" valign="top">
 751 <tbody>
 752 <tr>
 753 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 754 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 755 </td>
 756 </tr>
 757 <tr>
 758 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 759 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
 760 </td>
 761 </tr>
 762 </tbody>
 763 </table></div>
 764 <p class="since">Since 1.0</p>
 765 </div>
 766 <hr>
 767 <div class="refsect2">
 768 <a name="clutter-text-set-ellipsize"></a><h3>clutter_text_set_ellipsize ()</h3>
 769 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_ellipsize          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 770                                                          <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);</pre>
 771 <p>
 772 Sets the mode used to ellipsize (add an ellipsis: "...") to the
 773 text if there is not enough space to render the entire contents
 774 of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
 775 </p>
 776 <div class="variablelist"><table border="0">
 777 <col align="left" valign="top">
 778 <tbody>
 779 <tr>
 780 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 781 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 782 </td>
 783 </tr>
 784 <tr>
 785 <td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
 786 <td>a <span class="type">PangoEllipsizeMode</span>
 787 </td>
 788 </tr>
 789 </tbody>
 790 </table></div>
 791 <p class="since">Since 1.0</p>
 792 </div>
 793 <hr>
 794 <div class="refsect2">
 795 <a name="clutter-text-get-ellipsize"></a><h3>clutter_text_get_ellipsize ()</h3>
 796 <pre class="programlisting"><span class="returnvalue">PangoEllipsizeMode</span>  clutter_text_get_ellipsize          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 797 <p>
 798 Returns the ellipsizing position of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, as
 799 set by <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()"><code class="function">clutter_text_set_ellipsize()</code></a>.
 800 </p>
 801 <div class="variablelist"><table border="0">
 802 <col align="left" valign="top">
 803 <tbody>
 804 <tr>
 805 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 806 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 807 </td>
 808 </tr>
 809 <tr>
 810 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 811 <td><span class="type">PangoEllipsizeMode</span></td>
 812 </tr>
 813 </tbody>
 814 </table></div>
 815 <p class="since">Since 1.0</p>
 816 </div>
 817 <hr>
 818 <div class="refsect2">
 819 <a name="clutter-text-set-font-name"></a><h3>clutter_text_set_font_name ()</h3>
 820 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_font_name          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 821                                                          <em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
 822 <p>
 823 Sets the font used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The <em class="parameter"><code>font_name</code></em> string
 824 must either be <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, which means that the font name from the
 825 default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will be used; or be something that can
 826 be parsed by the <code class="function">pango_font_description_from_string()</code> function,
 827 like:
 828 </p>
 829 <p>
 830 </p>
 831 <div class="informalexample">
 832   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 833     <tbody>
 834       <tr>
 835         <td class="listing_lines" align="right"><pre>1
 836 2
 837 3</pre></td>
 838         <td class="listing_code"><pre class="programlisting"><span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Sans 10pt"</span><span class="symbol">);</span>
 839 <span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Serif 16px"</span><span class="symbol">);</span>
 840 <span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Helvetica 10"</span><span class="symbol">);</span></pre></td>
 841       </tr>
 842     </tbody>
 843   </table>
 844 </div>
 845
 846 <p>
 847 </p>
 848 <div class="variablelist"><table border="0">
 849 <col align="left" valign="top">
 850 <tbody>
 851 <tr>
 852 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 853 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 854 </td>
 855 </tr>
 856 <tr>
 857 <td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
 858 <td>a font name, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to set the default font name. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 859 </td>
 860 </tr>
 861 </tbody>
 862 </table></div>
 863 <p class="since">Since 1.0</p>
 864 </div>
 865 <hr>
 866 <div class="refsect2">
 867 <a name="clutter-text-get-font-name"></a><h3>clutter_text_get_font_name ()</h3>
 868 <pre class="programlisting">const <span class="returnvalue">gchar</span> *       clutter_text_get_font_name          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 869 <p>
 870 Retrieves the font name as set by <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>.
 871 </p>
 872 <div class="variablelist"><table border="0">
 873 <col align="left" valign="top">
 874 <tbody>
 875 <tr>
 876 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 877 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 878 </td>
 879 </tr>
 880 <tr>
 881 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 882 <td>a string containing the font name. The returned
 883 string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be
 884 modified or freed</td>
 885 </tr>
 886 </tbody>
 887 </table></div>
 888 <p class="since">Since 1.0</p>
 889 </div>
 890 <hr>
 891 <div class="refsect2">
 892 <a name="clutter-text-set-font-description"></a><h3>clutter_text_set_font_description ()</h3>
 893 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_font_description   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 894                                                          <em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);</pre>
 895 <p>
 896 Sets <em class="parameter"><code>font_desc</code></em> as the font description for a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 897 </p>
 898 <p>
 899 The <span class="type">PangoFontDescription</span> is copied by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
 900 so you can safely call <code class="function">pango_font_description_free()</code> on it after
 901 calling this function.
 902 </p>
 903 <div class="variablelist"><table border="0">
 904 <col align="left" valign="top">
 905 <tbody>
 906 <tr>
 907 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 908 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 909 </td>
 910 </tr>
 911 <tr>
 912 <td><p><span class="term"><em class="parameter"><code>font_desc</code></em> :</span></p></td>
 913 <td>a <span class="type">PangoFontDescription</span>
 914 </td>
 915 </tr>
 916 </tbody>
 917 </table></div>
 918 <p class="since">Since 1.2</p>
 919 </div>
 920 <hr>
 921 <div class="refsect2">
 922 <a name="clutter-text-get-font-description"></a><h3>clutter_text_get_font_description ()</h3>
 923 <pre class="programlisting"><span class="returnvalue">PangoFontDescription</span> * clutter_text_get_font_description
 924                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 925 <p>
 926 Retrieves the <span class="type">PangoFontDescription</span> used by <em class="parameter"><code>self</code></em>
 927 </p>
 928 <div class="variablelist"><table border="0">
 929 <col align="left" valign="top">
 930 <tbody>
 931 <tr>
 932 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 933 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 934 </td>
 935 </tr>
 936 <tr>
 937 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 938 <td>a <span class="type">PangoFontDescription</span>. The returned value is owned
 939 by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and it should not be modified or freed</td>
 940 </tr>
 941 </tbody>
 942 </table></div>
 943 <p class="since">Since 1.2</p>
 944 </div>
 945 <hr>
 946 <div class="refsect2">
 947 <a name="clutter-text-set-password-char"></a><h3>clutter_text_set_password_char ()</h3>
 948 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_password_char      (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 949                                                          <em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
 950 <p>
 951 Sets the character to use in place of the actual text in a
 952 password text actor.
 953 </p>
 954 <p>
 955 If <em class="parameter"><code>wc</code></em> is 0 the text will be displayed as it is entered in the
 956 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
 957 </p>
 958 <div class="variablelist"><table border="0">
 959 <col align="left" valign="top">
 960 <tbody>
 961 <tr>
 962 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 963 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 964 </td>
 965 </tr>
 966 <tr>
 967 <td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
 968 <td>a Unicode character, or 0 to unset the password character</td>
 969 </tr>
 970 </tbody>
 971 </table></div>
 972 <p class="since">Since 1.0</p>
 973 </div>
 974 <hr>
 975 <div class="refsect2">
 976 <a name="clutter-text-get-password-char"></a><h3>clutter_text_get_password_char ()</h3>
 977 <pre class="programlisting"><span class="returnvalue">gunichar</span>            clutter_text_get_password_char      (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 978 <p>
 979 Retrieves the character to use in place of the actual text
 980 as set by <a class="link" href="ClutterText.html#clutter-text-set-password-char" title="clutter_text_set_password_char ()"><code class="function">clutter_text_set_password_char()</code></a>.
 981 </p>
 982 <div class="variablelist"><table border="0">
 983 <col align="left" valign="top">
 984 <tbody>
 985 <tr>
 986 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 987 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 988 </td>
 989 </tr>
 990 <tr>
 991 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 992 <td>a Unicode character or 0 if the password
 993 character is not set</td>
 994 </tr>
 995 </tbody>
 996 </table></div>
 997 <p class="since">Since 1.0</p>
 998 </div>
 999 <hr>
1000 <div class="refsect2">
1001 <a name="clutter-text-set-justify"></a><h3>clutter_text_set_justify ()</h3>
1002 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_justify            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1003                                                          <em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);</pre>
1004 <p>
1005 Sets whether the text of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be justified
1006 on both margins. This setting is ignored if Clutter is compiled
1007 against Pango &lt; 1.18.
1008 </p>
1009 <div class="variablelist"><table border="0">
1010 <col align="left" valign="top">
1011 <tbody>
1012 <tr>
1013 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1014 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1015 </td>
1016 </tr>
1017 <tr>
1018 <td><p><span class="term"><em class="parameter"><code>justify</code></em> :</span></p></td>
1019 <td>whether the text should be justified</td>
1020 </tr>
1021 </tbody>
1022 </table></div>
1023 <p class="since">Since 1.0</p>
1024 </div>
1025 <hr>
1026 <div class="refsect2">
1027 <a name="clutter-text-get-justify"></a><h3>clutter_text_get_justify ()</h3>
1028 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_justify            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1029 <p>
1030 Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should justify its contents
1031 on both margins.
1032 </p>
1033 <div class="variablelist"><table border="0">
1034 <col align="left" valign="top">
1035 <tbody>
1036 <tr>
1037 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1038 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1039 </td>
1040 </tr>
1041 <tr>
1042 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1043 <td>
1044 <code class="literal">TRUE</code> if the text should be justified</td>
1045 </tr>
1046 </tbody>
1047 </table></div>
1048 <p class="since">Since 0.6</p>
1049 </div>
1050 <hr>
1051 <div class="refsect2">
1052 <a name="clutter-text-get-layout"></a><h3>clutter_text_get_layout ()</h3>
1053 <pre class="programlisting"><span class="returnvalue">PangoLayout</span> *       clutter_text_get_layout             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1054 <p>
1055 Retrieves the current <span class="type">PangoLayout</span> used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1056 </p>
1057 <div class="variablelist"><table border="0">
1058 <col align="left" valign="top">
1059 <tbody>
1060 <tr>
1061 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1062 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1063 </td>
1064 </tr>
1065 <tr>
1066 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1067 <td>a <span class="type">PangoLayout</span>. The returned object is owned by
1068 the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1069 </td>
1070 </tr>
1071 </tbody>
1072 </table></div>
1073 <p class="since">Since 1.0</p>
1074 </div>
1075 <hr>
1076 <div class="refsect2">
1077 <a name="clutter-text-set-line-alignment"></a><h3>clutter_text_set_line_alignment ()</h3>
1078 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_line_alignment     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1079                                                          <em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);</pre>
1080 <p>
1081 Sets the way that the lines of a wrapped label are aligned with
1082 respect to each other. This does not affect the overall alignment
1083 of the label within its allocated or specified width.
1084 </p>
1085 <p>
1086 To align a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor you should add it to a container
1087 that supports alignment, or use the anchor point.
1088 </p>
1089 <div class="variablelist"><table border="0">
1090 <col align="left" valign="top">
1091 <tbody>
1092 <tr>
1093 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1094 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1095 </td>
1096 </tr>
1097 <tr>
1098 <td><p><span class="term"><em class="parameter"><code>alignment</code></em> :</span></p></td>
1099 <td>A <span class="type">PangoAlignment</span>
1100 </td>
1101 </tr>
1102 </tbody>
1103 </table></div>
1104 <p class="since">Since 1.0</p>
1105 </div>
1106 <hr>
1107 <div class="refsect2">
1108 <a name="clutter-text-get-line-alignment"></a><h3>clutter_text_get_line_alignment ()</h3>
1109 <pre class="programlisting"><span class="returnvalue">PangoAlignment</span>      clutter_text_get_line_alignment     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1110 <p>
1111 Retrieves the alignment of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as set by
1112 <a class="link" href="ClutterText.html#clutter-text-set-line-alignment" title="clutter_text_set_line_alignment ()"><code class="function">clutter_text_set_line_alignment()</code></a>.
1113 </p>
1114 <div class="variablelist"><table border="0">
1115 <col align="left" valign="top">
1116 <tbody>
1117 <tr>
1118 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1119 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1120 </td>
1121 </tr>
1122 <tr>
1123 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1124 <td>a <span class="type">PangoAlignment</span>
1125 </td>
1126 </tr>
1127 </tbody>
1128 </table></div>
1129 <p class="since">Since 1.0</p>
1130 </div>
1131 <hr>
1132 <div class="refsect2">
1133 <a name="clutter-text-set-line-wrap"></a><h3>clutter_text_set_line_wrap ()</h3>
1134 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_line_wrap          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1135                                                          <em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
1136 <p>
1137 Sets whether the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap,
1138 if they don't fit the size assigned to the actor.
1139 </p>
1140 <div class="variablelist"><table border="0">
1141 <col align="left" valign="top">
1142 <tbody>
1143 <tr>
1144 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1145 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1146 </td>
1147 </tr>
1148 <tr>
1149 <td><p><span class="term"><em class="parameter"><code>line_wrap</code></em> :</span></p></td>
1150 <td>whether the contents should wrap</td>
1151 </tr>
1152 </tbody>
1153 </table></div>
1154 <p class="since">Since 1.0</p>
1155 </div>
1156 <hr>
1157 <div class="refsect2">
1158 <a name="clutter-text-get-line-wrap"></a><h3>clutter_text_get_line_wrap ()</h3>
1159 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_line_wrap          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1160 <p>
1161 Retrieves the value set using <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()"><code class="function">clutter_text_set_line_wrap()</code></a>.
1162 </p>
1163 <div class="variablelist"><table border="0">
1164 <col align="left" valign="top">
1165 <tbody>
1166 <tr>
1167 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1168 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1169 </td>
1170 </tr>
1171 <tr>
1172 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1173 <td>
1174 <code class="literal">TRUE</code> if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap
1175 its contents</td>
1176 </tr>
1177 </tbody>
1178 </table></div>
1179 <p class="since">Since 1.0</p>
1180 </div>
1181 <hr>
1182 <div class="refsect2">
1183 <a name="clutter-text-set-line-wrap-mode"></a><h3>clutter_text_set_line_wrap_mode ()</h3>
1184 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_line_wrap_mode     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1185                                                          <em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);</pre>
1186 <p>
1187 If line wrapping is enabled (see <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()"><code class="function">clutter_text_set_line_wrap()</code></a>) this
1188 function controls how the line wrapping is performed. The default is
1189 <code class="literal">PANGO_WRAP_WORD</code> which means wrap on word boundaries.
1190 </p>
1191 <div class="variablelist"><table border="0">
1192 <col align="left" valign="top">
1193 <tbody>
1194 <tr>
1195 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1196 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1197 </td>
1198 </tr>
1199 <tr>
1200 <td><p><span class="term"><em class="parameter"><code>wrap_mode</code></em> :</span></p></td>
1201 <td>the line wrapping mode</td>
1202 </tr>
1203 </tbody>
1204 </table></div>
1205 <p class="since">Since 1.0</p>
1206 </div>
1207 <hr>
1208 <div class="refsect2">
1209 <a name="clutter-text-get-line-wrap-mode"></a><h3>clutter_text_get_line_wrap_mode ()</h3>
1210 <pre class="programlisting"><span class="returnvalue">PangoWrapMode</span>       clutter_text_get_line_wrap_mode     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1211 <p>
1212 Retrieves the line wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1213 </p>
1214 <p>
1215 See <a class="link" href="ClutterText.html#clutter-text-set-line-wrap-mode" title="clutter_text_set_line_wrap_mode ()"><code class="function">clutter_text_set_line_wrap_mode()</code></a>.
1216 </p>
1217 <div class="variablelist"><table border="0">
1218 <col align="left" valign="top">
1219 <tbody>
1220 <tr>
1221 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1222 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1223 </td>
1224 </tr>
1225 <tr>
1226 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1227 <td>the wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1228 </td>
1229 </tr>
1230 </tbody>
1231 </table></div>
1232 <p class="since">Since 1.0</p>
1233 </div>
1234 <hr>
1235 <div class="refsect2">
1236 <a name="clutter-text-set-max-length"></a><h3>clutter_text_set_max_length ()</h3>
1237 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_max_length         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1238                                                          <em class="parameter"><code><span class="type">gint</span> max</code></em>);</pre>
1239 <p>
1240 Sets the maximum allowed length of the contents of the actor. If the
1241 current contents are longer than the given length, then they will be
1242 truncated to fit.
1243 </p>
1244 <div class="variablelist"><table border="0">
1245 <col align="left" valign="top">
1246 <tbody>
1247 <tr>
1248 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1249 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1250 </td>
1251 </tr>
1252 <tr>
1253 <td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
1254 <td>the maximum number of characters allowed in the text actor; 0
1255 to disable or -1 to set the length of the current string</td>
1256 </tr>
1257 </tbody>
1258 </table></div>
1259 <p class="since">Since 1.0</p>
1260 </div>
1261 <hr>
1262 <div class="refsect2">
1263 <a name="clutter-text-get-max-length"></a><h3>clutter_text_get_max_length ()</h3>
1264 <pre class="programlisting"><span class="returnvalue">gint</span>                clutter_text_get_max_length         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1265 <p>
1266 Gets the maximum length of text that can be set into a text actor.
1267 </p>
1268 <p>
1269 See <a class="link" href="ClutterText.html#clutter-text-set-max-length" title="clutter_text_set_max_length ()"><code class="function">clutter_text_set_max_length()</code></a>.
1270 </p>
1271 <div class="variablelist"><table border="0">
1272 <col align="left" valign="top">
1273 <tbody>
1274 <tr>
1275 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1276 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1277 </td>
1278 </tr>
1279 <tr>
1280 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1281 <td>the maximum number of characters.</td>
1282 </tr>
1283 </tbody>
1284 </table></div>
1285 <p class="since">Since 1.0</p>
1286 </div>
1287 <hr>
1288 <div class="refsect2">
1289 <a name="clutter-text-set-selectable"></a><h3>clutter_text_set_selectable ()</h3>
1290 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_selectable         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1291                                                          <em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);</pre>
1292 <p>
1293 Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable.
1294 </p>
1295 <p>
1296 A selectable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will allow selecting its contents using
1297 the pointer or the keyboard.
1298 </p>
1299 <div class="variablelist"><table border="0">
1300 <col align="left" valign="top">
1301 <tbody>
1302 <tr>
1303 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1304 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1305 </td>
1306 </tr>
1307 <tr>
1308 <td><p><span class="term"><em class="parameter"><code>selectable</code></em> :</span></p></td>
1309 <td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable</td>
1310 </tr>
1311 </tbody>
1312 </table></div>
1313 <p class="since">Since 1.0</p>
1314 </div>
1315 <hr>
1316 <div class="refsect2">
1317 <a name="clutter-text-get-selectable"></a><h3>clutter_text_get_selectable ()</h3>
1318 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_selectable         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1319 <p>
1320 Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is selectable or not.
1321 </p>
1322 <div class="variablelist"><table border="0">
1323 <col align="left" valign="top">
1324 <tbody>
1325 <tr>
1326 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1327 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1328 </td>
1329 </tr>
1330 <tr>
1331 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1332 <td>
1333 <code class="literal">TRUE</code> if the actor is selectable</td>
1334 </tr>
1335 </tbody>
1336 </table></div>
1337 <p class="since">Since 1.0</p>
1338 </div>
1339 <hr>
1340 <div class="refsect2">
1341 <a name="clutter-text-set-selection"></a><h3>clutter_text_set_selection ()</h3>
1342 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_selection          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1343                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1344                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1345 <p>
1346 Selects the region of text between <em class="parameter"><code>start_pos</code></em> and <em class="parameter"><code>end_pos</code></em>.
1347 </p>
1348 <p>
1349 This function changes the position of the cursor to match
1350 <em class="parameter"><code>start_pos</code></em> and the selection bound to match <em class="parameter"><code>end_pos</code></em>.
1351 </p>
1352 <div class="variablelist"><table border="0">
1353 <col align="left" valign="top">
1354 <tbody>
1355 <tr>
1356 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1357 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1358 </td>
1359 </tr>
1360 <tr>
1361 <td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1362 <td>start of the selection, in characters</td>
1363 </tr>
1364 <tr>
1365 <td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1366 <td>end of the selection, in characters</td>
1367 </tr>
1368 </tbody>
1369 </table></div>
1370 <p class="since">Since 1.0</p>
1371 </div>
1372 <hr>
1373 <div class="refsect2">
1374 <a name="clutter-text-get-selection"></a><h3>clutter_text_get_selection ()</h3>
1375 <pre class="programlisting"><span class="returnvalue">gchar</span> *             clutter_text_get_selection          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1376 <p>
1377 Retrieves the currently selected text.
1378 </p>
1379 <div class="variablelist"><table border="0">
1380 <col align="left" valign="top">
1381 <tbody>
1382 <tr>
1383 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1384 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1385 </td>
1386 </tr>
1387 <tr>
1388 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1389 <td>a newly allocated string containing the currently
1390 selected text, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. Use <code class="function">g_free()</code> to free the returned
1391 string.</td>
1392 </tr>
1393 </tbody>
1394 </table></div>
1395 <p class="since">Since 1.0</p>
1396 </div>
1397 <hr>
1398 <div class="refsect2">
1399 <a name="clutter-text-set-selection-bound"></a><h3>clutter_text_set_selection_bound ()</h3>
1400 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_selection_bound    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1401                                                          <em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);</pre>
1402 <p>
1403 Sets the other end of the selection, starting from the current
1404 cursor position.
1405 </p>
1406 <p>
1407 If <em class="parameter"><code>selection_bound</code></em> is -1, the selection unset.
1408 </p>
1409 <div class="variablelist"><table border="0">
1410 <col align="left" valign="top">
1411 <tbody>
1412 <tr>
1413 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1414 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1415 </td>
1416 </tr>
1417 <tr>
1418 <td><p><span class="term"><em class="parameter"><code>selection_bound</code></em> :</span></p></td>
1419 <td>the position of the end of the selection, in characters</td>
1420 </tr>
1421 </tbody>
1422 </table></div>
1423 <p class="since">Since 1.0</p>
1424 </div>
1425 <hr>
1426 <div class="refsect2">
1427 <a name="clutter-text-get-selection-bound"></a><h3>clutter_text_get_selection_bound ()</h3>
1428 <pre class="programlisting"><span class="returnvalue">gint</span>                clutter_text_get_selection_bound    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1429 <p>
1430 Retrieves the other end of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor,
1431 in characters from the current cursor position.
1432 </p>
1433 <div class="variablelist"><table border="0">
1434 <col align="left" valign="top">
1435 <tbody>
1436 <tr>
1437 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1438 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1439 </td>
1440 </tr>
1441 <tr>
1442 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1443 <td>the position of the other end of the selection</td>
1444 </tr>
1445 </tbody>
1446 </table></div>
1447 <p class="since">Since 1.0</p>
1448 </div>
1449 <hr>
1450 <div class="refsect2">
1451 <a name="clutter-text-set-single-line-mode"></a><h3>clutter_text_set_single_line_mode ()</h3>
1452 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_single_line_mode   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1453                                                          <em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);</pre>
1454 <p>
1455 Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
1456 or not. Only editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>s can be in single line
1457 mode.
1458 </p>
1459 <p>
1460 A text actor in single line mode will not wrap text and will clip
1461 the visible area to the predefined size. The contents of the
1462 text actor will scroll to display the end of the text if its length
1463 is bigger than the allocated width.
1464 </p>
1465 <p>
1466 When setting the single line mode the <a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'><span class="type">"activatable"</span></a>
1467 property is also set as a side effect. Instead of entering a new
1468 line character, the text actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a>
1469 signal.
1470 </p>
1471 <div class="variablelist"><table border="0">
1472 <col align="left" valign="top">
1473 <tbody>
1474 <tr>
1475 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1476 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1477 </td>
1478 </tr>
1479 <tr>
1480 <td><p><span class="term"><em class="parameter"><code>single_line</code></em> :</span></p></td>
1481 <td>whether to enable single line mode</td>
1482 </tr>
1483 </tbody>
1484 </table></div>
1485 <p class="since">Since 1.0</p>
1486 </div>
1487 <hr>
1488 <div class="refsect2">
1489 <a name="clutter-text-get-single-line-mode"></a><h3>clutter_text_get_single_line_mode ()</h3>
1490 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_single_line_mode   (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1491 <p>
1492 Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode.
1493 </p>
1494 <div class="variablelist"><table border="0">
1495 <col align="left" valign="top">
1496 <tbody>
1497 <tr>
1498 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1499 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1500 </td>
1501 </tr>
1502 <tr>
1503 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1504 <td>
1505 <code class="literal">TRUE</code> if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode</td>
1506 </tr>
1507 </tbody>
1508 </table></div>
1509 <p class="since">Since 1.0</p>
1510 </div>
1511 <hr>
1512 <div class="refsect2">
1513 <a name="clutter-text-set-use-markup"></a><h3>clutter_text_set_use_markup ()</h3>
1514 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_use_markup         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1515                                                          <em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);</pre>
1516 <p>
1517 Sets whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor contains markup
1518 in Pango's text markup language.
1519 </p>
1520 <p>
1521 Setting <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a> on an editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will
1522 not have any effect except hiding the markup.
1523 </p>
1524 <p>
1525 See also <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a>.
1526 </p>
1527 <div class="variablelist"><table border="0">
1528 <col align="left" valign="top">
1529 <tbody>
1530 <tr>
1531 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1532 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1533 </td>
1534 </tr>
1535 <tr>
1536 <td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
1537 <td>
1538 <code class="literal">TRUE</code> if the text should be parsed for markup.</td>
1539 </tr>
1540 </tbody>
1541 </table></div>
1542 <p class="since">Since 1.0</p>
1543 </div>
1544 <hr>
1545 <div class="refsect2">
1546 <a name="clutter-text-get-use-markup"></a><h3>clutter_text_get_use_markup ()</h3>
1547 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_use_markup         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1548 <p>
1549 Retrieves whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
1550 parsed for the Pango text markup.
1551 </p>
1552 <div class="variablelist"><table border="0">
1553 <col align="left" valign="top">
1554 <tbody>
1555 <tr>
1556 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1557 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1558 </td>
1559 </tr>
1560 <tr>
1561 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1562 <td>
1563 <code class="literal">TRUE</code> if the contents will be parsed for markup</td>
1564 </tr>
1565 </tbody>
1566 </table></div>
1567 <p class="since">Since 1.0</p>
1568 </div>
1569 <hr>
1570 <div class="refsect2">
1571 <a name="clutter-text-set-editable"></a><h3>clutter_text_set_editable ()</h3>
1572 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_editable           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1573                                                          <em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);</pre>
1574 <p>
1575 Sets whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be editable.
1576 </p>
1577 <p>
1578 An editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> with key focus set using
1579 <a class="link" href="ClutterActor.html#clutter-actor-grab-key-focus" title="clutter_actor_grab_key_focus ()"><code class="function">clutter_actor_grab_key_focus()</code></a> or <a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()"><code class="function">clutter_stage_set_key_focus()</code></a>
1580 will receive key events and will update its contents accordingly.
1581 </p>
1582 <div class="variablelist"><table border="0">
1583 <col align="left" valign="top">
1584 <tbody>
1585 <tr>
1586 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1587 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1588 </td>
1589 </tr>
1590 <tr>
1591 <td><p><span class="term"><em class="parameter"><code>editable</code></em> :</span></p></td>
1592 <td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be editable</td>
1593 </tr>
1594 </tbody>
1595 </table></div>
1596 <p class="since">Since 1.0</p>
1597 </div>
1598 <hr>
1599 <div class="refsect2">
1600 <a name="clutter-text-get-editable"></a><h3>clutter_text_get_editable ()</h3>
1601 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_editable           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1602 <p>
1603 Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is editable or not.
1604 </p>
1605 <div class="variablelist"><table border="0">
1606 <col align="left" valign="top">
1607 <tbody>
1608 <tr>
1609 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1610 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1611 </td>
1612 </tr>
1613 <tr>
1614 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1615 <td>
1616 <code class="literal">TRUE</code> if the actor is editable</td>
1617 </tr>
1618 </tbody>
1619 </table></div>
1620 <p class="since">Since 1.0</p>
1621 </div>
1622 <hr>
1623 <div class="refsect2">
1624 <a name="clutter-text-insert-text"></a><h3>clutter_text_insert_text ()</h3>
1625 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_insert_text            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1626                                                          <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
1627                                                          <em class="parameter"><code><span class="type">gssize</span> position</code></em>);</pre>
1628 <p>
1629 Inserts <em class="parameter"><code>text</code></em> into a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at the given position.
1630 </p>
1631 <p>
1632 If <em class="parameter"><code>position</code></em> is a negative number, the text will be appended
1633 at the end of the current contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
1634 </p>
1635 <p>
1636 The position is expressed in characters, not in bytes.
1637 </p>
1638 <div class="variablelist"><table border="0">
1639 <col align="left" valign="top">
1640 <tbody>
1641 <tr>
1642 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1643 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1644 </td>
1645 </tr>
1646 <tr>
1647 <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1648 <td>the text to be inserted</td>
1649 </tr>
1650 <tr>
1651 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
1652 <td>the position of the insertion, or -1</td>
1653 </tr>
1654 </tbody>
1655 </table></div>
1656 <p class="since">Since 1.0</p>
1657 </div>
1658 <hr>
1659 <div class="refsect2">
1660 <a name="clutter-text-insert-unichar"></a><h3>clutter_text_insert_unichar ()</h3>
1661 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_insert_unichar         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1662                                                          <em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
1663 <p>
1664 Inserts <em class="parameter"><code>wc</code></em> at the current cursor position of a
1665 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1666 </p>
1667 <div class="variablelist"><table border="0">
1668 <col align="left" valign="top">
1669 <tbody>
1670 <tr>
1671 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1672 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1673 </td>
1674 </tr>
1675 <tr>
1676 <td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
1677 <td>a Unicode character</td>
1678 </tr>
1679 </tbody>
1680 </table></div>
1681 <p class="since">Since 1.0</p>
1682 </div>
1683 <hr>
1684 <div class="refsect2">
1685 <a name="clutter-text-delete-chars"></a><h3>clutter_text_delete_chars ()</h3>
1686 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_delete_chars           (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1687                                                          <em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
1688 <p>
1689 Deletes <em class="parameter"><code>n_chars</code></em> inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, starting from the
1690 current cursor position.
1691 </p>
1692 <p>
1693 Somewhat awkwardly, the cursor position is decremented by the same
1694 number of characters you've deleted.
1695 </p>
1696 <div class="variablelist"><table border="0">
1697 <col align="left" valign="top">
1698 <tbody>
1699 <tr>
1700 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1701 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1702 </td>
1703 </tr>
1704 <tr>
1705 <td><p><span class="term"><em class="parameter"><code>n_chars</code></em> :</span></p></td>
1706 <td>the number of characters to delete</td>
1707 </tr>
1708 </tbody>
1709 </table></div>
1710 <p class="since">Since 1.0</p>
1711 </div>
1712 <hr>
1713 <div class="refsect2">
1714 <a name="clutter-text-delete-text"></a><h3>clutter_text_delete_text ()</h3>
1715 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_delete_text            (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1716                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1717                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1718 <p>
1719 Deletes the text inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between <em class="parameter"><code>start_pos</code></em>
1720 and <em class="parameter"><code>end_pos</code></em>.
1721 </p>
1722 <p>
1723 The starting and ending positions are expressed in characters,
1724 not in bytes.
1725 </p>
1726 <div class="variablelist"><table border="0">
1727 <col align="left" valign="top">
1728 <tbody>
1729 <tr>
1730 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1731 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1732 </td>
1733 </tr>
1734 <tr>
1735 <td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1736 <td>starting position</td>
1737 </tr>
1738 <tr>
1739 <td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1740 <td>ending position</td>
1741 </tr>
1742 </tbody>
1743 </table></div>
1744 <p class="since">Since 1.0</p>
1745 </div>
1746 <hr>
1747 <div class="refsect2">
1748 <a name="clutter-text-delete-selection"></a><h3>clutter_text_delete_selection ()</h3>
1749 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_delete_selection       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
1750 <p>
1751 Deletes the currently selected text
1752 </p>
1753 <p>
1754 This function is only useful in subclasses of <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1755 </p>
1756 <div class="variablelist"><table border="0">
1757 <col align="left" valign="top">
1758 <tbody>
1759 <tr>
1760 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1761 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1762 </td>
1763 </tr>
1764 <tr>
1765 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1766 <td>
1767 <code class="literal">TRUE</code> if text was deleted or if the text actor
1768 is empty, and <code class="literal">FALSE</code> otherwise</td>
1769 </tr>
1770 </tbody>
1771 </table></div>
1772 <p class="since">Since 1.0</p>
1773 </div>
1774 <hr>
1775 <div class="refsect2">
1776 <a name="clutter-text-get-chars"></a><h3>clutter_text_get_chars ()</h3>
1777 <pre class="programlisting"><span class="returnvalue">gchar</span> *             clutter_text_get_chars              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1778                                                          <em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1779                                                          <em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1780 <p>
1781 Retrieves the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between
1782 <em class="parameter"><code>start_pos</code></em> and <em class="parameter"><code>end_pos</code></em>, but not including <em class="parameter"><code>end_pos</code></em>.
1783 </p>
1784 <p>
1785 The positions are specified in characters, not in bytes.
1786 </p>
1787 <div class="variablelist"><table border="0">
1788 <col align="left" valign="top">
1789 <tbody>
1790 <tr>
1791 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1792 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1793 </td>
1794 </tr>
1795 <tr>
1796 <td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1797 <td>start of text, in characters</td>
1798 </tr>
1799 <tr>
1800 <td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1801 <td>end of text, in characters</td>
1802 </tr>
1803 <tr>
1804 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1805 <td>a newly allocated string with the contents of
1806 the text actor between the specified positions. Use <code class="function">g_free()</code>
1807 to free the resources when done</td>
1808 </tr>
1809 </tbody>
1810 </table></div>
1811 <p class="since">Since 1.0</p>
1812 </div>
1813 <hr>
1814 <div class="refsect2">
1815 <a name="clutter-text-set-cursor-color"></a><h3>clutter_text_set_cursor_color ()</h3>
1816 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_cursor_color       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1817                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1818 <p>
1819 Sets the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1820 </p>
1821 <p>
1822 If <em class="parameter"><code>color</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the cursor color will be the same as the
1823 text color.
1824 </p>
1825 <div class="variablelist"><table border="0">
1826 <col align="left" valign="top">
1827 <tbody>
1828 <tr>
1829 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1830 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1831 </td>
1832 </tr>
1833 <tr>
1834 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1835 <td>the color of the cursor, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset it</td>
1836 </tr>
1837 </tbody>
1838 </table></div>
1839 <p class="since">Since 1.0</p>
1840 </div>
1841 <hr>
1842 <div class="refsect2">
1843 <a name="clutter-text-get-cursor-color"></a><h3>clutter_text_get_cursor_color ()</h3>
1844 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_cursor_color       (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1845                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1846 <p>
1847 Retrieves the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1848 </p>
1849 <div class="variablelist"><table border="0">
1850 <col align="left" valign="top">
1851 <tbody>
1852 <tr>
1853 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1854 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1855 </td>
1856 </tr>
1857 <tr>
1858 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1859 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1860 </td>
1861 </tr>
1862 </tbody>
1863 </table></div>
1864 <p class="since">Since 1.0</p>
1865 </div>
1866 <hr>
1867 <div class="refsect2">
1868 <a name="clutter-text-set-selection-color"></a><h3>clutter_text_set_selection_color ()</h3>
1869 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_selection_color    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1870                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1871 <p>
1872 Sets the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1873 </p>
1874 <p>
1875 If <em class="parameter"><code>color</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the selection color will be the same as the
1876 cursor color, or if no cursor color is set either then it will be
1877 the same as the text color.
1878 </p>
1879 <div class="variablelist"><table border="0">
1880 <col align="left" valign="top">
1881 <tbody>
1882 <tr>
1883 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1884 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1885 </td>
1886 </tr>
1887 <tr>
1888 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1889 <td>the color of the selection, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset it</td>
1890 </tr>
1891 </tbody>
1892 </table></div>
1893 <p class="since">Since 1.0</p>
1894 </div>
1895 <hr>
1896 <div class="refsect2">
1897 <a name="clutter-text-get-selection-color"></a><h3>clutter_text_get_selection_color ()</h3>
1898 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_selection_color    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1899                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1900 <p>
1901 Retrieves the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1902 </p>
1903 <div class="variablelist"><table border="0">
1904 <col align="left" valign="top">
1905 <tbody>
1906 <tr>
1907 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1908 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1909 </td>
1910 </tr>
1911 <tr>
1912 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1913 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
1914 </td>
1915 </tr>
1916 </tbody>
1917 </table></div>
1918 <p class="since">Since 1.0</p>
1919 </div>
1920 <hr>
1921 <div class="refsect2">
1922 <a name="clutter-text-set-selected-text-color"></a><h3>clutter_text_set_selected_text_color ()</h3>
1923 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_selected_text_color
1924                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1925                                                          <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1926 <p>
1927 Sets the selected text color of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1928 </p>
1929 <p>
1930 If <em class="parameter"><code>color</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the selected text color will be the same as the
1931 selection color, which then falls back to cursor, and then text color.
1932 </p>
1933 <div class="variablelist"><table border="0">
1934 <col align="left" valign="top">
1935 <tbody>
1936 <tr>
1937 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1938 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1939 </td>
1940 </tr>
1941 <tr>
1942 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1943 <td>the selected text color, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset it</td>
1944 </tr>
1945 </tbody>
1946 </table></div>
1947 <p class="since">Since 1.8</p>
1948 </div>
1949 <hr>
1950 <div class="refsect2">
1951 <a name="clutter-text-get-selected-text-color"></a><h3>clutter_text_get_selected_text_color ()</h3>
1952 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_selected_text_color
1953                                                         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1954                                                          <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1955 <p>
1956 Retrieves the color of selected text of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1957 </p>
1958 <div class="variablelist"><table border="0">
1959 <col align="left" valign="top">
1960 <tbody>
1961 <tr>
1962 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1963 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1964 </td>
1965 </tr>
1966 <tr>
1967 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1968 <td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
1969 </td>
1970 </tr>
1971 </tbody>
1972 </table></div>
1973 <p class="since">Since 1.8</p>
1974 </div>
1975 <hr>
1976 <div class="refsect2">
1977 <a name="clutter-text-set-cursor-position"></a><h3>clutter_text_set_cursor_position ()</h3>
1978 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_cursor_position    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
1979                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
1980 <p>
1981 Sets the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor at <em class="parameter"><code>position</code></em>.
1982 </p>
1983 <p>
1984 The position is expressed in characters, not in bytes.
1985 </p>
1986 <div class="variablelist"><table border="0">
1987 <col align="left" valign="top">
1988 <tbody>
1989 <tr>
1990 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1991 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1992 </td>
1993 </tr>
1994 <tr>
1995 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
1996 <td>the new cursor position, in characters</td>
1997 </tr>
1998 </tbody>
1999 </table></div>
2000 <p class="since">Since 1.0</p>
2001 </div>
2002 <hr>
2003 <div class="refsect2">
2004 <a name="clutter-text-get-cursor-position"></a><h3>clutter_text_get_cursor_position ()</h3>
2005 <pre class="programlisting"><span class="returnvalue">gint</span>                clutter_text_get_cursor_position    (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
2006 <p>
2007 Retrieves the cursor position.
2008 </p>
2009 <div class="variablelist"><table border="0">
2010 <col align="left" valign="top">
2011 <tbody>
2012 <tr>
2013 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2014 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2015 </td>
2016 </tr>
2017 <tr>
2018 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2019 <td>the cursor position, in characters</td>
2020 </tr>
2021 </tbody>
2022 </table></div>
2023 <p class="since">Since 1.0</p>
2024 </div>
2025 <hr>
2026 <div class="refsect2">
2027 <a name="clutter-text-set-cursor-visible"></a><h3>clutter_text_set_cursor_visible ()</h3>
2028 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_cursor_visible     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2029                                                          <em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);</pre>
2030 <p>
2031 Sets whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
2032 visible or not.
2033 </p>
2034 <p>
2035 The color of the cursor will be the same as the text color
2036 unless <a class="link" href="ClutterText.html#clutter-text-set-cursor-color" title="clutter_text_set_cursor_color ()"><code class="function">clutter_text_set_cursor_color()</code></a> has been called.
2037 </p>
2038 <p>
2039 The size of the cursor can be set using <a class="link" href="ClutterText.html#clutter-text-set-cursor-size" title="clutter_text_set_cursor_size ()"><code class="function">clutter_text_set_cursor_size()</code></a>.
2040 </p>
2041 <p>
2042 The position of the cursor can be changed programmatically using
2043 <a class="link" href="ClutterText.html#clutter-text-set-cursor-position" title="clutter_text_set_cursor_position ()"><code class="function">clutter_text_set_cursor_position()</code></a>.
2044 </p>
2045 <div class="variablelist"><table border="0">
2046 <col align="left" valign="top">
2047 <tbody>
2048 <tr>
2049 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2050 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2051 </td>
2052 </tr>
2053 <tr>
2054 <td><p><span class="term"><em class="parameter"><code>cursor_visible</code></em> :</span></p></td>
2055 <td>whether the cursor should be visible</td>
2056 </tr>
2057 </tbody>
2058 </table></div>
2059 <p class="since">Since 1.0</p>
2060 </div>
2061 <hr>
2062 <div class="refsect2">
2063 <a name="clutter-text-get-cursor-visible"></a><h3>clutter_text_get_cursor_visible ()</h3>
2064 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_cursor_visible     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
2065 <p>
2066 Retrieves whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is visible.
2067 </p>
2068 <div class="variablelist"><table border="0">
2069 <col align="left" valign="top">
2070 <tbody>
2071 <tr>
2072 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2073 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2074 </td>
2075 </tr>
2076 <tr>
2077 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2078 <td>
2079 <code class="literal">TRUE</code> if the cursor is visible</td>
2080 </tr>
2081 </tbody>
2082 </table></div>
2083 <p class="since">Since 1.0</p>
2084 </div>
2085 <hr>
2086 <div class="refsect2">
2087 <a name="clutter-text-set-cursor-size"></a><h3>clutter_text_set_cursor_size ()</h3>
2088 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_cursor_size        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2089                                                          <em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
2090 <p>
2091 Sets the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The cursor
2092 will only be visible if the <a class="link" href="ClutterText.html#ClutterText--cursor-visible" title='The "cursor-visible" property'><span class="type">"cursor-visible"</span></a> property
2093 is set to <code class="literal">TRUE</code>.
2094 </p>
2095 <div class="variablelist"><table border="0">
2096 <col align="left" valign="top">
2097 <tbody>
2098 <tr>
2099 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2100 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2101 </td>
2102 </tr>
2103 <tr>
2104 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
2105 <td>the size of the cursor, in pixels, or -1 to use the
2106 default value</td>
2107 </tr>
2108 </tbody>
2109 </table></div>
2110 <p class="since">Since 1.0</p>
2111 </div>
2112 <hr>
2113 <div class="refsect2">
2114 <a name="clutter-text-get-cursor-size"></a><h3>clutter_text_get_cursor_size ()</h3>
2115 <pre class="programlisting"><span class="returnvalue">guint</span>               clutter_text_get_cursor_size        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
2116 <p>
2117 Retrieves the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2118 </p>
2119 <div class="variablelist"><table border="0">
2120 <col align="left" valign="top">
2121 <tbody>
2122 <tr>
2123 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2124 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2125 </td>
2126 </tr>
2127 <tr>
2128 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2129 <td>the size of the cursor, in pixels</td>
2130 </tr>
2131 </tbody>
2132 </table></div>
2133 <p class="since">Since 1.0</p>
2134 </div>
2135 <hr>
2136 <div class="refsect2">
2137 <a name="clutter-text-activate"></a><h3>clutter_text_activate ()</h3>
2138 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_activate               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
2139 <p>
2140 Emits the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a> signal, if <em class="parameter"><code>self</code></em> has been set
2141 as activatable using <a class="link" href="ClutterText.html#clutter-text-set-activatable" title="clutter_text_set_activatable ()"><code class="function">clutter_text_set_activatable()</code></a>.
2142 </p>
2143 <p>
2144 This function can be used to emit the ::activate signal inside
2145 a <a class="link" href="ClutterActor.html#ClutterActor-captured-event" title='The "captured-event" signal'><span class="type">"captured-event"</span></a> or <a class="link" href="ClutterActor.html#ClutterActor-key-press-event" title='The "key-press-event" signal'><span class="type">"key-press-event"</span></a>
2146 signal handlers before the default signal handler for the
2147 <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is invoked.
2148 </p>
2149 <div class="variablelist"><table border="0">
2150 <col align="left" valign="top">
2151 <tbody>
2152 <tr>
2153 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2154 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2155 </td>
2156 </tr>
2157 <tr>
2158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2159 <td>
2160 <code class="literal">TRUE</code> if the ::activate signal has been emitted,
2161 and <code class="literal">FALSE</code> otherwise</td>
2162 </tr>
2163 </tbody>
2164 </table></div>
2165 <p class="since">Since 1.0</p>
2166 </div>
2167 <hr>
2168 <div class="refsect2">
2169 <a name="clutter-text-coords-to-position"></a><h3>clutter_text_coords_to_position ()</h3>
2170 <pre class="programlisting"><span class="returnvalue">gint</span>                clutter_text_coords_to_position     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2171                                                          <em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
2172                                                          <em class="parameter"><code><span class="type">gfloat</span> y</code></em>);</pre>
2173 <p>
2174 Retrieves the position of the character at the given coordinates.
2175 </p>
2176 <p>
2177 Return: the position of the character
2178 </p>
2179 <div class="variablelist"><table border="0">
2180 <col align="left" valign="top">
2181 <tbody>
2182 <tr>
2183 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2184 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2185 </td>
2186 </tr>
2187 <tr>
2188 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2189 <td>the X coordinate, relative to the actor</td>
2190 </tr>
2191 <tr>
2192 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2193 <td>the Y coordinate, relative to the actor</td>
2194 </tr>
2195 </tbody>
2196 </table></div>
2197 <p class="since">Since 1.10</p>
2198 </div>
2199 <hr>
2200 <div class="refsect2">
2201 <a name="clutter-text-position-to-coords"></a><h3>clutter_text_position_to_coords ()</h3>
2202 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_position_to_coords     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2203                                                          <em class="parameter"><code><span class="type">gint</span> position</code></em>,
2204                                                          <em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
2205                                                          <em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
2206                                                          <em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);</pre>
2207 <p>
2208 Retrieves the coordinates of the given <em class="parameter"><code>position</code></em>.
2209 </p>
2210 <div class="variablelist"><table border="0">
2211 <col align="left" valign="top">
2212 <tbody>
2213 <tr>
2214 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2215 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2216 </td>
2217 </tr>
2218 <tr>
2219 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
2220 <td>position in characters</td>
2221 </tr>
2222 <tr>
2223 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2224 <td>return location for the X coordinate, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2225 </td>
2226 </tr>
2227 <tr>
2228 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2229 <td>return location for the Y coordinate, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2230 </td>
2231 </tr>
2232 <tr>
2233 <td><p><span class="term"><em class="parameter"><code>line_height</code></em> :</span></p></td>
2234 <td>return location for the line height, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2235 </td>
2236 </tr>
2237 <tr>
2238 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2239 <td>
2240 <code class="literal">TRUE</code> if the conversion was successful</td>
2241 </tr>
2242 </tbody>
2243 </table></div>
2244 <p class="since">Since 1.0</p>
2245 </div>
2246 <hr>
2247 <div class="refsect2">
2248 <a name="clutter-text-set-preedit-string"></a><h3>clutter_text_set_preedit_string ()</h3>
2249 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_preedit_string     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2250                                                          <em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
2251                                                          <em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
2252                                                          <em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);</pre>
2253 <p>
2254 Sets, or unsets, the pre-edit string. This function is useful
2255 for input methods to display a string (with eventual specific
2256 Pango attributes) before it is entered inside the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2257 buffer.
2258 </p>
2259 <p>
2260 The preedit string and attributes are ignored if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2261 actor is not editable.
2262 </p>
2263 <p>
2264 This function should not be used by applications
2265 </p>
2266 <div class="variablelist"><table border="0">
2267 <col align="left" valign="top">
2268 <tbody>
2269 <tr>
2270 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2271 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2272 </td>
2273 </tr>
2274 <tr>
2275 <td><p><span class="term"><em class="parameter"><code>preedit_str</code></em> :</span></p></td>
2276 <td>the pre-edit string, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to unset it. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2277 </td>
2278 </tr>
2279 <tr>
2280 <td><p><span class="term"><em class="parameter"><code>preedit_attrs</code></em> :</span></p></td>
2281 <td>the pre-edit string attributes. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2282 </td>
2283 </tr>
2284 <tr>
2285 <td><p><span class="term"><em class="parameter"><code>cursor_pos</code></em> :</span></p></td>
2286 <td>the cursor position for the pre-edit string</td>
2287 </tr>
2288 </tbody>
2289 </table></div>
2290 <p class="since">Since 1.2</p>
2291 </div>
2292 <hr>
2293 <div class="refsect2">
2294 <a name="clutter-text-get-layout-offsets"></a><h3>clutter_text_get_layout_offsets ()</h3>
2295 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_layout_offsets     (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2296                                                          <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
2297                                                          <em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
2298 <p>
2299 Obtains the coordinates where the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will draw the <span class="type">PangoLayout</span>
2300 representing the text.
2301 </p>
2302 <div class="variablelist"><table border="0">
2303 <col align="left" valign="top">
2304 <tbody>
2305 <tr>
2306 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2307 <td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2308 </td>
2309 </tr>
2310 <tr>
2311 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2312 <td>location to store X offset of layout, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2313 </td>
2314 </tr>
2315 <tr>
2316 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2317 <td>location to store Y offset of layout, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2318 </td>
2319 </tr>
2320 </tbody>
2321 </table></div>
2322 <p class="since">Since 1.8</p>
2323 </div>
2324 </div>
2325 <div class="refsect1">
2326 <a name="ClutterText.property-details"></a><h2>Property Details</h2>
2327 <div class="refsect2">
2328 <a name="ClutterText--activatable"></a><h3>The <code class="literal">"activatable"</code> property</h3>
2329 <pre class="programlisting">  "activatable"              <span class="type">gboolean</span>              : Read / Write</pre>
2330 <p>
2331 Toggles whether return invokes the activate signal or not.
2332 </p>
2333 <p>Default value: TRUE</p>
2334 <p class="since">Since 1.0</p>
2335 </div>
2336 <hr>
2337 <div class="refsect2">
2338 <a name="ClutterText--attributes"></a><h3>The <code class="literal">"attributes"</code> property</h3>
2339 <pre class="programlisting">  "attributes"               <span class="type">PangoAttrList</span>*        : Read / Write</pre>
2340 <p>
2341 A list of <span class="type">PangoStyleAttribute</span>s to be applied to the
2342 contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2343 </p>
2344 <p class="since">Since 1.0</p>
2345 </div>
2346 <hr>
2347 <div class="refsect2">
2348 <a name="ClutterText--buffer"></a><h3>The <code class="literal">"buffer"</code> property</h3>
2349 <pre class="programlisting">  "buffer"                   <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>*    : Read / Write</pre>
2350 <p>
2351 The buffer which stores the text for this <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
2352 </p>
2353 <p>
2354 If set to <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, a default buffer will be created.
2355 </p>
2356 <p class="since">Since 1.8</p>
2357 </div>
2358 <hr>
2359 <div class="refsect2">
2360 <a name="ClutterText--color"></a><h3>The <code class="literal">"color"</code> property</h3>
2361 <pre class="programlisting">  "color"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
2362 <p>
2363 The color used to render the text.
2364 </p>
2365 <p class="since">Since 1.0</p>
2366 </div>
2367 <hr>
2368 <div class="refsect2">
2369 <a name="ClutterText--cursor-color"></a><h3>The <code class="literal">"cursor-color"</code> property</h3>
2370 <pre class="programlisting">  "cursor-color"             <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
2371 <p>
2372 The color of the cursor.
2373 </p>
2374 <p class="since">Since 1.0</p>
2375 </div>
2376 <hr>
2377 <div class="refsect2">
2378 <a name="ClutterText--cursor-color-set"></a><h3>The <code class="literal">"cursor-color-set"</code> property</h3>
2379 <pre class="programlisting">  "cursor-color-set"         <span class="type">gboolean</span>              : Read</pre>
2380 <p>
2381 Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--cursor-color" title='The "cursor-color" property'><span class="type">"cursor-color"</span></a> has been set.
2382 </p>
2383 <p>Default value: FALSE</p>
2384 <p class="since">Since 1.0</p>
2385 </div>
2386 <hr>
2387 <div class="refsect2">
2388 <a name="ClutterText--cursor-size"></a><h3>The <code class="literal">"cursor-size"</code> property</h3>
2389 <pre class="programlisting">  "cursor-size"              <span class="type">gint</span>                  : Read / Write</pre>
2390 <p>
2391 The size of the cursor, in pixels. If set to -1 the size used will
2392 be the default cursor size of 2 pixels.
2393 </p>
2394 <p>Allowed values: &gt;= G_MAXULONG</p>
2395 <p>Default value: 2</p>
2396 <p class="since">Since 1.0</p>
2397 </div>
2398 <hr>
2399 <div class="refsect2">
2400 <a name="ClutterText--cursor-visible"></a><h3>The <code class="literal">"cursor-visible"</code> property</h3>
2401 <pre class="programlisting">  "cursor-visible"           <span class="type">gboolean</span>              : Read / Write</pre>
2402 <p>
2403 Whether the input cursor is visible or not, it will only be visible
2404 if both <a class="link" href="ClutterText.html#ClutterText--cursor-visible" title='The "cursor-visible" property'><span class="type">"cursor-visible"</span></a> and <a class="link" href="ClutterText.html#ClutterText--editable" title='The "editable" property'><span class="type">"editable"</span></a> are
2405 set to <code class="literal">TRUE</code>.
2406 </p>
2407 <p>Default value: TRUE</p>
2408 <p class="since">Since 1.0</p>
2409 </div>
2410 <hr>
2411 <div class="refsect2">
2412 <a name="ClutterText--editable"></a><h3>The <code class="literal">"editable"</code> property</h3>
2413 <pre class="programlisting">  "editable"                 <span class="type">gboolean</span>              : Read / Write</pre>
2414 <p>
2415 Whether key events delivered to the actor causes editing.
2416 </p>
2417 <p>Default value: FALSE</p>
2418 <p class="since">Since 1.0</p>
2419 </div>
2420 <hr>
2421 <div class="refsect2">
2422 <a name="ClutterText--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
2423 <pre class="programlisting">  "ellipsize"                <span class="type">PangoEllipsizeMode</span>    : Read / Write</pre>
2424 <p>
2425 The preferred place to ellipsize the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
2426 </p>
2427 <p>Default value: PANGO_ELLIPSIZE_NONE</p>
2428 <p class="since">Since 1.0</p>
2429 </div>
2430 <hr>
2431 <div class="refsect2">
2432 <a name="ClutterText--font-description"></a><h3>The <code class="literal">"font-description"</code> property</h3>
2433 <pre class="programlisting">  "font-description"         <span class="type">PangoFontDescription</span>*  : Read / Write</pre>
2434 <p>
2435 The <span class="type">PangoFontDescription</span> that should be used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2436 </p>
2437 <p>
2438 If you have a string describing the font then you should look at
2439 <a class="link" href="ClutterText.html#ClutterText--font-name" title='The "font-name" property'><span class="type">"font-name"</span></a> instead
2440 </p>
2441 <p class="since">Since 1.2</p>
2442 </div>
2443 <hr>
2444 <div class="refsect2">
2445 <a name="ClutterText--font-name"></a><h3>The <code class="literal">"font-name"</code> property</h3>
2446 <pre class="programlisting">  "font-name"                <span class="type">gchar</span>*                : Read / Write</pre>
2447 <p>
2448 The font to be used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as a string
2449 that can be parsed by <code class="function">pango_font_description_from_string()</code>.
2450 </p>
2451 <p>
2452 If set to <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the default system font will be used instead.
2453 </p>
2454 <p>Default value: NULL</p>
2455 <p class="since">Since 1.0</p>
2456 </div>
2457 <hr>
2458 <div class="refsect2">
2459 <a name="ClutterText--justify"></a><h3>The <code class="literal">"justify"</code> property</h3>
2460 <pre class="programlisting">  "justify"                  <span class="type">gboolean</span>              : Read / Write</pre>
2461 <p>
2462 Whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be justified
2463 on both margins.
2464 </p>
2465 <p>Default value: FALSE</p>
2466 <p class="since">Since 1.0</p>
2467 </div>
2468 <hr>
2469 <div class="refsect2">
2470 <a name="ClutterText--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
2471 <pre class="programlisting">  "line-alignment"           <span class="type">PangoAlignment</span>        : Read / Write</pre>
2472 <p>
2473 The preferred alignment for the text. This property controls
2474 the alignment of multi-line paragraphs.
2475 </p>
2476 <p>Default value: PANGO_ALIGN_LEFT</p>
2477 <p class="since">Since 1.0</p>
2478 </div>
2479 <hr>
2480 <div class="refsect2">
2481 <a name="ClutterText--line-wrap"></a><h3>The <code class="literal">"line-wrap"</code> property</h3>
2482 <pre class="programlisting">  "line-wrap"                <span class="type">gboolean</span>              : Read / Write</pre>
2483 <p>
2484 Whether to wrap the lines of <a class="link" href="ClutterText.html#ClutterText--text" title='The "text" property'><span class="type">"text"</span></a> if the contents
2485 exceed the available allocation. The wrapping strategy is
2486 controlled by the <a class="link" href="ClutterText.html#ClutterText--line-wrap-mode" title='The "line-wrap-mode" property'><span class="type">"line-wrap-mode"</span></a> property.
2487 </p>
2488 <p>Default value: FALSE</p>
2489 <p class="since">Since 1.0</p>
2490 </div>
2491 <hr>
2492 <div class="refsect2">
2493 <a name="ClutterText--line-wrap-mode"></a><h3>The <code class="literal">"line-wrap-mode"</code> property</h3>
2494 <pre class="programlisting">  "line-wrap-mode"           <span class="type">PangoWrapMode</span>         : Read / Write</pre>
2495 <p>
2496 If <a class="link" href="ClutterText.html#ClutterText--line-wrap" title='The "line-wrap" property'><span class="type">"line-wrap"</span></a> is set to <code class="literal">TRUE</code>, this property will
2497 control how the text is wrapped.
2498 </p>
2499 <p>Default value: PANGO_WRAP_WORD</p>
2500 <p class="since">Since 1.0</p>
2501 </div>
2502 <hr>
2503 <div class="refsect2">
2504 <a name="ClutterText--max-length"></a><h3>The <code class="literal">"max-length"</code> property</h3>
2505 <pre class="programlisting">  "max-length"               <span class="type">gint</span>                  : Read / Write</pre>
2506 <p>
2507 The maximum length of the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2508 </p>
2509 <p>Allowed values: &gt;= G_MAXULONG</p>
2510 <p>Default value: 0</p>
2511 <p class="since">Since 1.0</p>
2512 </div>
2513 <hr>
2514 <div class="refsect2">
2515 <a name="ClutterText--password-char"></a><h3>The <code class="literal">"password-char"</code> property</h3>
2516 <pre class="programlisting">  "password-char"            <span class="type">guint</span>                 : Read / Write</pre>
2517 <p>
2518 If non-zero, the character that should be used in place of
2519 the actual text in a password text actor.
2520 </p>
2521 <p>Default value: 0</p>
2522 <p class="since">Since 1.0</p>
2523 </div>
2524 <hr>
2525 <div class="refsect2">
2526 <a name="ClutterText--position"></a><h3>The <code class="literal">"position"</code> property</h3>
2527 <pre class="programlisting">  "position"                 <span class="type">gint</span>                  : Read / Write</pre>
2528 <p>
2529 The current input cursor position. -1 is taken to be the end of the text
2530 </p>
2531 <p>Allowed values: &gt;= G_MAXULONG</p>
2532 <p>Default value: -1</p>
2533 <p class="since">Since 1.0</p>
2534 </div>
2535 <hr>
2536 <div class="refsect2">
2537 <a name="ClutterText--selectable"></a><h3>The <code class="literal">"selectable"</code> property</h3>
2538 <pre class="programlisting">  "selectable"               <span class="type">gboolean</span>              : Read / Write</pre>
2539 <p>
2540 Whether it is possible to select text, either using the pointer
2541 or the keyboard.
2542 </p>
2543 <p>Default value: TRUE</p>
2544 <p class="since">Since 1.0</p>
2545 </div>
2546 <hr>
2547 <div class="refsect2">
2548 <a name="ClutterText--selected-text-color"></a><h3>The <code class="literal">"selected-text-color"</code> property</h3>
2549 <pre class="programlisting">  "selected-text-color"      <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
2550 <p>
2551 The color of selected text.
2552 </p>
2553 <p class="since">Since 1.8</p>
2554 </div>
2555 <hr>
2556 <div class="refsect2">
2557 <a name="ClutterText--selected-text-color-set"></a><h3>The <code class="literal">"selected-text-color-set"</code> property</h3>
2558 <pre class="programlisting">  "selected-text-color-set"  <span class="type">gboolean</span>              : Read</pre>
2559 <p>
2560 Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--selected-text-color" title='The "selected-text-color" property'><span class="type">"selected-text-color"</span></a> has been set.
2561 </p>
2562 <p>Default value: FALSE</p>
2563 <p class="since">Since 1.8</p>
2564 </div>
2565 <hr>
2566 <div class="refsect2">
2567 <a name="ClutterText--selection-bound"></a><h3>The <code class="literal">"selection-bound"</code> property</h3>
2568 <pre class="programlisting">  "selection-bound"          <span class="type">gint</span>                  : Read / Write</pre>
2569 <p>
2570 The current input cursor position. -1 is taken to be the end of the text
2571 </p>
2572 <p>Allowed values: &gt;= G_MAXULONG</p>
2573 <p>Default value: -1</p>
2574 <p class="since">Since 1.0</p>
2575 </div>
2576 <hr>
2577 <div class="refsect2">
2578 <a name="ClutterText--selection-color"></a><h3>The <code class="literal">"selection-color"</code> property</h3>
2579 <pre class="programlisting">  "selection-color"          <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write</pre>
2580 <p>
2581 The color of the selection.
2582 </p>
2583 <p class="since">Since 1.0</p>
2584 </div>
2585 <hr>
2586 <div class="refsect2">
2587 <a name="ClutterText--selection-color-set"></a><h3>The <code class="literal">"selection-color-set"</code> property</h3>
2588 <pre class="programlisting">  "selection-color-set"      <span class="type">gboolean</span>              : Read</pre>
2589 <p>
2590 Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--selection-color" title='The "selection-color" property'><span class="type">"selection-color"</span></a> has been set.
2591 </p>
2592 <p>Default value: FALSE</p>
2593 <p class="since">Since 1.0</p>
2594 </div>
2595 <hr>
2596 <div class="refsect2">
2597 <a name="ClutterText--single-line-mode"></a><h3>The <code class="literal">"single-line-mode"</code> property</h3>
2598 <pre class="programlisting">  "single-line-mode"         <span class="type">gboolean</span>              : Read / Write</pre>
2599 <p>
2600 Whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
2601 or not. A single line <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will only contain a
2602 single line of text, scrolling it in case its length is bigger
2603 than the allocated size.
2604 </p>
2605 <p>
2606 Setting this property will also set the <a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'><span class="type">"activatable"</span></a>
2607 property as a side-effect.
2608 </p>
2609 <p>
2610 The <a class="link" href="ClutterText.html#ClutterText--single-line-mode" title='The "single-line-mode" property'><span class="type">"single-line-mode"</span></a> property is used only if the
2611 <a class="link" href="ClutterText.html#ClutterText--editable" title='The "editable" property'><span class="type">"editable"</span></a> property is set to <code class="literal">TRUE</code>.
2612 </p>
2613 <p>Default value: FALSE</p>
2614 <p class="since">Since 1.0</p>
2615 </div>
2616 <hr>
2617 <div class="refsect2">
2618 <a name="ClutterText--text"></a><h3>The <code class="literal">"text"</code> property</h3>
2619 <pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
2620 <p>
2621 The text to render inside the actor.
2622 </p>
2623 <p>Default value: ""</p>
2624 <p class="since">Since 1.0</p>
2625 </div>
2626 <hr>
2627 <div class="refsect2">
2628 <a name="ClutterText--use-markup"></a><h3>The <code class="literal">"use-markup"</code> property</h3>
2629 <pre class="programlisting">  "use-markup"               <span class="type">gboolean</span>              : Read / Write</pre>
2630 <p>
2631 Whether the text includes Pango markup.
2632 </p>
2633 <p>
2634 For more informations about the Pango markup format, see
2635 <code class="function">pango_layout_set_markup()</code> in the Pango documentation.
2636 </p>
2637 <p>
2638 </p>
2639 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2640 <h3 class="title">Note</h3>It is not possible to round-trip this property between
2641 <code class="literal">TRUE</code> and <code class="literal">FALSE</code>. Once a string with markup has been set on
2642 a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor with :use-markup set to <code class="literal">TRUE</code>, the markup
2643 is stripped from the string.</div>
2644 <p>
2645 </p>
2646 <p>Default value: FALSE</p>
2647 <p class="since">Since 1.0</p>
2648 </div>
2649 </div>
2650 <div class="refsect1">
2651 <a name="ClutterText.signal-details"></a><h2>Signal Details</h2>
2652 <div class="refsect2">
2653 <a name="ClutterText-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3>
2654 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2655                                                         <span class="type">gpointer</span>     user_data)      : <code class="literal">Run Last</code></pre>
2656 <p>
2657 The ::activate signal is emitted each time the actor is 'activated'
2658 by the user, normally by pressing the 'Enter' key. The signal is
2659 emitted only if <a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'><span class="type">"activatable"</span></a> is set to <code class="literal">TRUE</code>.
2660 </p>
2661 <div class="variablelist"><table border="0">
2662 <col align="left" valign="top">
2663 <tbody>
2664 <tr>
2665 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2666 <td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2667 </tr>
2668 <tr>
2669 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2670 <td>user data set when the signal handler was connected.</td>
2671 </tr>
2672 </tbody>
2673 </table></div>
2674 <p class="since">Since 1.0</p>
2675 </div>
2676 <hr>
2677 <div class="refsect2">
2678 <a name="ClutterText-cursor-event"></a><h3>The <code class="literal">"cursor-event"</code> signal</h3>
2679 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>     *self,
2680                                                         <a class="link" href="ClutterActor.html#ClutterGeometry" title="struct ClutterGeometry"><span class="type">ClutterGeometry</span></a> *geometry,
2681                                                         <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
2682 <p>
2683 The ::cursor-event signal is emitted whenever the cursor position
2684 changes inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. Inside <em class="parameter"><code>geometry</code></em> it is stored
2685 the current position and size of the cursor, relative to the actor
2686 itself.
2687 </p>
2688 <div class="variablelist"><table border="0">
2689 <col align="left" valign="top">
2690 <tbody>
2691 <tr>
2692 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2693 <td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2694 </tr>
2695 <tr>
2696 <td><p><span class="term"><em class="parameter"><code>geometry</code></em> :</span></p></td>
2697 <td>the coordinates of the cursor</td>
2698 </tr>
2699 <tr>
2700 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2701 <td>user data set when the signal handler was connected.</td>
2702 </tr>
2703 </tbody>
2704 </table></div>
2705 <p class="since">Since 1.0</p>
2706 </div>
2707 <hr>
2708 <div class="refsect2">
2709 <a name="ClutterText-delete-text"></a><h3>The <code class="literal">"delete-text"</code> signal</h3>
2710 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2711                                                         <span class="type">gint</span>         start_pos,
2712                                                         <span class="type">gint</span>         end_pos,
2713                                                         <span class="type">gpointer</span>     user_data)      : <code class="literal">Action</code></pre>
2714 <p>
2715 This signal is emitted when text is deleted from the actor by
2716 the user. It is emitted before <em class="parameter"><code>self</code></em> text changes.
2717 </p>
2718 <div class="variablelist"><table border="0">
2719 <col align="left" valign="top">
2720 <tbody>
2721 <tr>
2722 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2723 <td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2724 </tr>
2725 <tr>
2726 <td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
2727 <td>the starting position</td>
2728 </tr>
2729 <tr>
2730 <td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
2731 <td>the end position</td>
2732 </tr>
2733 <tr>
2734 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2735 <td>user data set when the signal handler was connected.</td>
2736 </tr>
2737 </tbody>
2738 </table></div>
2739 <p class="since">Since 1.2</p>
2740 </div>
2741 <hr>
2742 <div class="refsect2">
2743 <a name="ClutterText-insert-text"></a><h3>The <code class="literal">"insert-text"</code> signal</h3>
2744 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2745                                                         <span class="type">gchar</span>       *new_text,
2746                                                         <span class="type">gint</span>         new_text_length,
2747                                                         <span class="type">gpointer</span>     position,
2748                                                         <span class="type">gpointer</span>     user_data)            : <code class="literal">Action</code></pre>
2749 <p>
2750 This signal is emitted when text is inserted into the actor by
2751 the user. It is emitted before <em class="parameter"><code>self</code></em> text changes.
2752 </p>
2753 <div class="variablelist"><table border="0">
2754 <col align="left" valign="top">
2755 <tbody>
2756 <tr>
2757 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2758 <td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2759 </tr>
2760 <tr>
2761 <td><p><span class="term"><em class="parameter"><code>new_text</code></em> :</span></p></td>
2762 <td>the new text to insert</td>
2763 </tr>
2764 <tr>
2765 <td><p><span class="term"><em class="parameter"><code>new_text_length</code></em> :</span></p></td>
2766 <td>the length of the new text, in bytes, or -1 if
2767 new_text is nul-terminated</td>
2768 </tr>
2769 <tr>
2770 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
2771 <td>the position, in characters, at which to insert the
2772 new text. this is an in-out parameter.  After the signal
2773 emission is finished, it should point after the newly
2774 inserted text.</td>
2775 </tr>
2776 <tr>
2777 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2778 <td>user data set when the signal handler was connected.</td>
2779 </tr>
2780 </tbody>
2781 </table></div>
2782 <p class="since">Since 1.2</p>
2783 </div>
2784 <hr>
2785 <div class="refsect2">
2786 <a name="ClutterText-text-changed"></a><h3>The <code class="literal">"text-changed"</code> signal</h3>
2787 <pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2788                                                         <span class="type">gpointer</span>     user_data)      : <code class="literal">Run Last</code></pre>
2789 <p>
2790 The ::text-changed signal is emitted after <em class="parameter"><code>actor</code></em>'s text changes
2791 </p>
2792 <div class="variablelist"><table border="0">
2793 <col align="left" valign="top">
2794 <tbody>
2795 <tr>
2796 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2797 <td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2798 </tr>
2799 <tr>
2800 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2801 <td>user data set when the signal handler was connected.</td>
2802 </tr>
2803 </tbody>
2804 </table></div>
2805 <p class="since">Since 1.0</p>
2806 </div>
2807 </div>
2808 </div>
2809 <div class="footer">
2810 <hr>
2811           Generated by GTK-Doc V1.18.1</div>
2812 </body>
2813 </html>