1 /*

     2 * Copyright (c) 2009 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: Item action menu register array.

    15 *

    16 */

    17 

    18 #ifndef C_AKNITEMACTIONMENUREGISTERARRAY_H

    19 #define C_AKNITEMACTIONMENUREGISTERARRAY_H

    20 

    21 #include <e32base.h>

    22 

    23 class CAknItemActionMenu;

    24 class CEikMenuBar;

    25 class MAknCollectionObserver;

    26 

    27 /**

    28  * Item action menu register array.

    29  *

    30  * @lib eikcoctl

    31  * @since S60 v5.2

    32  */

    33 NONSHARABLE_CLASS( CAknItemActionMenuRegisterArray ) : public CBase

    34     {

    35 

    36 public:

    37 

    38     /**

    39      * Two-phased constructor.

    40      */

    41     static CAknItemActionMenuRegisterArray* NewL();

    42 

    43     /**

    44      * Two-phased constructor.

    45      */

    46     static CAknItemActionMenuRegisterArray* NewLC();

    47 

    48     /**

    49      * Destructor.

    50      */

    51     virtual ~CAknItemActionMenuRegisterArray();

    52 

    53     /**

    54      * Adds entry to register. Item action menu ownership transfers.

    55      * 

    56      * @param aMenuBar Menu bar

    57      * @param aItemActionMenu Item action menu

    58      */

    59     void AddEntryL(

    60             CEikMenuBar& aMenuBar,

    61             CAknItemActionMenu& aItemActionMenu );

    62 

    63     /**

    64      * Unregisters menu bar.

    65      * 

    66      * @param aMenuBar Calling menu bar.

    67      */

    68     void UnregisterMenuBar( CEikMenuBar& aMenuBar );

    69 

    70     /**

    71      * Unregisters item action menu.

    72      * 

    73      * @param aItemActionMenu Calling item action menu.

    74      */

    75     void UnregisterItemActionMenu( CAknItemActionMenu& aItemActionMenu );

    76 

    77     /**

    78      * Registers collection observer.

    79      * 

    80      * @param aMenuBar Menu bar.

    81      * @param aObserver Collection observer.

    82      */

    83     TBool RegisterCollectionObserverL(

    84             CEikMenuBar& aMenuBar, MAknCollectionObserver& aObserver );

    85 

    86     /**

    87      * Unregisters collection observer.

    88      * 

    89      * @param aObserver Collection observer.

    90      */

    91     void UnregisterCollectionObserver( MAknCollectionObserver& aObserver );

    92 

    93 private:

    94 

    95     /**

    96      * C++ constructor.

    97      */

    98     CAknItemActionMenuRegisterArray();

    99 

   100     /**

   101      * Symbian second-phase constructor.

   102      */

   103     void ConstructL();

   104 

   105     /**

   106      * Removes entry from register.

   107      * 

   108      * @param aIndex Index to be removed.

   109      */

   110     void RemoveEntry( TInt aIndex );

   111 

   112 private: // data

   113 

   114     /**

   115      * Class representing single entry in register.

   116      */

   117     NONSHARABLE_CLASS( CRegisterEntry ) : public CBase

   118         {

   119 

   120     public:

   121         /**

   122          * Two-phased constructor.

   123          */

   124         static CRegisterEntry* NewL(

   125                 CEikMenuBar& aMenuBar, CAknItemActionMenu& aItemActionMenu );

   126 

   127         /**

   128          * Two-phased constructor.

   129          */

   130         static CRegisterEntry* NewLC(

   131                 CEikMenuBar& aMenuBar, CAknItemActionMenu& aItemActionMenu );

   132 

   133         /**

   134          * Destructor.

   135          */

   136         virtual ~CRegisterEntry();

   137 

   138         /**

   139          * Removes menu bar.

   140          */

   141         void RemoveMenuBar();

   142 

   143         /**

   144          * Provides entry menu bar.

   145          * 

   146          * @return Menu bar.

   147          */

   148         CEikMenuBar* MenuBar();

   149 

   150         /**

   151          * Removes item action menu.

   152          */

   153         void RemoveItemActionMenu();

   154 

   155         /**

   156          * Provides entry item action menu.

   157          * 

   158          * @return Item action menu.

   159          */

   160         CAknItemActionMenu* ItemActionMenu();

   161 

   162     private:

   163         /**

   164          * C++ constructor.

   165          */

   166         CRegisterEntry(

   167                 CEikMenuBar& aMenuBar, CAknItemActionMenu& aItemActionMenu );

   168 

   169         /**

   170          * Symbian 2nd phase constructor.

   171          */

   172         void ConstructL();

   173 

   174     private: // data

   175         /**

   176          * Menu bar.

   177          * Not own.

   178          */

   179         CEikMenuBar* iMenuBar;

   180 

   181         /**

   182          * Item action menu.

   183          * Own.

   184          */

   185         CAknItemActionMenu* iActionMenu;

   186         };

   187     

   188     /**

   189      * Register array.

   190      */

   191     RPointerArray<CRegisterEntry> iRegisterArray;

   192     };

   193 

   194 #endif // C_AKNITEMACTIONMENUREGISTERARRAY_H