uifw/EikStd/coctlinc/aknitemactionmenudata.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     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 data.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef C_AKNITEMACTIONMENUDATA_H
       
    19 #define C_AKNITEMACTIONMENUDATA_H
       
    20 
       
    21 #include <e32base.h>
       
    22 
       
    23 class CAknStylusPopUpMenu;
       
    24 class MDesCArray;
       
    25 
       
    26 /**
       
    27  * Menu pane item maximum text length.
       
    28  */
       
    29 const TInt KMenuPaneItemTextLength( 40 );
       
    30 
       
    31 /**
       
    32  * Menu pane item text buf.
       
    33  */
       
    34 typedef TBuf<KMenuPaneItemTextLength> TMenuItemTextBuf;
       
    35 
       
    36 /**
       
    37  * Item action menu data.
       
    38  *
       
    39  * @lib eikcoctl
       
    40  * @since S60 v5.2
       
    41  */
       
    42 NONSHARABLE_CLASS( CAknItemActionMenuData ) : public CBase
       
    43     {
       
    44 
       
    45 public:
       
    46 
       
    47     /**
       
    48      * Two-phased constructor.
       
    49      */
       
    50     static CAknItemActionMenuData* NewL();
       
    51 
       
    52     /**
       
    53      * Destructor.
       
    54      */
       
    55     virtual ~CAknItemActionMenuData();
       
    56 
       
    57     /**
       
    58      * Adds menu data item to menu data array.
       
    59      * 
       
    60      * @param aCommandId Menu item command id.
       
    61      * @param aCascadeId Menu item cascade id.
       
    62      * @param aText Menu item text.
       
    63      */
       
    64     void AddMenuItemToDataArrayL(
       
    65             TInt aCommandId, TInt aCascadeId, const TDesC& aText );
       
    66 
       
    67     /**
       
    68      * Adds menu data items styluspopupmenu.
       
    69      * 
       
    70      * @param aPopupMenu Stylus popup menu.
       
    71      */
       
    72     void AddMenuItemsToStylusPopupMenuL( CAknStylusPopUpMenu* aPopupMenu );
       
    73 
       
    74     /**
       
    75      * Provides menu items for query dialog.
       
    76      * 
       
    77      * @return Text array for query dialog.
       
    78      */
       
    79     MDesCArray* MenuItemsForQueryDialogL();
       
    80 
       
    81     /**
       
    82      * Returns menu item cascade id for requested index.
       
    83      * 
       
    84      * @param aIndex Menu item index + 1.
       
    85      * @return Menu item cascade id if it has one.
       
    86      * Otherwise 0.
       
    87      */
       
    88     TInt MenuItemCascadeId( TInt aIndex );
       
    89 
       
    90     /**
       
    91      * Returns menu item text for requested index.
       
    92      * 
       
    93      * @param aIndex Menu item index + 1.
       
    94      * @return Menu item text.
       
    95      */
       
    96     TDesC& MenuItemText( TInt aIndex );
       
    97 
       
    98     /**
       
    99      * Returns menu item command id for requested index.
       
   100      * 
       
   101      * @param aIndex Menu item index + 1.
       
   102      * @return Menu item command id.
       
   103      */
       
   104     TInt MenuItemCommandId( TInt aIndex );
       
   105 
       
   106     /**
       
   107      * Resets menu data array.
       
   108      */
       
   109     void Reset();
       
   110 
       
   111     /**
       
   112      * Returns menu data array item count.
       
   113      * 
       
   114      * @return Data array item count.
       
   115      */
       
   116     TInt Count() const;
       
   117 
       
   118 private:
       
   119 
       
   120     /**
       
   121      * C++ constructor.
       
   122      */
       
   123     CAknItemActionMenuData();
       
   124 
       
   125 private: // data
       
   126 
       
   127     /**
       
   128      * Single item action menu item data structure.
       
   129      */
       
   130     class TAknItemActionMenuData
       
   131         {
       
   132 
       
   133     public:
       
   134 
       
   135         /**
       
   136          * Menu item command id.
       
   137          */
       
   138         TInt iCommandId;
       
   139 
       
   140         /**
       
   141          * Menu item cascade id.
       
   142          */
       
   143         TInt iCascadeId;
       
   144 
       
   145         /**
       
   146          * Menu item text.
       
   147          */
       
   148         TMenuItemTextBuf iText;
       
   149         };
       
   150 
       
   151     /**
       
   152      * Menu data.
       
   153      */
       
   154     RArray<TAknItemActionMenuData> iMenuData;
       
   155     };
       
   156 
       
   157 #endif // C_AKNITEMACTIONMENUDATA_H