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-993A732B-13F8-48B6-B0C5-7246FA6828DF" xml:lang="en"><title>Class

    13 structure for the toolbar API</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <p>The Toolbar API consists of following classes: <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknToolbar.html" format="application/java-archive"><codeph>CAknToolbar</codeph></xref>, <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknToolbarExtension.html" format="application/java-archive"><codeph>CAknToolbarExtension</codeph></xref>,

    15 and <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classMAknToolbarObserver.html" format="application/java-archive"><codeph>MAknToolbarObserver</codeph></xref>.

    16 The Toolbar API class structure and its simplified environment is described

    17 in the figure below.</p>

    18 <fig id="GUID-3E08B03E-BE4C-481A-82BB-B7EB03BC806A">

    19 <title>Toolbar API class structure</title>

    20 <image href="GUID-E60F9268-35D5-4D3F-B219-22AECF13953B_d0e79541_href.png" placement="inline"/>

    21 </fig>

    22 <p><codeph>CAknToolbar</codeph> is the API main class that provides the most

    23 of the API functionality. The UI framework classes <codeph>CEikAppUiFactory</codeph>, <codeph>CAknView</codeph>,

    24 and <codeph>CAknAppUi</codeph> take care of creating and destructing the <codeph>CAknToolbar</codeph> object.

    25 Moreover, you can access the toolbar in your application through these UI

    26 framework classes.  </p>

    27 <p><codeph>CAknToolbar</codeph> is a compound (window-owning) control that

    28 contains simple (non-window-owning) controls that are the toolbar items. Toolbar

    29 items can be for example <codeph>CAknButton</codeph> type controls. Each toolbar

    30 can also have one extension that expands the toolbar. The extension contains

    31 also for example <codeph>CAknButton</codeph> type controls.  </p>

    32 <p><codeph>MAknToolbarObserver</codeph> is an interface that can be used to

    33 observe toolbar events. The application class can implement this interface

    34 and register itself as the toolbar observer. <codeph>CAknToolbar</codeph> then

    35 informs the observer when toolbar events occur (when toolbar is about to be

    36 shown and when some toolbar item state has changed e.g. a button is pressed).</p>

    37 </conbody></concept>