organizer_plat/calendar_custamization_api/inc/calentoolbar.h
changeset 0 f979ecb2b13e
equal deleted inserted replaced
-1:000000000000 0:f979ecb2b13e
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Provides access to Calendar Toolbar
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CALENTOOLBAR_H
       
    19 #define CALENTOOLBAR_H
       
    20 
       
    21 // System includes
       
    22 #include <e32def.h>
       
    23 #include <e32cmn.h>
       
    24 
       
    25 // Forward declarations
       
    26 class CAknToolbar;
       
    27 
       
    28 // Class declaration
       
    29 /**
       
    30  * @class MCalenToolbar
       
    31  * @brief Calendar toolbar interface. 
       
    32  * Must be implemented by clients to control the Calendar toolbar
       
    33  */
       
    34 NONSHARABLE_CLASS( MCalenToolbar )
       
    35     {
       
    36     public:
       
    37     
       
    38 		/**
       
    39 		 * @brief Checks if the toolbar is currently visible
       
    40 		 * 
       
    41 		 * @return ETrue if the toolbar is currently visible, EFalse otherwise
       
    42 		 */
       
    43 		virtual TBool IsVisible() = 0;
       
    44 
       
    45 		/**
       
    46 		 * @brief Shows or hides the toolbar. Has no effect if the toolbar is disabled
       
    47 		 * 
       
    48 		 * @param aMakeVisible ETrue to make the toolbar visible, EFalse otherwise
       
    49 		 */
       
    50 		virtual void SetToolbarVisibilityL( TBool aMakeVisible ) = 0;
       
    51 
       
    52 		/**
       
    53 		 * @brief Updates the toolbar using calendar layout information
       
    54 		 */
       
    55         virtual void UpdateToolbar() = 0;
       
    56 
       
    57 		/**
       
    58 		 * @brief Accessor for the concrete toolbar
       
    59 		 * 
       
    60 		 * @return CAknToolbar& Reference to the concrete toolbar object
       
    61 		 */
       
    62 		virtual CAknToolbar& Toolbar() = 0;
       
    63         
       
    64 		/**
       
    65 		 * @brief Allows extending this API without breaking BC
       
    66 		 * 
       
    67 		 * @param aExtensionUid Specifies the extension id
       
    68 		 * @return TAny* Extension of the requested type
       
    69 		 */
       
    70         virtual TAny* CalenToolbarExtensionL( TUid aExtensionUid ) = 0; 
       
    71 		
       
    72     protected:
       
    73          
       
    74 		/**
       
    75 		 * @brief Protected destructor to prevent deletion
       
    76 		 */
       
    77         ~MCalenToolbar()
       
    78 			{
       
    79 			};
       
    80     };
       
    81 
       
    82 #endif // CALENTOOLBAR_H
       
    83 
       
    84 // End of file