File: GocStyledItem.html

package info (click to toggle)
goffice-0.8 0.8.17-7
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 21,692 kB
  • ctags: 13,519
  • sloc: ansic: 88,968; sh: 10,236; makefile: 994; perl: 35; xml: 25
file content (213 lines) | stat: -rw-r--r-- 12,351 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GocStyledItem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Goffice Reference Manual">
<link rel="up" href="ch05.html" title="Base objects">
<link rel="prev" href="GocGroup.html" title="GocGroup">
<link rel="next" href="ch06.html" title="Items">
<meta name="generator" content="GTK-Doc V1.15 (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="GocGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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">Goffice Reference Manual</th>
<td><a accesskey="n" href="ch06.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GocStyledItem.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GocStyledItem.description" class="shortcut">Description</a>
                   | 
                  <a href="#GocStyledItem.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GocStyledItem.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GocStyledItem.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GocStyledItem.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GocStyledItem">
<a name="GocStyledItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GocStyledItem.top_of_page"></a>GocStyledItem</span></h2>
<p>GocStyledItem — Styled items</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GocStyledItem.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="GocStyledItem.html#GocStyledItem-struct" title="GocStyledItem">GocStyledItem</a>;
                    <a class="link" href="GocStyledItem.html#GocStyledItemClass" title="GocStyledItemClass">GocStyledItemClass</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GocStyledItem.html#goc-styled-item-set-cairo-line" title="goc_styled_item_set_cairo_line ()">goc_styled_item_set_cairo_line</a>      (<em class="parameter"><code><a class="link" href="GocStyledItem.html" title="GocStyledItem"><span class="type">GocStyledItem</span></a> const *gsi</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GocStyledItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="GocItem.html" title="GocItem">GocItem</a>
         +----GocStyledItem
               +----<a class="link" href="GocArc.html" title="GocArc">GocArc</a>
               +----<a class="link" href="GocCircle.html" title="GocCircle">GocCircle</a>
               +----<a class="link" href="GocEllipse.html" title="GocEllipse">GocEllipse</a>
               +----<a class="link" href="GocLine.html" title="GocLine">GocLine</a>
               +----GocPath
               +----<a class="link" href="GocPolygon.html" title="GocPolygon">GocPolygon</a>
               +----<a class="link" href="GocPolyline.html" title="GocPolyline">GocPolyline</a>
               +----<a class="link" href="GocRectangle.html" title="GocRectangle">GocRectangle</a>
               +----<a class="link" href="GocText.html" title="GocText">GocText</a>
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GocStyledItem.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GocStyledItem implements
 <a class="link" href="GOStyledObject.html" title="GOStyledObject">GOStyledObject</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="GocStyledItem.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GocStyledItem.html#GocStyledItem--scale-line-width" title='The "scale-line-width" property'>scale-line-width</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="GocStyledItem.html#GocStyledItem--style" title='The "style" property'>style</a>"                    <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>*              : Read / Write
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GocStyledItem.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GocStyledItem.html#GocStyledItem-style-changed" title='The "style-changed" signal'>style-changed</a>"                                  : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GocStyledItem.description"></a><h2>Description</h2>
<p>
The virtual base object for canvas items with style.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GocStyledItem.details"></a><h2>Details</h2>
<div class="refsect2" title="GocStyledItem">
<a name="GocStyledItem-struct"></a><h3>GocStyledItem</h3>
<pre class="programlisting">typedef struct _GocStyledItem GocStyledItem;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GocStyledItemClass">
<a name="GocStyledItemClass"></a><h3>GocStyledItemClass</h3>
<pre class="programlisting">typedef struct {
	/* virtual */
	void	  (*init_style)     	(GocStyledItem *item, GOStyle *style);
} GocStyledItemClass;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="structfield"><code><a name="GocStyledItemClass.init-style"></a>init_style</code></em> ()</span></p></td>
<td>style initialization handler.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="goc_styled_item_set_cairo_line ()">
<a name="goc-styled-item-set-cairo-line"></a><h3>goc_styled_item_set_cairo_line ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            goc_styled_item_set_cairo_line      (<em class="parameter"><code><a class="link" href="GocStyledItem.html" title="GocStyledItem"><span class="type">GocStyledItem</span></a> const *gsi</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>);</pre>
<p>
Prepares the cairo context <em class="parameter"><code>cr</code></em> to draw a line according to the
item style and canvas scale. The line width is scaled only if
the scale-line-width property is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. This function calls
<a class="link" href="GOStyledObject.html#go-styled-object-set-cairo-line" title="go_styled_object_set_cairo_line ()"><code class="function">go_styled_object_set_cairo_line()</code></a>.
</p>
<p>
If the item drawing used <a class="link" href="GocGroup.html#goc-group-cairo-transform" title="goc_group_cairo_transform ()"><code class="function">goc_group_cairo_transform()</code></a>,
scale-line-width should be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to avoid scaling twice, or 
<a class="link" href="GOStyledObject.html#go-styled-object-set-cairo-line" title="go_styled_object_set_cairo_line ()"><code class="function">go_styled_object_set_cairo_line()</code></a> should be called directly instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gsi</code></em> :</span></p></td>
<td>
<a class="link" href="GocStyledItem.html" title="GocStyledItem"><span class="type">GocStyledItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the line is not invisible
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GocStyledItem.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "scale-line-width" property'>
<a name="GocStyledItem--scale-line-width"></a><h3>The <code class="literal">"scale-line-width"</code> property</h3>
<pre class="programlisting">  "scale-line-width"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>Whether to scale the line width when zooming.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2" title='The "style" property'>
<a name="GocStyledItem--style"></a><h3>The <code class="literal">"style"</code> property</h3>
<pre class="programlisting">  "style"                    <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>*              : Read / Write</pre>
<p>A pointer to the GOStyle object.</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="GocStyledItem.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "style-changed" signal'>
<a name="GocStyledItem-style-changed"></a><h3>The <code class="literal">"style-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GocStyledItem.html" title="GocStyledItem"><span class="type">GocStyledItem</span></a> *gsi,
                                                        <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>       *style,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>       user_data)      : Run Last</pre>
<p>
The ::style-changed signal is emitted when a new style
has been set on a styled item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gsi</code></em> :</span></p></td>
<td>the object on which the signal is emitted
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>style</code></em> :</span></p></td>
<td>the new <a class="link" href="GOStyle.html" title="GOStyle"><span class="type">GOStyle</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>