File: set-list.html

package info (click to toggle)
anyremote 5.1.3%2Bdfsg-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 4,408 kB
  • ctags: 824
  • sloc: ansic: 7,035; sh: 3,776; python: 113; makefile: 54
file content (265 lines) | stat: -rw-r--r-- 11,997 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
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
<!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="use-jc.html">Java Client</a></li>
							<li><a href="web.html">Web 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.googlepages.com/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 java client</a></li>
								</ul>
							</li>
						</ul>
					</li>
					<li><a href="dcop.html">DCOP support by kAnyRemote</a></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(list ... ) and Set(iconlist ... ) commands</h1>

		<p>This command used to create and manage lists which will be shown on the phone screen. This could be useful to manage player playlists or to browse directory structure. The <i>iconlist</i> can contain icons in front of each list item.</p>

		<h2>Format</h2>

		<p><strong>Set(list,add|replace|clear|show|close, title, _list_or_menu_data_)</strong> or</p>
		<p><strong>Set(list,fg|bg|font|select, _data_)</strong></p>
		<p><strong>Set(iconlist,add|replace|clear|show|close, title, _list_or_menu_data_)</strong> or</p>
		<p><strong>Set(iconlist,fg|bg|font|select, _data_)</strong></p>

		<img alt="Simple list" src="data/jc/fileManager.png" />
		<img alt="List with icons" src="data/jc/fileManager3.png" />

		<h2>Usage</h2>

		<h3>Set(list,add|replace ...)</h3>

		<p>Command Set(list,add|replace ...) used to add or replace content of the existing list.</p>
		
                <pre>1=Set(list,replace,Commands,uptime,whoami)
2=Set(list,add,SAME,reboot,poweroff)
3=ExecAndSet(list,add,SAME,cat /tmp/some_file.txt)</pre>

		<p>The word <strong>SAME</strong> can be used instead of title if there are no needs to change existing list title.</p>
		<p>If <strong>Set(iconlist, ...)</strong> command is used, then each list item should be in form "icon_name:list_item_text":</p>

		<pre>1=Set(list,replace,Commands,question:uptime,ok:whoami)</pre>

		<h3>Set(list,show)</h3>

		<p>Command <strong>Set(list,show)</strong> used to show existing list.</p>
		
                <pre>2=Set(list,show)</pre>

		<h3>Set(list,clear)</h3>
                
		<p>Command <strong>Set(list,clear)</strong> used to clear existing list.</p>
		
                <pre>3=Set(list,clear)</pre>

		<h3>Set(list,close)</h3>

		<p>Command <strong>Set(list,close)</strong> used to close existing list. If list is closed, then control (main) screen of Java Client will be shown.</p>
		
                <pre>Back($$)=Set(list,close)</pre>

		<h3>Set(list,select ...)</h3>

		<p>Command <strong>Set(list,select,_index_)</strong> used to select in list item with specified index. Items numbering starts from 1.</p>
		
                <pre>4=Set(list,select,1)</pre>

		<h3>Set(list,fg|bg ...)</h3>

		<p>Command <strong>Set(list,fg|bg,R,G,B)</strong> used to set foregroung or background colors, where values of R,G and B should be beetween 0 and 255.</p> 
		
                <pre>5=Set(list,fg,255,255,255)</pre>

		<h3>Set(list,font ...)</h3>

		<p>Command <strong>Set(list,font [,small | medium | large] [,bold] [,italic] [,underlined] [,system | monospace | proportional])</strong> used to set font parameters. Java realization in the phone could support only some subset of fonts which can be specified by this command.</p> 
		
                <pre>6=Set(list,font,medium,bold,proportinal)</pre>

		<h3>Adding menu items</h3>
		<p>It is possible to add custom made menu by <a href="set-menu.html">Set(menu ...)</a> command. If user chooses ListItemX in list and then chooses MenuItemY in menu then reply MenuItemY(index_of_ListItemX_in_list,ListItemX) will be issued. According to the screenshot above the <strong>GoTo(1,..)</strong> command will be issued.</p> 

		<h3>Additional</h3>

		<p>There are several things which needs to be pointed out:</p>
		<p>List items numbering starts with 1.</p>
		<p>All '\r' characters in results of execution of command <strong>ExecAndSet(list|iconlist,add|replace,_title_, ...)</strong> command will be replaced with comma ('<strong>,</strong>') on java client's side. So, it is possible to show commas (<strong>,</strong>) inside list items.</p>
		<p>If server does not issue <strong>Set(list,menu ...)</strong> command there will be automatically created default menu, which contains item "Back"</p>
		<p>In any menu created with <strong>Set(list,menu ...)</strong> there anyway will be automatically created menu item "Back".</p>
		<p>The first item in menu created with <strong>Set(list,menu ...)</strong> will be used to issue the command then user selects list item (in another words - push joystick without descending to menu and choosing menu item). In default menu "Back" item will be used to issue the command then used selects list item.</p>

		<p></p>
		<p>To handle events on server side it needs to use lines like:</p>
		
                <pre>MenuItemX($$)=Some_command</pre>

		<p>The list element value and the list element index will be substituted with the <strong>$(Param)</strong> and <strong>$(Index)</strong> variables:</p>
		
                <pre>Choose($$)=Exec(xmmsctrl track $(Index))
Choose($$)=Exec(kdialog --msgbox "Current track is $(Param)")</pre>

		<p>It is possible to overcome substitution of the <strong>$(Param)</strong> and <strong>$(Index)</strong> variables with explicit specification of event. For example if <strong>Choose(1,Reboot)</strong> event is send from Java Client, then two next lines will be <strong>equivalent</strong> and each of them will match that event.</p>

		<pre>Choose(1)=Exec(kdialog --msgbox \
       "User choose REBOOT (match by index)")
Choose(Reboot)=Exec(kdialog --msgbox \
       "User choose REBOOT (match by value)")</pre>

		<p>As it was written above, <strong>"Back"</strong> menu item is added automatically, but it is user responsibility to handle corresponding events on server side. In general it could be done like this:</p>
		
                <pre>Back($$)=Set(list,close)</pre>

		<h3>Autoscrolling of long lines</h3>

		<p>If a list item is too long to be shown in full, it will be autoscrolled when it will be under cursor. It it possible to switch on/off autoscrolling by pressing <strong>"0"</strong> key at phone's keypad.</p>


		<h2>Using special keys</h2>
		<table rules="all" class="keypad">
			<tr><th colspan="3">Keypad</th></tr>
			<tr><td>1<br />Move to first item</td><td>2</td><td>3<br />Page Up</td></tr>
			<tr><td>4</td><td>5</td><td>6</td></tr>
			<tr><td>7<br />Move to last item</td><td>8</td><td>9<br />Page Down</td></tr>
			<tr><td>*</td><td>0<br />Toggle autoscrolling</td><td>#<br /></td></tr>
		</table>

	</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>