File: v-sim-panelConfig.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 (143 lines) | stat: -rw-r--r-- 8,815 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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>panelConfig</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-panelAxes.html" title="panelAxes">
<link rel="next" href="v-sim-gtkAtomic.html" title="gtkAtomic">
<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-panelAxes.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-gtkAtomic.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-panelConfig.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-panelConfig.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="panelConfig">
<a name="v-sim-panelConfig"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-panelConfig.top_of_page"></a>panelConfig</span></h2>
<p>panelConfig — The tab where miscellaneous options are setup.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-panelConfig.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-panelConfig.html#panelConfigInit" title="panelConfigInit ()">panelConfigInit</a>                     ();
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelConfig.html#panelConfigSet-tabView" title="panelConfigSet_tabView ()">panelConfigSet_tabView</a>              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> viewed</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelConfig.html#panelConfigSet-automaticRefresh" title="panelConfigSet_automaticRefresh ()">panelConfigSet_automaticRefresh</a>     (<em class="parameter"><code><a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> bool</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelConfig.html#panelConfigSet-refreshPeriod" title="panelConfigSet_refreshPeriod ()">panelConfigSet_refreshPeriod</a>        (<em class="parameter"><code><a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> val</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-panelConfig.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-panelConfig.details"></a><h2>Details</h2>
<div class="refsect2" title="panelConfigInit ()">
<a name="panelConfigInit"></a><h3>panelConfigInit ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          panelConfigInit                     ();</pre>
<p>
Should be used in the list declared in externalModules.h to be loaded by
V_Sim on start-up. This routine will create the <a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="type">ToolPanel</span></a> where the configuration
stuff can be done, such as the auto-reloading.
</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> a newly created <a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="type">ToolPanel</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelConfigSet_tabView ()">
<a name="panelConfigSet-tabView"></a><h3>panelConfigSet_tabView ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelConfigSet_tabView              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> viewed</code></em>);</pre>
<p>
The note can show its tabs or not. Change this with that method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>viewed</code></em> :</span></p></td>
<td>a boolean value.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelConfigSet_automaticRefresh ()">
<a name="panelConfigSet-automaticRefresh"></a><h3>panelConfigSet_automaticRefresh ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelConfigSet_automaticRefresh     (<em class="parameter"><code><a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> bool</code></em>);</pre>
<p>
V_Sim can poll the rendered file at periodic intervals to check if the file
has been modified. If true, the file is reloaded. Turn this functionality on or off
with this method. See <a class="link" href="v-sim-panelConfig.html#panelConfigSet-refreshPeriod" title="panelConfigSet_refreshPeriod ()"><code class="function">panelConfigSet_refreshPeriod()</code></a> to tune the period of the polling.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> to associated the auto refresh ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bool</code></em> :</span></p></td>
<td>a boolean value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelConfigSet_refreshPeriod ()">
<a name="panelConfigSet-refreshPeriod"></a><h3>panelConfigSet_refreshPeriod ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelConfigSet_refreshPeriod        (<em class="parameter"><code><a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> *window</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> val</code></em>);</pre>
<p>
V_Sim can poll the rendered file at periodic intervals. Use this method to tune
the period. See <a class="link" href="v-sim-panelConfig.html#panelConfigSet-automaticRefresh" title="panelConfigSet_automaticRefresh ()"><code class="function">panelConfigSet_automaticRefresh()</code></a> to enable this functionality.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-gtk-renderingWindowWidget.html#VisuRenderingWindow"><span class="type">VisuRenderingWindow</span></a> to associated the auto refresh ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>a floating point value in milliseconds.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>