File: set-menu.html

package info (click to toggle)
anyremote 6.7.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,524 kB
  • sloc: ansic: 16,504; sh: 4,469; python: 111; makefile: 56
file content (350 lines) | stat: -rw-r--r-- 14,316 bytes parent folder | download | duplicates (5)
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>

	<title>anyRemote &middot; Control your computer with your phone</title>

	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
	<meta name="description" content="anyRemote project page - Bluetooth remote control tool" />

	<link rel="stylesheet" href="data/master.css" type="text/css" media="all" title="Default Style" charset="utf-8" />
	<script src="data/effects.js" type="text/javascript" charset="utf-8"></script>

	<link rel="alternate" title="Feed" href="data/feed.xml" type="application/rss+xml" />

	<link rel="icon" href="data/logo-favicon.png" type="image/png" />
	<link rel="shortcut icon" href="data/logo-favicon.png" type="image/png" />

</head>

<body id="docs">

	<a class="skip" name="top">&nbsp;</a>
	<a class="skip" href="#content">Skip to content</a>

	<div id="head">
		<div id="logo">
			<h1><a href="index.html"><img src="data/logo-head.png" alt="logo" /> anyRemote</a></h1>
		</div>
		<div id="navigation"><div class="padding">
			<a href="index.html"><span>About</span></a>
			<a href="frontend.html"><span>Screenshots</span></a>
			<a href="dload.html"><span>Download</span></a>
			<a href="docs.html" class="active"><span>Documentation</span></a>
			<a href="faq.html"><span>FAQ</span></a>
			<a href="contacts.html"><span>Contact</span></a>
			<a href="thanks.html"><span>Special Thanks</span></a>
		</div></div>
	</div>

	<div id="sidebar"><div class="padding">
		<dl class="info">
			<dt>Information</dt>
			<dd>
				<p>Please use the two sidebar boxes below to browse through the anyRemote Documentation!</p>
			</dd>
		</dl>
		<dl class="docs">
			<dt>Documentation</dt>
			<dd>
				<ul>
					<li><a href="pre-setup.html">Before install</a></li>
					<li><a href="pre.html">Software prerequisites</a></li>
					<li><a href="install.html">Compilation and installation</a></li>
					<li><a href="mode.html">Which mode to choose ?</a></li>
					<li><strong>Setup</strong>
						<ul>
							<li><a href="setup-at.html">Setup: AT mode</a>
								<ul>
									<li><a href="event.html">Event reporting</a></li>
									<li><a href="ckpd-emulation.html">Keypad emulation events</a></li>
								</ul>
							</li>
							<li><a href="setup-server.html">Setup: Server mode</a></li>
						</ul>
					</li>
					<li><a href="use.html">How to use anyRemote</a>
						<ul>
							<li><a href="android-client.html">Android Client</a></li>
							<li><a href="use-jc.html">J2ME Client</a></li>
							<li><a href="web.html">Web Interface</a></li>
							<li><a href="cm-xml.html">XML Services Interface</a></li>
							<li><a href="cfg-howto.html">How to create simple configuration file</a></li>
							<li><a href="bemused.html">Bemused Support</a></li>
							<li><a href="iviewer.html">Command Fusion iViewer support</a></li>
						</ul>
					</li>
					<li><a href="devices.html">Tested devices</a></li>
					<li><a href="phones.html">Phone specific details</a></li>
					<li><a href="tips-tricks.html">Tips &amp; tricks</a></li>
					<li><a href="man.html">Man page</a></li>
				</ul>
			</dd>
		</dl>
		<dl class="docs-advanced">
			<dt>Advanced</dt>
			<dd>
				<ul>
					<li><a href="http://elpraga.bshellz.net/HOWTOstartanyRemoteatboottime.html">miniHOWTO: start anyRemote at boot time and create a multimedia computer</a> (externally maintained)</li>
					<li><strong>Format of configuration files</strong>
						<ul>
							<li><strong>Server mode</strong>
								<ul>
									<li><a href="conf-server.html">Configuration file format</a></li>
									<li><a href="conf-server-ex.html">Configuration file examples</a></li>

									<li><a href="set.html">Set(...) / ExecAndSet(...) commands</a></li>
									<li><a href="set-fm.html">Set(filemanager ... ) command</a></li>
									<li><a href="set-icons.html">Set(icons ...) command and available icon set</a></li>
									<li><a href="set-list.html">Set(list ... ) and Set(iconlist ... ) commands</a></li>
									<li><a href="set-menu.html">Set(menu ... ) command</a></li>
									<li><a href="set-parameter.html">Set(parameter, ... ) commands</a></li>
									<li><a href="set-text.html">Set(text ... ) command</a></li>
									<li><a href="set-window.html">Set(image ... ) command</a></li>
								</ul>
							</li>
							<li><strong>AT mode</strong>
								<ul>
									<li><a href="conf-at.html">Configurational file format</a></li>
									<li><a href="conf-at-ex.html">Configurational file examples</a></li>
								</ul>
							</li>
							<li><strong>Common</strong>
								<ul>
									<li><a href="make.html">Make(...) command</a></li>
									<li><a href="emulate.html">Emulate(...) command</a></li>
									<li><a href="dbus.html">Dbus(...) command</a></li>
									<li><a href="vars.html">Variable substitution</a></li>
									<li><a href="ev-handlers.html">Event handlers</a></li>
									<li><a href="icon-themes.html">Icon themes for J2ME client</a></li>
								</ul>
							</li>
						</ul>
					</li>
				        <li><a href="ir.html">anyRemote and InfraRed</a></li>
				</ul>
			</dd>
		</dl>
		<dl class="contact">
			<dt>Contact</dt>
			<dd>
				<p>We will be pleased for any questions, suggestions, patches and examples of configuration files!</p>
				<ul>
					<li>Post in the <a href="http://sourceforge.net/forum/?group_id=162923">Forum</a></li>
					<li>Please, send e-mails to  <a href="mailto:anyremote&#64;mail&#46;ru">anyremote&#64;mail&#46;ru</a></li>
				</ul>
			</dd>
		</dl>
		<!--HOSTINGLOGO-->
	</div></div> <!-- sidebar -->

	<div id="content"><div class="padding">

		<a class="skip" name="content">&nbsp;</a>

		<h1>Set(menu ... ) command</h1>

		<p><img class="float-right" alt="Menu example" src="data/client-list-menu.png" />
		This command used to manage a menu associated with the screen of the client.</p>

		<h2>Format</h2>

		<p><strong>Set(menu,add|replace,_list_of_items_)</strong> or</p>
		<p><strong>Set(menu,clear)</strong></p>

		<h2>Usage</h2>

		<h3>Set(menu,add ...)</h3>

		<p>Command <strong>Set(menu,add ...)</strong> used to add items to the menu.</p> 
		
		<pre>1=Set(menu,add,Item1,Item2,Item3)
