RubyGems - goocanvas - Versions diffs - 0.90.6-x86-mingw32 - Mend

goocanvas 0.90.6-x86-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (136) hide show

data/vendor/local/share/gtk-doc/html/goocanvas/GooCanvasText.html ADDED Viewed

@@ -0,0 +1,324 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GooCanvasText</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GooCanvas Reference Manual">
+<link rel="up" href="ch03.html" title="Standard Canvas Items">
+<link rel="prev" href="GooCanvasRect.html" title="GooCanvasRect">
+<link rel="next" href="GooCanvasWidget.html" title="GooCanvasWidget">
+<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="GooCanvasRect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">GooCanvas Reference Manual</th>
+<td><a accesskey="n" href="GooCanvasWidget.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#GooCanvasText.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#GooCanvasText.description" class="shortcut">Description</a>
+                   |
+                  <a href="#GooCanvasText.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#GooCanvasText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
+                   |
+                  <a href="#GooCanvasText.properties" class="shortcut">Properties</a>
+</td></tr>
+</table>
+<div class="refentry" title="GooCanvasText">
+<a name="GooCanvasText"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GooCanvasText.top_of_page"></a>GooCanvasText</span></h2>
+<p>GooCanvasText — a text item.</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv" title="Synopsis">
+<a name="GooCanvasText.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">                    <a class="link" href="GooCanvasText.html#GooCanvasText-struct" title="GooCanvasText">GooCanvasText</a>;
+<a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>*      <a class="link" href="GooCanvasText.html#goo-canvas-text-new" title="goo_canvas_text_new ()">goo_canvas_text_new</a>                 (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
+                                                         <em class="parameter"><code>const <span class="type">char</span> *string</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> width</code></em>,
+                                                         <em class="parameter"><code><span class="type">GtkAnchorType</span> anchor</code></em>,
+                                                         <em class="parameter"><code>...</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="GooCanvasText.html#goo-canvas-text-get-natural-extents" title="goo_canvas_text_get_natural_extents ()">goo_canvas_text_get_natural_extents</a> (<em class="parameter"><code><a class="link" href="GooCanvasText.html" title="GooCanvasText"><span class="type">GooCanvasText</span></a> *text</code></em>,
+                                                         <em class="parameter"><code><span class="type">PangoRectangle</span> *ink_rect</code></em>,
+                                                         <em class="parameter"><code><span class="type">PangoRectangle</span> *logical_rect</code></em>);
+</pre>
+</div>
+<div class="refsect1" title="Object Hierarchy">
+<a name="GooCanvasText.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----<a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple">GooCanvasItemSimple</a>
+         +----GooCanvasText
+</pre>
+</div>
+<div class="refsect1" title="Implemented Interfaces">
+<a name="GooCanvasText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+GooCanvasText implements
+ <a class="link" href="GooCanvasItem.html" title="GooCanvasItem">GooCanvasItem</a>.</p>
+</div>
+<div class="refsect1" title="Properties">
+<a name="GooCanvasText.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--alignment" title='The "alignment" property'>alignment</a>"                <span class="type">PangoAlignment</span>        : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--anchor" title='The "anchor" property'>anchor</a>"                   <span class="type">GtkAnchorType</span>         : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <span class="type">PangoEllipsizeMode</span>    : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--height" title='The "height" property'>height</a>"                   <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--use-markup" title='The "use-markup" property'>use-markup</a>"               <span class="type">gboolean</span>              : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--width" title='The "width" property'>width</a>"                    <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--wrap" title='The "wrap" property'>wrap</a>"                     <span class="type">PangoWrapMode</span>         : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--x" title='The "x" property'>x</a>"                        <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="GooCanvasText.html#GooCanvasText--y" title='The "y" property'>y</a>"                        <span class="type">gdouble</span>               : Read / Write
+</pre>
+</div>
+<div class="refsect1" title="Description">
+<a name="GooCanvasText.description"></a><h2>Description</h2>
+<p>
+GooCanvasText represents a text item.
+</p>
+<p>
+It is a subclass of <a class="link" href="GooCanvasItemSimple.html" title="GooCanvasItemSimple"><span class="type">GooCanvasItemSimple</span></a> and so inherits all of the style
+properties such as "fill-color".
+</p>
+<p>
+It also implements the <a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> interface, so you can use the
+<a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> functions such as <a class="link" href="GooCanvasItem.html#goo-canvas-item-raise" title="goo_canvas_item_raise ()"><code class="function">goo_canvas_item_raise()</code></a> and
+<a class="link" href="GooCanvasItem.html#goo-canvas-item-rotate" title="goo_canvas_item_rotate ()"><code class="function">goo_canvas_item_rotate()</code></a>.
+</p>
+<p>
+The <a class="link" href="GooCanvasText.html#GooCanvasText--width" title='The "width" property'><span class="type">"width"</span></a> and <a class="link" href="GooCanvasText.html#GooCanvasText--height" title='The "height" property'><span class="type">"height"</span></a> properties specify the
+area of the item. If it exceeds that area because there is too much text,
+it is clipped. The properties can be set to -1 to disable clipping.
+</p>
+<p>
+To create a <a class="link" href="GooCanvasText.html" title="GooCanvasText"><span class="type">GooCanvasText</span></a> use <a class="link" href="GooCanvasText.html#goo-canvas-text-new" title="goo_canvas_text_new ()"><code class="function">goo_canvas_text_new()</code></a>.
+</p>
+<p>
+To get or set the properties of an existing <a class="link" href="GooCanvasText.html" title="GooCanvasText"><span class="type">GooCanvasText</span></a>, use
+<code class="function">g_object_get()</code> and <code class="function">g_object_set()</code>.
+</p>
+</div>
+<div class="refsect1" title="Details">
+<a name="GooCanvasText.details"></a><h2>Details</h2>
+<div class="refsect2" title="GooCanvasText">
+<a name="GooCanvasText-struct"></a><h3>GooCanvasText</h3>
+<pre class="programlisting">typedef struct _GooCanvasText GooCanvasText;</pre>
+<p>
+The <a class="link" href="GooCanvasText.html#GooCanvasText-struct" title="GooCanvasText"><span class="type">GooCanvasText</span></a> struct contains private data only.
+</p>
+</div>
+<hr>
+<div class="refsect2" title="goo_canvas_text_new ()">
+<a name="goo-canvas-text-new"></a><h3>goo_canvas_text_new ()</h3>
+<pre class="programlisting"><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="returnvalue">GooCanvasItem</span></a>*      goo_canvas_text_new                 (<em class="parameter"><code><a class="link" href="GooCanvasItem.html" title="GooCanvasItem"><span class="type">GooCanvasItem</span></a> *parent</code></em>,
+                                                         <em class="parameter"><code>const <span class="type">char</span> *string</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> width</code></em>,
+                                                         <em class="parameter"><code><span class="type">GtkAnchorType</span> anchor</code></em>,
+                                                         <em class="parameter"><code>...</code></em>);</pre>
+<p>
+Creates a new text item.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
+<td>the parent item, or <code class="literal">NULL</code>. If a parent is specified, it will assume
+ ownership of the item, and the item will automatically be freed when it is
+ removed from the parent. Otherwise call <code class="function">g_object_unref()</code> to free it.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
+<td>the text to display.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
+<td>the x coordinate of the text.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
+<td>the y coordinate of the text.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
+<td>the width of the text item, or -1 for unlimited width.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>anchor</code></em> :</span></p></td>
+<td>the position of the text relative to the given <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>
+ coordinates. For example an anchor of <code class="literal">GDK_ANCHOR_NW</code> will result in the
+ top-left of the text being placed at the given <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> coordinates.
+ An anchor of <code class="literal">GDK_ANCHOR_CENTER</code> will result in the center of the text being
+ placed at the <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> coordinates.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
+<td>optional pairs of property names and values, and a terminating <code class="literal">NULL</code>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> a new text item.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p>
+Here's an example showing how to create a text item with the bottom right
+of the text box placed at (500,500):
+</p>
+<p>
+</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="GooCanvasItem.html">GooCanvasItem</a> </span><span class="symbol">*</span><span class="normal">text </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GooCanvasText.html#goo-canvas-text-new">goo_canvas_text_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">mygroup</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Hello World"</span><span class="symbol">,</span><span class="normal"> </span><span class="number">500.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">500.0</span><span class="symbol">,</span><span class="normal"> </span><span class="number">200.0</span><span class="symbol">,</span><span class="normal"> GTK_ANCHOR_SE</span><span class="symbol">,</span>
+<span class="normal">                                           </span><span class="string">"fill-color"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"blue"</span><span class="symbol">,</span>
+<span class="normal">                                           NULL</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2" title="goo_canvas_text_get_natural_extents ()">
+<a name="goo-canvas-text-get-natural-extents"></a><h3>goo_canvas_text_get_natural_extents ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                goo_canvas_text_get_natural_extents (<em class="parameter"><code><a class="link" href="GooCanvasText.html" title="GooCanvasText"><span class="type">GooCanvasText</span></a> *text</code></em>,
+                                                         <em class="parameter"><code><span class="type">PangoRectangle</span> *ink_rect</code></em>,
+                                                         <em class="parameter"><code><span class="type">PangoRectangle</span> *logical_rect</code></em>);</pre>
+<p>
+Gets the natural extents of the text, in the text item's coordinate space.
+</p>
+<p>
+The final extents of the text may be different, if the text item is placed
+in a layout container such as <a class="link" href="GooCanvasTable.html" title="GooCanvasTable"><span class="type">GooCanvasTable</span></a>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
+<td>a <a class="link" href="GooCanvasText.html" title="GooCanvasText"><span class="type">GooCanvasText</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>ink_rect</code></em> :</span></p></td>
+<td>the location to return the ink rect, or <code class="literal">NULL</code>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>logical_rect</code></em> :</span></p></td>
+<td>the location to return the logical rect, or <code class="literal">NULL</code>.
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<div class="refsect1" title="Property Details">
+<a name="GooCanvasText.property-details"></a><h2>Property Details</h2>
+<div class="refsect2" title='The "alignment" property'>
+<a name="GooCanvasText--alignment"></a><h3>The <code class="literal">"alignment"</code> property</h3>
+<pre class="programlisting">  "alignment"                <span class="type">PangoAlignment</span>        : Read / Write</pre>
+<p>How to align the text.</p>
+<p>Default value: PANGO_ALIGN_LEFT</p>
+</div>
+<hr>
+<div class="refsect2" title='The "anchor" property'>
+<a name="GooCanvasText--anchor"></a><h3>The <code class="literal">"anchor"</code> property</h3>
+<pre class="programlisting">  "anchor"                   <span class="type">GtkAnchorType</span>         : Read / Write</pre>
+<p>How to position the text relative to the given x and y coordinates.</p>
+<p>Default value: GTK_ANCHOR_NORTH_WEST</p>
+</div>
+<hr>
+<div class="refsect2" title='The "ellipsize" property'>
+<a name="GooCanvasText--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
+<pre class="programlisting">  "ellipsize"                <span class="type">PangoEllipsizeMode</span>    : Read / Write</pre>
+<p>The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.</p>
+<p>Default value: PANGO_ELLIPSIZE_NONE</p>
+</div>
+<hr>
+<div class="refsect2" title='The "height" property'>
+<a name="GooCanvasText--height"></a><h3>The <code class="literal">"height"</code> property</h3>
+<pre class="programlisting">  "height"                   <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The height to use to layout the text, or -1 to let the text use as much vertical space as needed.</p>
+<p>Default value: -1</p>
+</div>
+<hr>
+<div class="refsect2" title='The "text" property'>
+<a name="GooCanvasText--text"></a><h3>The <code class="literal">"text"</code> property</h3>
+<pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
+<p>The text to display.</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2" title='The "use-markup" property'>
+<a name="GooCanvasText--use-markup"></a><h3>The <code class="literal">"use-markup"</code> property</h3>
+<pre class="programlisting">  "use-markup"               <span class="type">gboolean</span>              : Read / Write</pre>
+<p>Whether to parse PangoMarkup in the text, to support different styles.</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2" title='The "width" property'>
+<a name="GooCanvasText--width"></a><h3>The <code class="literal">"width"</code> property</h3>
+<pre class="programlisting">  "width"                    <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The width to use to layout the text, or -1 to let the text use as much horizontal space as needed.</p>
+<p>Default value: -1</p>
+</div>
+<hr>
+<div class="refsect2" title='The "wrap" property'>
+<a name="GooCanvasText--wrap"></a><h3>The <code class="literal">"wrap"</code> property</h3>
+<pre class="programlisting">  "wrap"                     <span class="type">PangoWrapMode</span>         : Read / Write</pre>
+<p>The preferred method of wrapping the string if a width has been set.</p>
+<p>Default value: PANGO_WRAP_WORD</p>
+</div>
+<hr>
+<div class="refsect2" title='The "x" property'>
+<a name="GooCanvasText--x"></a><h3>The <code class="literal">"x"</code> property</h3>
+<pre class="programlisting">  "x"                        <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The x coordinate of the text.</p>
+<p>Default value: 0</p>
+</div>
+<hr>
+<div class="refsect2" title='The "y" property'>
+<a name="GooCanvasText--y"></a><h3>The <code class="literal">"y"</code> property</h3>
+<pre class="programlisting">  "y"                        <span class="type">gdouble</span>               : Read / Write</pre>
+<p>The y coordinate of the text.</p>
+<p>Default value: 0</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.14</div>
+</body>
+</html>