Symbian3/SDK/Source/GUID-F149726A-CC79-42A1-8A25-E15AC14ABE9A.dita
changeset 0 89d6a7a84779
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/SDK/Source/GUID-F149726A-CC79-42A1-8A25-E15AC14ABE9A.dita	Thu Jan 21 18:18:20 2010 +0000
@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
+<!-- This component and the accompanying materials are made available under the terms of the License 
+"Eclipse Public License v1.0" which accompanies this distribution, 
+and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
+<!-- Initial Contributors:
+	Nokia Corporation - initial contribution.
+Contributors: 
+-->  <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"><concept id="GUID-F149726A-CC79-42A1-8A25-E15AC14ABE9A" xml:lang="en"><title>Setting
+list</title><prolog><metadata><keywords></keywords></metadata></prolog><conbody>
+<p>A setting list is a specific kind of selection list containing setting
+items that the user can adjust. Setting lists are displayed in the main pane.</p>
+<fig id="GUID-5795DABA-71C7-42DE-B3AF-BA532435416A">
+<title>Setting list </title>
+<image href="GUID-D36660AA-1DC1-49B4-870E-F3BA66A734BC_d0e55427_href.png" scale="33" placement="inline"></image>
+</fig>
+<p>A setting item can be adjusted by selecting it in the same way as selection
+list items are selected in general; that is, by pressing the Selection key,
+or choosing the Change command from the Options menu. The main pane then displays
+the setting item editor where the value can be changed.</p>
+<p>There are several setting item types available. They look the same in the
+setting list: each item displays an attribute text (the title of the setting)
+on one line and the current value on another line within the item. The adjusting
+and editing functions differ between the setting item types.</p>
+<table id="GUID-212B8C90-F3AC-4893-9AF6-19A8B4845F91"><title>Setting item
+types</title>
+<tgroup cols="2"><colspec colname="col1"></colspec><colspec colname="col2"></colspec>
+<thead>
+<row>
+<entry>Setting</entry>
+<entry>Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry><p>Pop-up setting</p></entry>
+<entry><p>A pop-up setting allows the user to choose one value from a pre-defined
+list. The setting editor displays the available values in a menu list.A pop-up
+setting may also allow the user to enter a new textual value in addition to
+the pre-defined values. In that case, the last option is named Other (or equivalent),
+and selecting it opens a Data query for entering the new value.</p></entry>
+</row>
+<row>
+<entry><p>Multi-selection list setting</p></entry>
+<entry><p>A multi-selection list setting allows the user to choose several
+simultaneous values from a pre-defined list. The setting editor displays the
+available values as a multi-selection list. The setting item displays the
+number of selected items versus all the items in the value field; for example:
+3/8.</p></entry>
+</row>
+<row>
+<entry><p>Text setting</p></entry>
+<entry><p>The value of a text setting item is an alphanumeric or numeric string.
+The editor can be of a specific type, such as the Date and Time editor.</p></entry>
+</row>
+<row>
+<entry><p>Slider setting</p></entry>
+<entry><p>With a slider, the user can adjust the value of a setting by sliding
+a marker. The value of a slider is adjusted using the Arrow left and Arrow
+right keys.</p></entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<fig id="GUID-D919C463-A143-4C05-AD2E-0983291F4658">
+<title>Pop-up setting</title>
+<image href="GUID-A0FF8339-E322-4D22-A800-E90467E5C952_d0e55510_href.png" scale="33" placement="inline"></image>
+</fig>
+<fig id="GUID-DB28DFCD-006C-4828-BDAC-CC9594AE4768">
+<title>Multi-selection setting</title>
+<image href="GUID-7E69FAA4-2198-4428-BD26-96C4020E2077_d0e55518_href.png" scale="33" placement="inline"></image>
+</fig>
+<fig id="GUID-B3D4C80C-7BD8-441F-AEB6-B186022E6A0A">
+<title>Text setting</title>
+<image href="GUID-AA9552C9-6223-459C-A8F9-770ECFCEFBDD_d0e55526_href.png" scale="33" placement="inline"></image>
+</fig>
+<fig id="GUID-4A642EAD-6C40-407A-A1C1-408B9331A1DA">
+<title>Slider setting</title>
+<image href="GUID-967E277E-67FC-4F98-B775-06C9BFC09926_d0e55534_href.png" scale="33" placement="inline"></image>
+</fig>
+<p>By default, in a setting editor, the keypad functions are as follows:</p>
+<table id="GUID-1181AD52-5BAD-4F44-A0A1-EA930F63E1AC"><title>Default key events
+in setting editor</title>
+<tgroup cols="2"><colspec colname="col1"></colspec><colspec colname="col2"></colspec>
+<thead>
+<row>
+<entry>Key</entry>
+<entry>Action</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry><p>Arrow up / down</p></entry>
+<entry><p>Pop-up, multi-selection: browses the list. Text: moves the cursor.
+Slider: ignored.</p></entry>
+</row>
+<row>
+<entry><p>Arrow left / right</p></entry>
+<entry><p>Pop-up: ignored. Multi-selection: ignored. Text: moves the cursor.
+Slider: adjusts the slider value (a key repeat event may move the slider by
+several steps).</p></entry>
+</row>
+<row>
+<entry><p>Selection key</p></entry>
+<entry><p>All except multi-selection: accepts the value, returns to the setting
+list. Multi-selection: toggles <b>Mark/Unmark</b>.</p></entry>
+</row>
+<row>
+<entry><p>Left softkey (OK)</p></entry>
+<entry><p>Accepts the current item or value, returns.</p><p><b>Note: </b>may
+also be <b>Options</b> in certain instances.</p></entry>
+</row>
+<row>
+<entry><p>Right softkey (Cancel)</p></entry>
+<entry><p>Cancels the setting editor, returns.</p></entry>
+</row>
+<row>
+<entry><p>Clear</p></entry>
+<entry><p>Pop-up, multi-selection: ignored. Text: deletes characters. Slider:
+ignored.</p></entry>
+</row>
+<row>
+<entry><p>Edit</p></entry>
+<entry><p>Pop-up, multi-selection: ignored. Text: opens the editing menu.
+Slider: ignored.</p></entry>
+</row>
+<row>
+<entry><p>Numeric keypad</p></entry>
+<entry><p>Pop-up, multi-selection: ignored. Text: input functions. Slider:
+ignored; if the value is numeric, it may be adjustable using the Numeric keys.</p></entry>
+</row>
+<row>
+<entry><p>Other keys</p></entry>
+<entry><p>Do the default action of the key.</p></entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<p>In the setting editor, the Navi pane is empty, or in case of a text editor,
+contains the editing indicators.</p>
+<p>Further guidelines:</p>
+<ul>
+<li><p>Typically, a setting list is accessed via the <b>Options</b> menu (see <xref href="GUID-BFEEECCA-190B-4DDE-8A04-4FE918BE8690.dita">Options menu</xref>). </p></li>
+<li><p>Setting lists can only contain setting items, not other types of items
+mixed with them. (In case the settings are arranged in a hierarchical structure,
+both setting items and setting folders may exist in one list.)</p></li>
+<li><p>All the setting item types can co-exist in the same setting list.</p></li>
+</ul>
+<p>If a pop-up setting has only two available values (such as <b>On</b> and <b>Off</b>)
+and no special procedure is needed when switching from one value to the other,
+then the setting editor (list) must not be displayed when the user presses
+the Selection key; the item's value is changed immediately. However, if the
+user opens the setting item via the <b>Options</b> menu, or if an additional
+procedure is required (for example a password) before the item's value can
+be changed, the list is opened normally.</p>
+<section><title>Using setting lists in
+C++ applications</title><p>The APIs to use for setting lists are the Lists
+API and the Setting
+pages API. For implementation information, see Using
+the Lists API and Using
+the Setting pages API.</p></section>
+</conbody></concept>
\ No newline at end of file