2=ExecAndSet(menu,add,cat some_file.txt)</pre>

		<h3>Set(menu,replace ...)</h3>
		
		<p>Command <strong>Set(menu,replace ...)</strong> used to replace items in the menu.</p> 
		
		<pre>1=Set(menu,replace,Item1,Item2,Item3)
2=ExecAndSet(menu,add,cat some_file.txt)</pre>

		<p>There is a set of <strong>predefined</strong> menu items are associated with each screen of the client. These set of items will be added automatically during execution of <strong>Set(menu,replace ...)</strong> command.</p>

		<p>Here is the sets of predefined items:</p>

<table style="text-align: left;" border="1" cellpadding="10" cellspacing="1">
    <tr>
      <td style="vertical-align: center; text-align: left width=16%;">
	Controls (main) screen:
      </td>
      <td style="vertical-align: center; text-align: left width=16%;">
	List view screen:
      </td>
      <td style="vertical-align: center; text-align: left width=18%;">
	Text view screen:
      </td>
      <td style="vertical-align: center; text-align: left width=18%;">
	File manager screen (J2ME client only):
      </td>
      <td style="vertical-align: center; text-align: left width=16%;">
	Editfield screen:
      </td>
    </tr>
    <tr>
      <td style="vertical-align: center; text-align: left width=16%;">
	<pre>Exit
Disconnect</pre>
      </td>
      <td style="vertical-align: center; text-align: left width=16%;">
      <pre>Back</pre>
      </td>
      <td style="vertical-align: center; text-align: left width=18%;">
	<pre>Back
Wrap On (J2ME client only)
Wrap Off (J2ME client only)
Jump Up (J2ME client only)
Jump To End (J2ME client only)</pre>
      </td>
      <td style="vertical-align: center; text-align: left width=18%;">
	<pre>Back
GoTo
Copy
Move
MkDir
Delete
View
Execute
File info</pre>
      </td>
      <td style="vertical-align: center; text-align: left width=16%;">
	<pre>OK
Back</pre>
      </td>
     </tr>
