1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GogErrorBar</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
<link rel="start" href="index.html" title="Goffice Reference Manual">
8
<link rel="up" href="ch01.html" title="Objects">
9
<link rel="prev" href="goffice-06-gog-grid-line.html" title="GogGridLine">
10
<link rel="next" href="goffice-06-gog-label.html" title="GogLabel">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="pt01.html" title="Part I. Graphs">
14
<link rel="chapter" href="ch01.html" title="Objects">
15
<link rel="chapter" href="ch02.html" title="Abstract Base Classes">
16
<link rel="chapter" href="ch03.html" title="Utilities">
17
<link rel="part" href="pt02.html" title="Part II. Widgets">
18
<link rel="chapter" href="ch04.html" title="Base widgets">
19
<link rel="chapter" href="ch05.html" title="Selectors">
20
<link rel="part" href="pt03.html" title="Part III. Utilities">
21
<link rel="chapter" href="ch06.html" title="Graphic object properties">
22
<link rel="chapter" href="ch07.html" title="Rendering utilities">
23
<link rel="chapter" href="ch08.html" title="Data">
24
<link rel="chapter" href="ch09.html" title="Mathematical functions">
25
<link rel="chapter" href="ch10.html" title="File utilities">
26
<link rel="chapter" href="ch11.html" title="Application">
27
<link rel="chapter" href="ch12.html" title="Components">
28
<link rel="chapter" href="ch13.html" title="Miscellaneous">
30
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
31
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
33
<td><a accesskey="p" href="goffice-06-gog-grid-line.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
34
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
35
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
36
<th width="100%" align="center">Goffice Reference Manual</th>
37
<td><a accesskey="n" href="goffice-06-gog-label.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
39
<tr><td colspan="5" class="shortcuts">
40
<a href="#goffice-06-gog-error-bar.synopsis" class="shortcut">Top</a>
42
<a href="#goffice-06-gog-error-bar.description" class="shortcut">Description</a>
44
<a href="#goffice-06-gog-error-bar.object-hierarchy" class="shortcut">Object Hierarchy</a>
46
<a href="#goffice-06-gog-error-bar.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
49
<div class="refentry" lang="en">
50
<a name="goffice-06-gog-error-bar"></a><div class="titlepage"></div>
51
<div class="refnamediv"><table width="100%"><tr>
53
<h2><span class="refentrytitle"><a name="goffice-06-gog-error-bar.top_of_page"></a>GogErrorBar</span></h2>
54
<p>GogErrorBar — Error bars</p>
56
<td valign="top" align="right"></td>
58
<div class="refsynopsisdiv">
59
<a name="goffice-06-gog-error-bar.synopsis"></a><h2>Synopsis</h2>
60
<a name="GogErrorBar"></a><pre class="synopsis">
61
enum <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBarType" title="enum GogErrorBarType">GogErrorBarType</a>;
62
enum <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBarDisplay" title="enum GogErrorBarDisplay">GogErrorBarDisplay</a>;
63
<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar-struct" title="GogErrorBar">GogErrorBar</a>;
64
#define <a class="link" href="goffice-06-gog-error-bar.html#GOG-ERROR-BAR-TYPE:CAPS" title="GOG_ERROR_BAR_TYPE">GOG_ERROR_BAR_TYPE</a>
65
#define <a class="link" href="goffice-06-gog-error-bar.html#GOG-ERROR-BAR:CAPS" title="GOG_ERROR_BAR()">GOG_ERROR_BAR</a> (o)
66
#define <a class="link" href="goffice-06-gog-error-bar.html#IS-GOG-ERROR-BAR:CAPS" title="IS_GOG_ERROR_BAR()">IS_GOG_ERROR_BAR</a> (o)
67
GType <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-get-type" title="gog_error_bar_get_type ()">gog_error_bar_get_type</a> (void);
68
<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> * <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-dup" title="gog_error_bar_dup ()">gog_error_bar_dup</a> (<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> const *bar);
69
gpointer <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-prefs" title="gog_error_bar_prefs ()">gog_error_bar_prefs</a> (<a
70
href="/local/gnome/test/share/gtk-doc/html/goffice/GogSeries.html"
71
>GogSeries</a> *series,
74
<a class="link" href="GogDataAllocator.html" title="GogDataAllocator">GogDataAllocator</a> *dalloc,
76
gboolean <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-get-bounds" title="gog_error_bar_get_bounds ()">gog_error_bar_get_bounds</a> (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
80
void <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-get-minmax" title="gog_error_bar_get_minmax ()">gog_error_bar_get_minmax</a> (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
83
void <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-render" title="gog_error_bar_render ()">gog_error_bar_render</a> (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
85
href="/local/gnome/test/share/gtk-doc/html/goffice/GogRenderer.html"
86
>GogRenderer</a> *rend,
87
<a class="link" href="goffice-06-gog-axis.html#GogAxisMap" title="GogAxisMap">GogAxisMap</a> *x_map,
88
<a class="link" href="goffice-06-gog-axis.html#GogAxisMap" title="GogAxisMap">GogAxisMap</a> *y_map,
94
gboolean <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-is-visible" title="gog_error_bar_is_visible ()">gog_error_bar_is_visible</a> (<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar);
97
<div class="refsect1" lang="en">
98
<a name="goffice-06-gog-error-bar.object-hierarchy"></a><h2>Object Hierarchy</h2>
99
<pre class="synopsis">
104
<div class="refsect1" lang="en">
105
<a name="goffice-06-gog-error-bar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
107
GogErrorBar implements
109
href="/local/gnome/test/share/gtk-doc/html/goffice/GogPersist.html"
112
<div class="refsect1" lang="en">
113
<a name="goffice-06-gog-error-bar.description"></a><h2>Description</h2>
118
<div class="refsect1" lang="en">
119
<a name="goffice-06-gog-error-bar.details"></a><h2>Details</h2>
120
<div class="refsect2" lang="en">
121
<a name="GogErrorBarType"></a><h3>enum GogErrorBarType</h3>
122
<pre class="programlisting">typedef enum {
123
GOG_ERROR_BAR_TYPE_NONE,
124
GOG_ERROR_BAR_TYPE_ABSOLUTE,
125
GOG_ERROR_BAR_TYPE_RELATIVE,
126
GOG_ERROR_BAR_TYPE_PERCENT
134
<div class="refsect2" lang="en">
135
<a name="GogErrorBarDisplay"></a><h3>enum GogErrorBarDisplay</h3>
136
<pre class="programlisting">typedef enum {
137
GOG_ERROR_BAR_DISPLAY_NONE,
138
GOG_ERROR_BAR_DISPLAY_POSITIVE,
139
GOG_ERROR_BAR_DISPLAY_NEGATIVE,
140
GOG_ERROR_BAR_DISPLAY_BOTH
141
} GogErrorBarDisplay;
148
<div class="refsect2" lang="en">
149
<a name="GogErrorBar-struct"></a><h3>GogErrorBar</h3>
150
<pre class="programlisting">typedef struct _GogErrorBar GogErrorBar;</pre>
156
<div class="refsect2" lang="en">
157
<a name="GOG-ERROR-BAR-TYPE:CAPS"></a><h3>GOG_ERROR_BAR_TYPE</h3>
158
<pre class="programlisting">#define GOG_ERROR_BAR_TYPE (gog_error_bar_get_type ())
165
<div class="refsect2" lang="en">
166
<a name="GOG-ERROR-BAR:CAPS"></a><h3>GOG_ERROR_BAR()</h3>
167
<pre class="programlisting">#define GOG_ERROR_BAR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_ERROR_BAR_TYPE, GogErrorBar))
172
<div class="variablelist"><table border="0">
173
<col align="left" valign="top">
175
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
184
<div class="refsect2" lang="en">
185
<a name="IS-GOG-ERROR-BAR:CAPS"></a><h3>IS_GOG_ERROR_BAR()</h3>
186
<pre class="programlisting">#define IS_GOG_ERROR_BAR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_ERROR_BAR_TYPE))
191
<div class="variablelist"><table border="0">
192
<col align="left" valign="top">
194
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
203
<div class="refsect2" lang="en">
204
<a name="gog-error-bar-get-type"></a><h3>gog_error_bar_get_type ()</h3>
205
<pre class="programlisting">GType gog_error_bar_get_type (void);</pre>
209
<div class="variablelist"><table border="0">
210
<col align="left" valign="top">
212
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
221
<div class="refsect2" lang="en">
222
<a name="gog-error-bar-dup"></a><h3>gog_error_bar_dup ()</h3>
223
<pre class="programlisting"><a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> * gog_error_bar_dup (<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> const *bar);</pre>
227
<div class="variablelist"><table border="0">
228
<col align="left" valign="top">
231
<td><p><span class="term"><em class="parameter"><code>bar</code></em> :</span></p></td>
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
246
<div class="refsect2" lang="en">
247
<a name="gog-error-bar-prefs"></a><h3>gog_error_bar_prefs ()</h3>
248
<pre class="programlisting">gpointer gog_error_bar_prefs (<a
249
href="/local/gnome/test/share/gtk-doc/html/goffice/GogSeries.html"
250
>GogSeries</a> *series,
251
char const *property,
253
<a class="link" href="GogDataAllocator.html" title="GogDataAllocator">GogDataAllocator</a> *dalloc,
254
GOCmdContext *cc);</pre>
258
<div class="variablelist"><table border="0">
259
<col align="left" valign="top">
262
<td><p><span class="term"><em class="parameter"><code>series</code></em> :</span></p></td>
267
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
272
<td><p><span class="term"><em class="parameter"><code>horizontal</code></em> :</span></p></td>
277
<td><p><span class="term"><em class="parameter"><code>dalloc</code></em> :</span></p></td>
282
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
287
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
297
<div class="refsect2" lang="en">
298
<a name="gog-error-bar-get-bounds"></a><h3>gog_error_bar_get_bounds ()</h3>
299
<pre class="programlisting">gboolean gog_error_bar_get_bounds (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
304
If the value correponding to <em class="parameter"><code>index</code></em> is valid, fills min and max with the error values:
305
-> positive_error in <em class="parameter"><code>max</code></em>.
306
-> negative_error in <em class="parameter"><code>min</code></em>.
307
If one of the errors is not valid or not defined, its value is set to -1.0.
310
Return value : FALSE if the <em class="parameter"><code>bar->type</code></em> is GOG_ERROR_BAR_TYPE_NONE or if the value is not valid,
315
<div class="variablelist"><table border="0">
316
<col align="left" valign="top">
319
<td><p><span class="term"><em class="parameter"><code>bar</code></em> :</span></p></td>
324
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
325
<td> the index corresponding to the value which error limits are
329
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
330
<td> where the minimum value will be stored
334
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
335
<td> where the maximum value will be stored
339
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
349
<div class="refsect2" lang="en">
350
<a name="gog-error-bar-get-minmax"></a><h3>gog_error_bar_get_minmax ()</h3>
351
<pre class="programlisting">void gog_error_bar_get_minmax (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
357
<div class="variablelist"><table border="0">
358
<col align="left" valign="top">
361
<td><p><span class="term"><em class="parameter"><code>bar</code></em> :</span></p></td>
366
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
371
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
381
<div class="refsect2" lang="en">
382
<a name="gog-error-bar-render"></a><h3>gog_error_bar_render ()</h3>
383
<pre class="programlisting">void gog_error_bar_render (const <a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar,
385
href="/local/gnome/test/share/gtk-doc/html/goffice/GogRenderer.html"
386
>GogRenderer</a> *rend,
387
<a class="link" href="goffice-06-gog-axis.html#GogAxisMap" title="GogAxisMap">GogAxisMap</a> *x_map,
388
<a class="link" href="goffice-06-gog-axis.html#GogAxisMap" title="GogAxisMap">GogAxisMap</a> *y_map,
393
gboolean horizontal);</pre>
395
Displays the error bar. If <em class="parameter"><code>plus</code></em> is negative, the positive side of the bar is not displayed,
396
and if <em class="parameter"><code>minus</code></em> is negative, the negative side of the bar is not displayed.
397
x_map and y_map are used to convert coordinates from data space to canvas coordinates.
398
This function must not be called if <a class="link" href="goffice-06-gog-error-bar.html#gog-error-bar-get-bounds" title="gog_error_bar_get_bounds ()"><span class="type">gog_error_bar_get_bounds</span></a> returned FALSE.</p>
402
<div class="variablelist"><table border="0">
403
<col align="left" valign="top">
406
<td><p><span class="term"><em class="parameter"><code>bar</code></em> :</span></p></td>
411
<td><p><span class="term"><em class="parameter"><code>rend</code></em> :</span></p></td>
416
<td><p><span class="term"><em class="parameter"><code>x_map</code></em> :</span></p></td>
417
<td> A GogAxisMap for the x axis
421
<td><p><span class="term"><em class="parameter"><code>y_map</code></em> :</span></p></td>
422
<td> A GogAxisMap for the y axis
426
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
427
<td> x coordinate of the origin of the bar
431
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
432
<td> y coordinate of the origin of the bar
436
<td><p><span class="term"><em class="parameter"><code>minus</code></em> :</span></p></td>
437
<td> distance from the origin to the negative end of the bar
441
<td><p><span class="term"><em class="parameter"><code>plus</code></em> :</span></p></td>
442
<td> distance from the origin to the positive end of the bar
446
<td><p><span class="term"><em class="parameter"><code>horizontal</code></em> :</span></p></td>
447
<td> whether the bar is horizontal or not.
454
<div class="refsect2" lang="en">
455
<a name="gog-error-bar-is-visible"></a><h3>gog_error_bar_is_visible ()</h3>
456
<pre class="programlisting">gboolean gog_error_bar_is_visible (<a class="link" href="goffice-06-gog-error-bar.html#GogErrorBar">GogErrorBar</a> *bar);</pre>
460
<div class="variablelist"><table border="0">
461
<col align="left" valign="top">
464
<td><p><span class="term"><em class="parameter"><code>bar</code></em> :</span></p></td>
469
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
482
Generated by GTK-Doc V1.11</div>