File: v-sim-panelBrowser.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 (229 lines) | stat: -rw-r--r-- 14,102 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>panelBrowser</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-panelPlanes.html" title="panelPlanes">
<link rel="next" href="v-sim-panelVibration.html" title="panelVibration">
<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-panelPlanes.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-panelVibration.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-panelBrowser.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-panelBrowser.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="panelBrowser">
<a name="v-sim-panelBrowser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-panelBrowser.top_of_page"></a>panelBrowser</span></h2>
<p>panelBrowser — A tab to view a list of files and quickly
change from one to another.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-panelBrowser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="v-sim-panelBrowser.html#BROWSER-PREVIOUS:CAPS" title="BROWSER_PREVIOUS">BROWSER_PREVIOUS</a>
#define             <a class="link" href="v-sim-panelBrowser.html#BROWSER-NEXT:CAPS" title="BROWSER_NEXT">BROWSER_NEXT</a>
<a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          <a class="link" href="v-sim-panelBrowser.html#panelBrowser-init" title="panelBrowser_init ()">panelBrowser_init</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-panelBrowser.html#panelBrowserGet-nextSelected" title="panelBrowserGet_nextSelected ()">panelBrowserGet_nextSelected</a>        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> **path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iterSelected</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> direction</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-panelBrowser.html#panelBrowserGet-currentSelected" title="panelBrowserGet_currentSelected ()">panelBrowserGet_currentSelected</a>     (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> **path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iterSelected</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelBrowser.html#panelBrowserSet-currentDirectory" title="panelBrowserSet_currentDirectory ()">panelBrowserSet_currentDirectory</a>    (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelBrowser.html#panelBrowserSet-currentDirectories" title="panelBrowserSet_currentDirectories ()">panelBrowserSet_currentDirectories</a>  (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **dirs</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelBrowser.html#panelBrowserSet-infoMessage" title="panelBrowserSet_infoMessage ()">panelBrowserSet_infoMessage</a>         (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkMessageDialog.html#GtkMessageType"><span class="type">GtkMessageType</span></a> message_type</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-panelBrowser.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-panelBrowser.details"></a><h2>Details</h2>
<div class="refsect2" title="BROWSER_PREVIOUS">
<a name="BROWSER-PREVIOUS:CAPS"></a><h3>BROWSER_PREVIOUS</h3>
<pre class="programlisting">#define BROWSER_PREVIOUS 0
</pre>
<p>
Value that give the direction when the selector is moved around file list.
See <a class="link" href="v-sim-panelBrowser.html#panelBrowserGet-nextSelected" title="panelBrowserGet_nextSelected ()"><code class="function">panelBrowserGet_nextSelected()</code></a>.
</p>
</div>
<hr>
<div class="refsect2" title="BROWSER_NEXT">
<a name="BROWSER-NEXT:CAPS"></a><h3>BROWSER_NEXT</h3>
<pre class="programlisting">#define BROWSER_NEXT     1
</pre>
<p>
Value that give the direction when the selector is moved around file list.
See <a class="link" href="v-sim-panelBrowser.html#panelBrowserGet-nextSelected" title="panelBrowserGet_nextSelected ()"><code class="function">panelBrowserGet_nextSelected()</code></a>.
</p>
</div>
<hr>
<div class="refsect2" title="panelBrowser_init ()">
<a name="panelBrowser-init"></a><h3>panelBrowser_init ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          panelBrowser_init                   ();</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> handling
the browser.
</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="panelBrowserGet_nextSelected ()">
<a name="panelBrowserGet-nextSelected"></a><h3>panelBrowserGet_nextSelected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            panelBrowserGet_nextSelected        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> **path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iterSelected</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> direction</code></em>);</pre>
<p>
Change the selected file in the browser given the direction.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a pointer to returned the path of the newly selected file ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iterSelected</code></em> :</span></p></td>
<td>a pointer to store the newly selected iter ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td>BROWSER_NEXT or BROWSER_PREVIOUS.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if one exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelBrowserGet_currentSelected ()">
<a name="panelBrowserGet-currentSelected"></a><h3>panelBrowserGet_currentSelected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            panelBrowserGet_currentSelected     (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> **path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iterSelected</code></em>);</pre>
<p>
Get iter and path of the currently sleected file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a pointer to returned the path of the currently selected file ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iterSelected</code></em> :</span></p></td>
<td>a pointer to store the currently selected iter.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if one exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelBrowserSet_currentDirectory ()">
<a name="panelBrowserSet-currentDirectory"></a><h3>panelBrowserSet_currentDirectory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelBrowserSet_currentDirectory    (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dir</code></em>);</pre>
<p>
Change the directory for the browser. The directory is not parsed immediately
but only when the subpanel becomes visible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
<td>the path of a directory.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelBrowserSet_currentDirectories ()">
<a name="panelBrowserSet-currentDirectories"></a><h3>panelBrowserSet_currentDirectories ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelBrowserSet_currentDirectories  (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **dirs</code></em>);</pre>
<p>
Change the directories for the browser. It is the same routine than 
<a class="link" href="v-sim-panelBrowser.html#panelBrowserSet-currentDirectory" title="panelBrowserSet_currentDirectory ()"><code class="function">panelBrowserSet_currentDirectory()</code></a>, but several directories can be loaded
at once. But internally, contrary to <a class="link" href="v-sim-panelBrowser.html#panelBrowserSet-currentDirectory" title="panelBrowserSet_currentDirectory ()"><code class="function">panelBrowserSet_currentDirectory()</code></a>
the given array must not be freed since it is not copied.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>dirs</code></em> :</span></p></td>
<td>a NULL terminated array of directories to be loaded.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="panelBrowserSet_infoMessage ()">
<a name="panelBrowserSet-infoMessage"></a><h3>panelBrowserSet_infoMessage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelBrowserSet_infoMessage         (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk/GtkMessageDialog.html#GtkMessageType"><span class="type">GtkMessageType</span></a> message_type</code></em>);</pre>
<p>
This routine is used to give the user a message. This message can
be mere information or a warning or an error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>a string to be displaied.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message_type</code></em> :</span></p></td>
<td>the kind of message.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>