</table>

		<p><strong>Set(menu,replace ...)</strong> command is not a superposition of <strong>Set(menu,clear)</strong> and <strong>Set(menu,add ...)</strong> commands because <strong>predefined</strong> menu items will be added only during <strong>Set(menu,replace ...)</strong>. As a results, it is possible to omit <strong>predefined</strong> menu items by executing <strong>Set(menu,clear</strong>) and <strong>Set(menu,add ...)</strong> commands.</p>

		<h3>Set(menu,clear)</h3>

		<p>Command <strong>Set(menu,clear)</strong> used to remove all items from menu.</p>
		
		<pre>7=Set(menu,clear)</pre>

		<p>To avoid possible mess with menu, all menu items will be deleted each time client screen changed from one 
		type to another (i.e. from Control (main) view to Text view). So, it is not necessary to issue 
		Set(menu,clear) when client screen changed from one type to another. 
		On another side it means what Set(menu ...) command should be executed <i>after</i> others Set(...) commands.</p>

		<h2>Format of replies</h2>

		<p>If user chooses menu item MenuItem, some command will be sent to the server. 
		The exact syntax of command depends on the screen of the client from which it is issued 
		(where I is index of selected item in list and ValueI is a value of selected item in list):</p>

     	
		<table>
    			<tr>
      				<td>
					<h3>Control (main) screen</h3>
                                        
					<p><img class="float-right" alt="Main (control) screen" src="data/client-control-menu.png" />
                                        Text of choosen menu item will be sent as a reply for custom menu items. Predefined menu item <strong>Exit</strong> managed internally.</p>
 		
                			<p>According to the picture </p>

					<pre>Item 1</pre>

                			<p>will be sent as a replay.</p>
                                        
      					
                                </td>
      			</tr>
    			<tr>
      				<td>
                			<h3>List view screen</h3>
                
					<p><img class="float-right" alt="List screen" src="data/client-list-menu.png" />
                                        In this case replies will have the following format _menu_item_text_(_index_of_selected_list_item_, _text_of_selected_list_item_).</p>
                
                			<p>According to the picture </p>

					<pre>Choose(9,ChangeLog)</pre>

                			<p>will be sent as a replay.</p>
                			<p>On server side the <a href="vars.html#params_index">$(Index)</a> and 
					<a href="vars.html#params_index">$(Param)</a> environment variables will be set.</p>
                 			
					<p>According to the picture </p>

					<pre><strong>$(Index)</strong> will be set to <strong>9</strong>
<strong>$(Param)</strong> will be set to <strong>ChangeLog</strong></pre>
                             </td>
                 	</tr>
    			<tr>
      				<td>
                			<h3>Text view screen</h3>
		
					<p><img class="float-right" alt="Text screen" src="data/client-text-menu.png" />
                                        Text of choosen menu item will be sent as a reply for custom menu items. Predefined menu items except <strong>Back</strong> managed internally.</p>
                
                			<p>According to the picture </p>

					<pre>Back</pre>

                			<p>will be sent as a replay.</p>
                                </td>
                 	</tr>
    			<tr>
      				<td>
                			<h3>File manager screen</h3>
		
					<p><img class="float-right" alt="Main (control) screen" src="data/jc/fileManager2.png" />
                                        In case of single selection replies will have the following format: _menu_item_text_<strong>L</strong>( _index_of_selected_list_item_, _text_of_selected_list_item_) in left panel and _menu_item_text_<strong>R</strong>( _index_of_selected_list_item_, _text_of_selected_list_item_) in right panel.</p>

					<p>In case of multiple selection replies will have the following format: <strong>M_</strong>_menu_item_text_<strong>L</strong>( _index_of_selected_list_item_, _text_of_selected_list_item_) in left panel and <strong>M_</strong>_menu_item_text_<strong>R</strong>( _index_of_selected_list_item_, _text_of_selected_list_item_) in right panel. Such reply will be sent for each seleted file, but the last. For the last selected file command with single-selection syntax will be issued.</p>
 
                			<p>According to the picture </p>

					<pre>BackR(1,..)</pre>

                			<p>will be sent as a replay.</p>
               			        
					<p>On server side the <a href="vars.html#params_index">$(Index)</a> and 
					<a href="vars.html#params_index">$(Param)</a> environment variables will be set.</p>
                 			
					<p>According to the picture </p>

					<pre><strong>$(Index)</strong> will be set to <strong>1</strong>
<strong>$(Param)</strong> will be set to <strong>..</strong></pre>
                                </td>
                 	</tr>
		</table>
               
                <h3>Editfield screen</h3>
      	        <p>In this case replies will have the following format _menu_item_text_(0, _editfield_value_)</p>
               	<p>On server side the <a href="vars.html#params_index">$(Index)</a> and 
		<a href="vars.html#params_index">$(Param)</a> environment variables will be set.</p>
                 			
		<pre><strong>$(Index)</strong> will be set to <strong>0</strong>
<strong>$(Param)</strong> will be set to <strong>_editfield_value_</strong></pre>
 

                <h3>Search screen</h3>

      		<p>No command will be issued. All menu items managed internally.</p>
                
		<h2>Additional</h2>
		
		<p>It is not recommended to create menu items with labels <strong>OK</strong> and <strong>ERROR</strong> since command which will be sent for such menu items will be parsed incorrectly by the server.</p>

	</div></div> <!-- content -->

	<div id="foot">
		<p>Maintained by <a href="mailto:anyremote&#64;mail&#46;ru">anyRemote</a>. Website by <a href="http://www.martinlettner.info">m.lettner</a>.</p>
	</div>

</body>
</html>