epoc32/include/mw/eikmenub.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 1997-1999 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 1997-1999 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    35 #include <eikcmobs.h>
    35 #include <eikcmobs.h>
    36 #include <aknintermediate.h>
    36 #include <aknintermediate.h>
    37 
    37 
    38 class CEikHotKeyTable;
    38 class CEikHotKeyTable;
    39 class CEikMenuBarExtension;
    39 class CEikMenuBarExtension;
       
    40 class CAknItemActionMenu;
    40 
    41 
    41 
    42 
    42 /**
    43 /**
    43  * The CEikMenuBarTitle class encapsulates the data needed to define a menu bar title and
    44  * The CEikMenuBarTitle class encapsulates the data needed to define a menu bar title and
    44  * provides some of the functionality required to display the title.
    45  * provides some of the functionality required to display the title.
   565     * By default the launched menu is options menu.
   566     * By default the launched menu is options menu.
   566     * @since S60 3.1
   567     * @since S60 3.1
   567     * @param aMenuType One of values of CEikMenuBar::TMenuType enumeration. 
   568     * @param aMenuType One of values of CEikMenuBar::TMenuType enumeration. 
   568     */
   569     */
   569     IMPORT_C void SetMenuType(TMenuType aMenuType);
   570     IMPORT_C void SetMenuType(TMenuType aMenuType);
       
   571     
       
   572     /**
       
   573     * Gets type of the menu. 
       
   574     * 
       
   575     * @since S60 5.2
       
   576     * @return the type defined in CEikMenuBar::TMenuType of menu.
       
   577     */    
       
   578     IMPORT_C CEikMenuBar::TMenuType GetMenuType() const;    
       
   579 
       
   580     /**
       
   581      * Returns ETrue when item specific commands are enabled in menu
       
   582      * bar (main pane collection has a highlight) and EFalse when they are
       
   583      * disabled (main pane collection does not have a highlight). 
       
   584      * 
       
   585      * @since S60 5.2
       
   586      * @return ETrue when item specific commands are enabled.
       
   587      */
       
   588     IMPORT_C TBool ItemSpecificCommandsEnabled() const;
       
   589     
       
   590     /**
       
   591      * Sets item action menu instance to menu bar.
       
   592      * 
       
   593      * @internal
       
   594      * @since S60 v5.2
       
   595      * @param aItemActionMenu Pointer to item action menu.
       
   596      */
       
   597     void SetItemActionMenu( CAknItemActionMenu* aItemActionMenu );
       
   598 
       
   599     /**
       
   600      * Provides pointer to item action menu.
       
   601      * 
       
   602      * @internal
       
   603      * @since S60 v5.2
       
   604      * @return Pointer to item action menu.
       
   605      */
       
   606     CAknItemActionMenu* ItemActionMenu() const;
       
   607 
       
   608     /**
       
   609      * Populates item action menu.
       
   610      * 
       
   611      * @internal
       
   612      * @since S60 v5.2
       
   613      * @param aItemActionMenu Reference to item action menu.
       
   614      * @return Created menu pane. Ownership transfers to caller.
       
   615      */
       
   616     CEikMenuPane* PopulateItemActionMenuL( CAknItemActionMenu& aItemActionMenu );
   570 
   617 
   571 private: // from MAknIntermediateState
   618 private: // from MAknIntermediateState
   572 
   619 
   573 	void CloseState();
   620 	void CloseState();
   574 	
   621