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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>go-color-group</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="ch09.html" title="Selectors">
<link rel="prev" href="GOCalendarButton.html" title="GOCalendarButton">
<link rel="next" href="GOComboColor.html" title="GOComboColor">
<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="GOCalendarButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch09.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="GOComboColor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#goffice-0.8-go-color-group.synopsis" class="shortcut">Top</a>
|
<a href="#goffice-0.8-go-color-group.description" class="shortcut">Description</a>
|
<a href="#goffice-0.8-go-color-group.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#goffice-0.8-go-color-group.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="go-color-group">
<a name="goffice-0.8-go-color-group"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="goffice-0.8-go-color-group.top_of_page"></a>go-color-group</span></h2>
<p>go-color-group</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="goffice-0.8-go-color-group.synopsis"></a><h2>Synopsis</h2>
<a name="GOColorGroup"></a><pre class="synopsis">#define <a class="link" href="goffice-0.8-go-color-group.html#GO-COLOR-GROUP-HISTORY-SIZE:CAPS" title="GO_COLOR_GROUP_HISTORY_SIZE">GO_COLOR_GROUP_HISTORY_SIZE</a>
<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup-struct" title="GOColorGroup">GOColorGroup</a>;
#define <a class="link" href="goffice-0.8-go-color-group.html#GO-TYPE-COLOR-GROUP:CAPS" title="GO_TYPE_COLOR_GROUP">GO_TYPE_COLOR_GROUP</a>
#define <a class="link" href="goffice-0.8-go-color-group.html#GO-COLOR-GROUP:CAPS" title="GO_COLOR_GROUP()">GO_COLOR_GROUP</a> (obj)
#define <a class="link" href="goffice-0.8-go-color-group.html#GO-IS-COLOR-GROUP:CAPS" title="GO_IS_COLOR_GROUP()">GO_IS_COLOR_GROUP</a> (obj)
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="goffice-0.8-go-color-group.html#go-color-group-get-type" title="go_color_group_get_type ()">go_color_group_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> * <a class="link" href="goffice-0.8-go-color-group.html#go-color-group-find" title="go_color_group_find ()">go_color_group_find</a> (<em class="parameter"><code><span class="type">char</span> const *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> context</code></em>);
<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> * <a class="link" href="goffice-0.8-go-color-group.html#go-color-group-fetch" title="go_color_group_fetch ()">go_color_group_fetch</a> (<em class="parameter"><code><span class="type">char</span> const *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> context</code></em>);
<span class="returnvalue">void</span> <a class="link" href="goffice-0.8-go-color-group.html#go-color-group-add-color" title="go_color_group_add_color ()">go_color_group_add_color</a> (<em class="parameter"><code><a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="type">GOColorGroup</span></a> *cg</code></em>,
<em class="parameter"><code><a class="link" href="goffice-0.8-GOColor.html#GOColor" title="GOColor"><span class="type">GOColor</span></a> c</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="goffice-0.8-go-color-group.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>
+----GOColorGroup
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="goffice-0.8-go-color-group.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup-history-changed" title='The "history-changed" signal'>history-changed</a>" : Run Last
</pre>
</div>
<div class="refsect1" title="Description">
<a name="goffice-0.8-go-color-group.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="goffice-0.8-go-color-group.details"></a><h2>Details</h2>
<div class="refsect2" title="GO_COLOR_GROUP_HISTORY_SIZE">
<a name="GO-COLOR-GROUP-HISTORY-SIZE:CAPS"></a><h3>GO_COLOR_GROUP_HISTORY_SIZE</h3>
<pre class="programlisting">#define GO_COLOR_GROUP_HISTORY_SIZE 8
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GOColorGroup">
<a name="GOColorGroup-struct"></a><h3>GOColorGroup</h3>
<pre class="programlisting">typedef struct _GOColorGroup GOColorGroup;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GO_TYPE_COLOR_GROUP">
<a name="GO-TYPE-COLOR-GROUP:CAPS"></a><h3>GO_TYPE_COLOR_GROUP</h3>
<pre class="programlisting">#define GO_TYPE_COLOR_GROUP (go_color_group_get_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GO_COLOR_GROUP()">
<a name="GO-COLOR-GROUP:CAPS"></a><h3>GO_COLOR_GROUP()</h3>
<pre class="programlisting">#define GO_COLOR_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GO_TYPE_COLOR_GROUP, GOColorGroup))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GO_IS_COLOR_GROUP()">
<a name="GO-IS-COLOR-GROUP:CAPS"></a><h3>GO_IS_COLOR_GROUP()</h3>
<pre class="programlisting">#define GO_IS_COLOR_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GO_TYPE_COLOR_GROUP))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="go_color_group_get_type ()">
<a name="go-color-group-get-type"></a><h3>go_color_group_get_type ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> go_color_group_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="go_color_group_find ()">
<a name="go-color-group-find"></a><h3>go_color_group_find ()</h3>
<pre class="programlisting"><a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> * go_color_group_find (<em class="parameter"><code><span class="type">char</span> const *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> context</code></em>);</pre>
<p>
No reference is added if it is found.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>target name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>an arbitrary id to identify what context to search in
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Look up the name/context specific color-group.
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if it is not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="go_color_group_fetch ()">
<a name="go-color-group-fetch"></a><h3>go_color_group_fetch ()</h3>
<pre class="programlisting"><a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> * go_color_group_fetch (<em class="parameter"><code><span class="type">char</span> const *name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> context</code></em>);</pre>
<p>
if name is NULL or a name not currently in use by another group
then a new group is created and returned. If name was NULL
then the new group is given a unique name prefixed by "__cg_autogen_name__"
(thereby insuring namespace separation).
If name was already used by a group then the reference count is
incremented and a pointer to the group is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>target name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>identifying context
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="type">GOColorGroup</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="go_color_group_add_color ()">
<a name="go-color-group-add-color"></a><h3>go_color_group_add_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> go_color_group_add_color (<em class="parameter"><code><a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="type">GOColorGroup</span></a> *cg</code></em>,
<em class="parameter"><code><a class="link" href="goffice-0.8-GOColor.html#GOColor" title="GOColor"><span class="type">GOColor</span></a> c</code></em>);</pre>
<p>
Potentially slide the history to add the new colour. If it was already in
the history reorder.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cg</code></em> :</span></p></td>
<td>
<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="type">GOColorGroup</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>c</code></em> :</span></p></td>
<td>the color
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="goffice-0.8-go-color-group.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "history-changed" signal'>
<a name="GOColorGroup-history-changed"></a><h3>The <code class="literal">"history-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="goffice-0.8-go-color-group.html#GOColorGroup"><span class="type">GOColorGroup</span></a> *gocolorgroup,
<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>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gocolorgroup</code></em> :</span></p></td>
<td>the object which received the signal.
</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>
|
