← Back to branch summary

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

« back to all changes in this revision

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

Tags: upstream-3.3.90
Import upstream version 3.3.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StDrawingArea.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>StDrawingArea</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="St Reference Manual">
 
8
<link rel="up" href="widgets.html" title="Widgets">
 
9
<link rel="prev" href="StButton.html" title="StButton">
 
10
<link rel="next" href="StEntry.html" title="StEntry">
 
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="StButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="widgets.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">St Reference Manual</th>
 
21
<td><a accesskey="n" href="StEntry.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="#StDrawingArea.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#StDrawingArea.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#StDrawingArea.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#StDrawingArea.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#StDrawingArea.signals" class="shortcut">Signals</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="StDrawingArea"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="StDrawingArea.top_of_page"></a>StDrawingArea</span></h2>
 
40
<p>StDrawingArea — A dynamically-sized Cairo drawing area</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="StDrawingArea.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="StDrawingArea.html#StDrawingArea-struct" title="struct StDrawingArea">StDrawingArea</a>;
 
47
struct              <a class="link" href="StDrawingArea.html#StDrawingAreaClass" title="struct StDrawingAreaClass">StDrawingAreaClass</a>;
 
48
<span class="returnvalue">cairo_t</span> *           <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><span class="type">guint</span> *width</code></em>,
 
51
                                                         <em class="parameter"><code><span class="type">guint</span> *height</code></em>);
 
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>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="StDrawingArea.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  GObject
 
59
   +----GInitiallyUnowned
 
60
         +----ClutterActor
 
61
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
 
62
                     +----StDrawingArea
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1">
 
66
<a name="StDrawingArea.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
67
<p>
 
68
StDrawingArea implements
 
69
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable and  AtkImplementorIface.</p>
 
70
</div>
 
71
<div class="refsect1">
 
72
<a name="StDrawingArea.signals"></a><h2>Signals</h2>
 
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>
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="StDrawingArea.description"></a><h2>Description</h2>
 
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
 
81
it allows drawing via Cairo; the primary difference is that
 
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
signal, and inside the signal handler, call
 
84
<a class="link" href="StDrawingArea.html#st-drawing-area-get-context" title="st_drawing_area_get_context ()"><code class="function">st_drawing_area_get_context()</code></a> to get the Cairo context to draw to.  The
 
85
<a class="link" href="StDrawingArea.html#StDrawingArea-repaint" title='The "repaint" signal'><span class="type">"repaint"</span></a> signal will be emitted by default when the area is
 
86
resized or the CSS style changes; you can use the
 
87
<a class="link" href="StDrawingArea.html#st-drawing-area-queue-repaint" title="st_drawing_area_queue_repaint ()"><code class="function">st_drawing_area_queue_repaint()</code></a> as well.
 
88
</p>
 
89
</div>
 
90
<div class="refsect1">
 
91
<a name="StDrawingArea.details"></a><h2>Details</h2>
 
92
<div class="refsect2">
 
93
<a name="StDrawingArea-struct"></a><h3>struct StDrawingArea</h3>
 
94
<pre class="programlisting">struct StDrawingArea;</pre>
 
95
</div>
 
96
<hr>
 
97
<div class="refsect2">
 
98
<a name="StDrawingAreaClass"></a><h3>struct StDrawingAreaClass</h3>
 
99
<pre class="programlisting">struct StDrawingAreaClass {
 
100
    StWidgetClass parent_class;
 
101
 
 
102
    void (*repaint) (StDrawingArea *area);
 
103
};
 
104
</pre>
 
105
</div>
 
106
<hr>
 
107
<div class="refsect2">
 
108
<a name="st-drawing-area-get-context"></a><h3>st_drawing_area_get_context ()</h3>
 
109
<pre class="programlisting"><span class="returnvalue">cairo_t</span> *           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>
 
110
<p>
 
111
Gets the Cairo context to paint to. This function must only be called
 
112
from a signal hander for the ::repaint signal.
 
113
</p>
 
114
<div class="variablelist"><table border="0">
 
115
<col align="left" valign="top">
 
116
<tbody>
 
117
<tr>
 
118
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
 
119
<td>the <a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a>
 
120
</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
124
<td>the Cairo context for the paint operation. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
125
</td>
 
126
</tr>
 
127
</tbody>
 
128
</table></div>
 
129
</div>
 
130
<hr>
 
131
<div class="refsect2">
 
132
<a name="st-drawing-area-get-surface-size"></a><h3>st_drawing_area_get_surface_size ()</h3>
 
133
<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>,
 
134
                                                         <em class="parameter"><code><span class="type">guint</span> *width</code></em>,
 
135
                                                         <em class="parameter"><code><span class="type">guint</span> *height</code></em>);</pre>
 
136
<p>
 
137
Gets the size of the cairo surface being painted to, which is equal
 
138
to the size of the content area of the widget. This function must
 
139
only be called from a signal hander for the ::repaint signal.
 
140
</p>
 
141
<div class="variablelist"><table border="0">
 
142
<col align="left" valign="top">
 
143
<tbody>
 
144
<tr>
 
145
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
 
146
<td>the <a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a>
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 
151
<td>location to store the width of the painted area. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
152
</td>
 
153
</tr>
 
154
<tr>
 
155
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 
156
<td>location to store the height of the painted area. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
157
</td>
 
158
</tr>
 
159
</tbody>
 
160
</table></div>
 
161
</div>
 
162
<hr>
 
163
<div class="refsect2">
 
164
<a name="st-drawing-area-queue-repaint"></a><h3>st_drawing_area_queue_repaint ()</h3>
 
165
<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>
 
166
<p>
 
167
Will cause the actor to emit a ::repaint signal before it is next
 
168
drawn to the scene. Useful if some parameters for the area being
 
169
drawn other than the size or style have changed. Note that
 
170
<code class="function">clutter_actor_queue_redraw()</code> will simply result in the same
 
171
contents being drawn to the scene again.
 
172
</p>
 
173
<div class="variablelist"><table border="0">
 
174
<col align="left" valign="top">
 
175
<tbody><tr>
 
176
<td><p><span class="term"><em class="parameter"><code>area</code></em> :</span></p></td>
 
177
<td>the <a class="link" href="StDrawingArea.html" title="StDrawingArea"><span class="type">StDrawingArea</span></a>
 
178
</td>
 
179
</tr></tbody>
 
180
</table></div>
 
181
</div>
 
182
</div>
 
183
<div class="refsect1">
 
184
<a name="StDrawingArea.signal-details"></a><h2>Signal Details</h2>
 
185
<div class="refsect2">
 
186
<a name="StDrawingArea-repaint"></a><h3>The <code class="literal">"repaint"</code> signal</h3>
 
187
<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,
 
188
                                                        <span class="type">gpointer</span>       user_data)          : <code class="literal">Run Last</code></pre>
 
189
</div>
 
190
</div>
 
191
</div>
 
192
<div class="footer">
 
193
<hr>
 
194
          Generated by GTK-Doc V1.18.1</div>
 
195
</body>
 
196
</html>
 
 
b'\\ No newline at end of file'