1 /*

     2 * Copyright (c) 2008 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:  Declaration of class CFscContactActionMenuItem.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_FSCCONTACTACTIONMENUITEM_H

    20 #define C_FSCCONTACTACTIONMENUITEM_H

    21 

    22 #include <e32base.h>

    23 

    24 //<cmail>

    25 #include "fsccontactactionmenudefines.h"

    26 //</cmail>

    27 

    28 // FORWARD DECLARATIONS

    29 class CGulIcon;

    30 

    31 /**

    32  *  Contact Action Menu Item interface.

    33  *    Contact Action Menu Items can be created using a factory method 

    34  *    provided by Action Menu's model

    35  *

    36  *  @since S60 3.1

    37  */

    38 class CFscContactActionMenuItem : public CBase

    39     {

    40 

    41 public: // Public destructor

    42 

    43     /**

    44     * Destructor.

    45     */

    46     virtual ~CFscContactActionMenuItem() {};

    47     

    48 public: // Public methods

    49 

    50     /**

    51      * Set menu text

    52      *

    53      * @param aMenuText New menu text

    54      */

    55     virtual void SetMenuTextL( const TDesC& aMenuText ) = 0;

    56 

    57     /**

    58      * Get menu text

    59      *

    60      * @return Menu text

    61      */

    62     virtual const TDesC& MenuText() const = 0;

    63 

    64     /**

    65      * Set icon

    66      *  Icon ownership is not transferred

    67      *

    68      * @param aIcon New icon

    69      */

    70     virtual void SetIcon( const CGulIcon* aIcon ) = 0;

    71 

    72     /**

    73      * Get icon

    74      *  Icon ownership is not transferred

    75      *

    76      * @return Item's icon

    77      */

    78     virtual const CGulIcon* Icon() const = 0;

    79 

    80     /**

    81      * Set priority

    82      *

    83      * @param aPriority Item priority

    84      */

    85     virtual void SetPriority( TInt aPriority ) = 0;

    86 

    87     /**

    88      * Get priority

    89      *

    90      * @return Item's priority

    91      */

    92     virtual TInt Priority() const = 0;

    93 

    94     /**

    95      * Set implementation uid

    96      *

    97      * @param aUid Implementation Uid of the item

    98      */

    99     virtual void SetImplementationUid( TUid aUid ) = 0;

   100 

   101     /**

   102      * Get implementation Uid

   103      *

   104      * @return Item's implementation Uid

   105      */

   106     virtual TUid ImplementationUid() const = 0;

   107 

   108     /**

   109      * Set item dimmed

   110      *

   111      * @param aDimmed ETrue if item is dimmed

   112      */

   113     virtual void SetDimmed( TBool aDimmed ) = 0;

   114 

   115     /**

   116      * Is item dimmed

   117      *

   118      * @return ETrue if item is dimmed, otherwise EFalse

   119      */

   120     virtual TBool Dimmed() const = 0;

   121 

   122     /**

   123      * Set dimm reason

   124      *

   125      * @param aDimmReason dimm reason

   126      */

   127     virtual void SetDimmReasonL( const TDesC& aDimmReason ) = 0;

   128 

   129     /**

   130      * Get dimm reason

   131      *

   132      * @return dimm reason

   133      */

   134     virtual const TDesC& DimmReason() const = 0;

   135 

   136     /**

   137      * Set item hidden

   138      *

   139      * @param aHidden ETrue if item is hidden

   140      */

   141     virtual void SetHidden( TBool aHidden ) = 0;

   142 

   143     /**

   144      * Is item hidden

   145      *

   146      * @return ETrue if item is hidden, otherwise EFalse

   147      */

   148     virtual TBool Hidden() const = 0;

   149 

   150     /**

   151      * Set item static

   152      *  Static items are ment to be kept in the menu longer than non-static. 

   153      *  Normal use case for static items are custom items set by Action Menu's 

   154      *  client. These special items are always in the menu so client does not 

   155      *  want to set them again after clearing other items from the menu. All CAS 

   156      *  based items are non-static and therefore they can easily be removed from 

   157      *  the menu without removing static items also. 

   158      *

   159      * @param aStatic ETrue if item is hidden

   160      */

   161     virtual void SetStatic( TBool aStatic ) = 0;

   162 

   163     /**

   164      * Is item static

   165      *

   166      * @return ETrue if item is static, otherwise EFalse

   167      */

   168     virtual TBool Static() const = 0;

   169 

   170     };

   171 

   172 #endif // C_FSCCONTACTACTIONMENUITEM_H