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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GOColorGroup: GOffice Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GOffice Reference Manual">
<link rel="up" href="ch08.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.33.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GOColorGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GOColorGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GOColorGroup.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GOCalendarButton.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GOComboColor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GOColorGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GOColorGroup.top_of_page"></a>GOColorGroup</span></h2>
<p>GOColorGroup</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GOColorGroup.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GOColorGroup.html#go-color-group-add-color" title="go_color_group_add_color ()">go_color_group_add_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GOColorGroup.html" title="GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="GOColorGroup.html#go-color-group-fetch" title="go_color_group_fetch ()">go_color_group_fetch</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GOColorGroup.html" title="GOColorGroup"><span class="returnvalue">GOColorGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="GOColorGroup.html#go-color-group-find" title="go_color_group_find ()">go_color_group_find</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GOColorGroup.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GOColorGroup.html#GOColorGroup-history-changed" title="The “history-changed” signal">history-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GOColorGroup.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GOColorGroup.html#GOColorGroup-struct" title="GOColorGroup">GOColorGroup</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GOColorGroup.html#GO-COLOR-GROUP-HISTORY-SIZE:CAPS" title="GO_COLOR_GROUP_HISTORY_SIZE">GO_COLOR_GROUP_HISTORY_SIZE</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GOColorGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GOColorGroup
</pre>
</div>
<div class="refsect1">
<a name="GOColorGroup.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GOColorGroup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<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="GOColorGroup.html" title="GOColorGroup"><span class="type">GOColorGroup</span></a> *cg</code></em>,
<em class="parameter"><code><a class="link" href="goffice-0.10-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="refsect3">
<a name="go-color-group-add-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cg</p></td>
<td class="parameter_description"><p><a class="link" href="GOColorGroup.html" title="GOColorGroup"><span class="type">GOColorGroup</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>c</p></td>
<td class="parameter_description"><p>the color</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="go-color-group-fetch"></a><h3>go_color_group_fetch ()</h3>
<pre class="programlisting"><a class="link" href="GOColorGroup.html" title="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><span class="type">gpointer</span> 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="refsect3">
<a name="go-color-group-fetch.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>target name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>identifying context</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="go-color-group-fetch.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="GOColorGroup.html" title="GOColorGroup"><span class="type">GOColorGroup</span></a>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="go-color-group-find"></a><h3>go_color_group_find ()</h3>
<pre class="programlisting"><a class="link" href="GOColorGroup.html" title="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><span class="type">gpointer</span> context</code></em>);</pre>
<p>No reference is added if it is found.</p>
<div class="refsect3">
<a name="go-color-group-find.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>target name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>an arbitrary id to identify what context to search in</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="go-color-group-find.returns"></a><h4>Returns</h4>
<p>Look up the name/context specific color-group.
<code class="literal">NULL</code> if it is not found. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GOColorGroup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GOColorGroup-struct"></a><h3>GOColorGroup</h3>
<pre class="programlisting">typedef struct _GOColorGroup GOColorGroup;</pre>
</div>
<hr>
<div class="refsect2">
<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>
</div>
</div>
<div class="refsect1">
<a name="GOColorGroup.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<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="GOColorGroup.html" title="GOColorGroup"><span class="type">GOColorGroup</span></a> *gocolorgroup,
<span class="type">gpointer</span> user_data)</pre>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|