File: v-sim-panelDataFile.html

package info (click to toggle)
v-sim 3.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 15,860 kB
  • sloc: ansic: 75,222; sh: 10,239; makefile: 580; python: 572; cpp: 353; xml: 130
file content (160 lines) | stat: -rw-r--r-- 10,205 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>panelDataFile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch11.html" title="Panel add-ons">
<link rel="prev" href="v-sim-panelVibration.html" title="panelVibration">
<link rel="next" href="v-sim-panelMap.html" title="panelMap">
<meta name="generator" content="GTK-Doc V1.14 (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="v-sim-panelVibration.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch11.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">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-panelMap.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-panelDataFile.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-panelDataFile.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="panelDataFile">
<a name="v-sim-panelDataFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-panelDataFile.top_of_page"></a>panelDataFile</span></h2>
<p>panelDataFile — The tab where to configure the action of an
external data file on colourisation of nodes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-panelDataFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          <a class="link" href="v-sim-panelDataFile.html#panelDataFileInit" title="panelDataFileInit ()">panelDataFileInit</a>                   ();
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="v-sim-panelDataFile.html#panelDataFileLoad-file" title="panelDataFileLoad_file ()">panelDataFileLoad_file</a>              (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *new</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelDataFile.html#panelDataFileSet-use" title="panelDataFileSet_use ()">panelDataFileSet_use</a>                (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> used</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="v-sim-panelDataFile.html#panelDataFileSet-presetShade" title="panelDataFileSet_presetShade ()">panelDataFileSet_presetShade</a>        (<em class="parameter"><code><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> *shade</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelDataFile.html#panelDataFileUpdate" title="panelDataFileUpdate ()">panelDataFileUpdate</a>                 (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-panelDataFile.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-panelDataFile.details"></a><h2>Details</h2>
<div class="refsect2" title="panelDataFileInit ()">
<a name="panelDataFileInit"></a><h3>panelDataFileInit ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          panelDataFileInit                   ();</pre>
</div>
<hr>
<div class="refsect2" title="panelDataFileLoad_file ()">
<a name="panelDataFileLoad-file"></a><h3>panelDataFileLoad_file ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            panelDataFileLoad_file              (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *new</code></em>);</pre>
<p>
Read the given data file and associate the values of each column to
the node. It does not update the widgets of the panel. This is done
to allow to change the values of the colouration before drawing the
widgets. See <a class="link" href="v-sim-panelDataFile.html#panelDataFileUpdate" title="panelDataFileUpdate ()"><code class="function">panelDataFileUpdate()</code></a> to do it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>visuData</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object to associated the data to ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>the file to read ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new</code></em> :</span></p></td>
<td>return TRUE if the loaded data are associated for the
      first time to <em class="parameter"><code>visuData</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-visu-data.html#visu-data-createAllNodes" title="visu_data_createAllNodes ()"><code class="function">visu_data_createAllNodes()</code></a> should be called after.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelDataFileSet_use ()">
<a name="panelDataFileSet-use"></a><h3>panelDataFileSet_use ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelDataFileSet_use                (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> used</code></em>);</pre>
<p>
Set if the panel is used or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>used</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelDataFileSet_presetShade ()">
<a name="panelDataFileSet-presetShade"></a><h3>panelDataFileSet_presetShade ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            panelDataFileSet_presetShade        (<em class="parameter"><code><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> *shade</code></em>);</pre>
<p>
Change the preset <em class="parameter"><code>shade</code></em> used to colourise the data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>shade</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if a <a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> is set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelDataFileUpdate ()">
<a name="panelDataFileUpdate"></a><h3>panelDataFileUpdate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelDataFileUpdate                 (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *visuData</code></em>);</pre>
<p>
Update the widgets depending on the colouration associated to the given
<a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>visuData</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object to associated the data to.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>