|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-B05B61B8-1217-441F-BAFA-C209C8F123C5" xml:lang="en"><title>Toolbar |
|
13 API</title><shortdesc>The Toolbar API is used for enabling quick access to functions |
|
14 by displaying them in a toolbar.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
15 <p>A toolbar contains AVKON buttons. The toolbar supports touch, and can be |
|
16 with focus or without focus. It contains application-specific buttons (at |
|
17 least three) that launch application-specific commands. The toolbar content |
|
18 is application-specific, but you can choose whether the toolbar is displayed |
|
19 in an application view or not.</p> |
|
20 <p>The Toolbar API supports two types of toolbars: a fixed toolbar for touch |
|
21 UI, and a floating toolbar which can also be used in non-touch UIs.</p> |
|
22 <fig id="GUID-65384C58-D95F-4E3F-A3E8-41B2FBA237BB"> |
|
23 <title>Fixed toolbar, floating toolbar, and toolbar extension</title> |
|
24 <image href="GUID-F1EFB7C3-BC06-4822-BA37-06B02BECE80A_d0e79427_href.png" scale="90" placement="inline"/> |
|
25 </fig> |
|
26 <p>The fixed toolbar doesn’t have focus, whereas the floating toolbar owns |
|
27 the focus and it can be used also with navigation and selection keys. By default, |
|
28 the floating toolbar owns the CBA buttons (<uicontrol>Select</uicontrol> and <uicontrol>Close</uicontrol>) |
|
29 but the floating toolbar can be defined as not having the CBA buttons with |
|
30 suitable flags. </p> |
|
31 <p>The toolbars are also located differently: a fixed toolbar has a permanent |
|
32 place in the layout but a floating toolbar can be freely located when it is |
|
33 defined as having a flexible position.</p> |
|
34 <p>The toolbar extension is a toolbar button that expands the fixed or floating |
|
35 toolbar. When the extension button is pressed, a grid of toolbar items opens |
|
36 up. The extension items can be used as actual toolbar items. </p> |
|
37 <p>The extension button itself looks like an ordinary toolbar button. The |
|
38 only difference is that there is a default icon for the extension button that |
|
39 is shown if the application does not change the icon itself.</p> |
|
40 <p>For user experience guidelines on the toolbar component, please see the <xref href="GUID-EB212C35-5416-4CA7-8091-61B45D78E220.dita">toolbar UI component description</xref>.</p> |
|
41 <section id="GUID-117C4E37-4C55-4D0A-BA1A-D44200FD74F9"><p>For information |
|
42 on using the API, see <xref href="GUID-95CE2206-7AE0-48C0-97A7-4E2082F9F662.dita">Enabling |
|
43 quick access to functions with a toolbar</xref>.</p><p>For the Toolbar API |
|
44 classes and header files, see Classes and Definitions.</p></section> |
|
45 <section id="GUID-BA1F5361-1F8C-45A0-B476-ECDE87234816"><title>Constraints</title><p>This |
|
46 API is valid for all platforms running on Symbian OS v9.3 or later.</p></section> |
|
47 <section id="GUID-2C270CBB-6AF6-4416-8F0C-29546BF74FF4"><title>Emulator support</title><p>This |
|
48 API is supported in the WINS/WINSCW emulator environment, with the following |
|
49 exception:</p><ul> |
|
50 <li><p>Tactile feedback is not supported.</p></li> |
|
51 </ul></section> |
|
52 </conbody><related-links> |
|
53 <linklist><title>Related APIs</title> |
|
54 <link href="GUID-F3EE1000-71A6-4D48-A30B-3D2357BF20FB.dita"><linktext>Generic button |
|
55 API</linktext> |
|
56 <desc> for creating toolbar buttons</desc> |
|
57 </link> |
|
58 <link format="html" href="specs/guides/Form_API_Specification/Form_API_Specification.html" scope="peer"><linktext>Form API</linktext> |
|
59 <desc> for including editable fields in fixed toolbar extensions</desc> |
|
60 </link> |
|
61 </linklist> |
|
62 </related-links></concept> |