← Back to branch summary

~ubuntu-branches/ubuntu/raring/gnome-shell/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/st/html/StDrawingArea.html

  • Committer: Package Import Robot
  • Author(s): Tim Lunn
  • Date: 2013-02-21 11:55:19 UTC
  • mfrom: (1.1.48)
  • Revision ID: package-import@ubuntu.com-20130221115519-ds607jwrcatdfvse
Tags: 3.6.3.1-0ubuntu1
https://launchpad.net/bugs/1128804
* New upstream release (LP: #1128804)
* debian/patches:
  - git_messagetray_fix_expansion.patch, Drop applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StDrawingArea.html
8
8
<link rel="up" href="widgets.html" title="Widgets">
9
9
<link rel="prev" href="StButton.html" title="StButton">
10
10
<link rel="next" href="StEntry.html" title="StEntry">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
<a name="StDrawingArea.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct              <a class="link" href="StDrawingArea.html#StDrawingArea-struct" title="struct StDrawingArea">StDrawingArea</a>;
47
47
struct              <a class="link" href="StDrawingArea.html#StDrawingAreaClass" title="struct StDrawingAreaClass">StDrawingAreaClass</a>;
 
48
<a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="returnvalue">cairo_t</span></a> *           <a class="link" href="StDrawingArea.html#st-drawing-area-get-context" title="st_drawing_area_get_context ()">st_drawing_area_get_context</a>         (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="StDrawingArea.html#st-drawing-area-get-surface-size" title="st_drawing_area_get_surface_size ()">st_drawing_area_get_surface_size</a>    (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>,
 
50
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *width</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *height</code></em>);
48
52
<span class="returnvalue">void</span>                <a class="link" href="StDrawingArea.html#st-drawing-area-queue-repaint" title="st_drawing_area_queue_repaint ()">st_drawing_area_queue_repaint</a>       (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);
49
 
<a href="/home/florian/opt/gnome/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="returnvalue">cairo_t</span></a> *           <a class="link" href="StDrawingArea.html#st-drawing-area-get-context" title="st_drawing_area_get_context ()">st_drawing_area_get_context</a>         (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);
50
 
<span class="returnvalue">void</span>                <a class="link" href="StDrawingArea.html#st-drawing-area-get-surface-size" title="st_drawing_area_get_surface_size ()">st_drawing_area_get_surface_size</a>    (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>,
51
 
                                                         <em class="parameter"><code><span class="type">guint</span> *width</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">guint</span> *height</code></em>);
53
53
</pre>
54
54
</div>
55
55
<div class="refsect1">
56
56
<a name="StDrawingArea.object-hierarchy"></a><h2>Object Hierarchy</h2>
57
57
<pre class="synopsis">
58
 
  GObject
59
 
   +----GInitiallyUnowned
60
 
         +----ClutterActor
 
58
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
59
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
60
         +----<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>
61
61
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
62
62
                     +----StDrawingArea
63
63
</pre>
66
66
<a name="StDrawingArea.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
67
67
<p>
68
68
StDrawingArea implements
69
 
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable and  AtkImplementorIface.</p>
 
69
 <a href="/usr/share/gtk-doc/html/clutter/ClutterContainer.html">ClutterContainer</a>,  <a href="/usr/share/gtk-doc/html/clutter/ClutterScriptable.html">ClutterScriptable</a>,  <a href="/usr/share/gtk-doc/html/clutter/ClutterAnimatable.html">ClutterAnimatable</a> and  AtkImplementorIface.</p>
70
70
</div>
71
71
<div class="refsect1">
72
72
<a name="StDrawingArea.signals"></a><h2>Signals</h2>
73
73
<pre class="synopsis">
74
 
  "<a class="link" href="StDrawingArea.html#StDrawingArea-repaint" title='The "repaint" signal'>repaint</a>"                                        : <code class="literal">Run Last</code>
 
74
  "<a class="link" href="StDrawingArea.html#StDrawingArea-repaint" title='The "repaint" signal'>repaint</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
75
75
</pre>
76
76
</div>
77
77
<div class="refsect1">
78
78
<a name="StDrawingArea.description"></a><h2>Description</h2>
79
79
<p>
80
 
<a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> is similar to <span class="type">ClutterCairoTexture</span> in that
 
80
<a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> is similar to <a href="/usr/share/gtk-doc/html/clutter/ClutterCairoTexture.html"><span class="type">ClutterCairoTexture</span></a> in that
81
81
it allows drawing via Cairo; the primary difference is that
82
82
it is dynamically sized.  To use, connect to the <a class="link" href="StDrawingArea.html#StDrawingArea-repaint" title='The "repaint" signal'><span class="type">"repaint"</span></a>
83
83
signal, and inside the signal handler, call
105
105
</div>
106
106
<hr>
107
107
<div class="refsect2">
108
 
<a name="st-drawing-area-queue-repaint"></a><h3>st_drawing_area_queue_repaint ()</h3>
109
 
<pre class="programlisting"><span class="returnvalue">void</span>                st_drawing_area_queue_repaint       (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);</pre>
110
 
<p>
111
 
Will cause the actor to emit a ::repaint signal before it is next
112
 
drawn to the scene. Useful if some parameters for the area being
113
 
drawn other than the size or style have changed. Note that
114
 
<code class="function">clutter_actor_queue_redraw()</code> will simply result in the same
115
 
contents being drawn to the scene again.
116
 
</p>
117
 
<div class="variablelist"><table border="0" class="variablelist">
118
 
<colgroup>
119
 
<col align="left" valign="top">
120
 
<col>
121
 
</colgroup>
122
 
<tbody><tr>
123
 
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
124
 
<td>the <a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a>
125
 
</td>
126
 
</tr></tbody>
127
 
</table></div>
128
 
</div>
129
 
<hr>
130
 
<div class="refsect2">
131
108
<a name="st-drawing-area-get-context"></a><h3>st_drawing_area_get_context ()</h3>
132
 
<pre class="programlisting"><a href="/home/florian/opt/gnome/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="returnvalue">cairo_t</span></a> *           st_drawing_area_get_context         (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);</pre>
 
109
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="returnvalue">cairo_t</span></a> *           st_drawing_area_get_context         (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);</pre>
133
110
<p>
134
111
Gets the Cairo context to paint to. This function must only be called
135
112
from a signal hander for the ::repaint signal.
157
134
<div class="refsect2">
158
135
<a name="st-drawing-area-get-surface-size"></a><h3>st_drawing_area_get_surface_size ()</h3>
159
136
<pre class="programlisting"><span class="returnvalue">void</span>                st_drawing_area_get_surface_size    (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>,
160
 
                                                         <em class="parameter"><code><span class="type">guint</span> *width</code></em>,
161
 
                                                         <em class="parameter"><code><span class="type">guint</span> *height</code></em>);</pre>
 
137
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *width</code></em>,
 
138
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *height</code></em>);</pre>
162
139
<p>
163
140
Gets the size of the cairo surface being painted to, which is equal
164
141
to the size of the content area of the widget. This function must
188
165
</tbody>
189
166
</table></div>
190
167
</div>
 
168
<hr>
 
169
<div class="refsect2">
 
170
<a name="st-drawing-area-queue-repaint"></a><h3>st_drawing_area_queue_repaint ()</h3>
 
171
<pre class="programlisting"><span class="returnvalue">void</span>                st_drawing_area_queue_repaint       (<em class="parameter"><code><a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *area</code></em>);</pre>
 
172
<p>
 
173
Will cause the actor to emit a ::repaint signal before it is next
 
174
drawn to the scene. Useful if some parameters for the area being
 
175
drawn other than the size or style have changed. Note that
 
176
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-queue-redraw"><code class="function">clutter_actor_queue_redraw()</code></a> will simply result in the same
 
177
contents being drawn to the scene again.
 
178
</p>
 
179
<div class="variablelist"><table border="0" class="variablelist">
 
180
<colgroup>
 
181
<col align="left" valign="top">
 
182
<col>
 
183
</colgroup>
 
184
<tbody><tr>
 
185
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
 
186
<td>the <a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a>
 
187
</td>
 
188
</tr></tbody>
 
189
</table></div>
 
190
</div>
191
191
</div>
192
192
<div class="refsect1">
193
193
<a name="StDrawingArea.signal-details"></a><h2>Signal Details</h2>
194
194
<div class="refsect2">
195
195
<a name="StDrawingArea-repaint"></a><h3>The <code class="literal">"repaint"</code> signal</h3>
196
196
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a> *stdrawingarea,
197
 
                                                        <span class="type">gpointer</span>       user_data)          : <code class="literal">Run Last</code></pre>
 
197
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
198
198
</div>
199
199
</div>
200
200
</div>
201
201
<div class="footer">
202
202
<hr>
203
 
          Generated by GTK-Doc V1.18.1</div>
 
203
          Generated by GTK-Doc V1.18</div>
204
204
</body>
205
205
</html>
 
 
b'\\ No newline at end of file'