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 #include "fsccontactactionmenudefines.h"

    25 

    26 // FORWARD DECLARATIONS

    27 class CGulIcon;

    28 

    29 /**

    30  *  Contact Action Menu Item interface.

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

    32  *    provided by Action Menu's model

    33  *

    34  *  @since S60 3.1

    35  */

    36 class CFscContactActionMenuItem : public CBase

    37     {

    38 

    39 public: // Public destructor

    40 

    41     /**

    42     * Destructor.

    43     */

    44     virtual ~CFscContactActionMenuItem() {};

    45     

    46 public: // Public methods

    47 

    48     /**

    49      * Set menu text

    50      *

    51      * @param aMenuText New menu text

    52      */

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

    54 

    55     /**

    56      * Get menu text

    57      *

    58      * @return Menu text

    59      */

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

    61 

    62     /**

    63      * Set icon

    64      *  Icon ownership is not transferred

    65      *

    66      * @param aIcon New icon

    67      */

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

    69 

    70     /**

    71      * Get icon

    72      *  Icon ownership is not transferred

    73      *

    74      * @return Item's icon

    75      */

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

    77 

    78     /**

    79      * Set priority

    80      *

    81      * @param aPriority Item priority

    82      */

    83     virtual void SetPriority( TInt aPriority ) = 0;

    84 

    85     /**

    86      * Get priority

    87      *

    88      * @return Item's priority

    89      */

    90     virtual TInt Priority() const = 0;

    91 

    92     /**

    93      * Set implementation uid

    94      *

    95      * @param aUid Implementation Uid of the item

    96      */

    97     virtual void SetImplementationUid( TUid aUid ) = 0;

    98 

    99     /**

   100      * Get implementation Uid

   101      *

   102      * @return Item's implementation Uid

   103      */

   104     virtual TUid ImplementationUid() const = 0;

   105 

   106     /**

   107      * Set item dimmed

   108      *

   109      * @param aDimmed ETrue if item is dimmed

   110      */

   111     virtual void SetDimmed( TBool aDimmed ) = 0;

   112 

   113     /**

   114      * Is item dimmed

   115      *

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

   117      */

   118     virtual TBool Dimmed() const = 0;

   119 

   120     /**

   121      * Set dimm reason

   122      *

   123      * @param aDimmReason dimm reason

   124      */

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

   126 

   127     /**

   128      * Get dimm reason

   129      *

   130      * @return dimm reason

   131      */

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

   133 

   134     /**

   135      * Set item hidden

   136      *

   137      * @param aHidden ETrue if item is hidden

   138      */

   139     virtual void SetHidden( TBool aHidden ) = 0;

   140 

   141     /**

   142      * Is item hidden

   143      *

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

   145      */

   146     virtual TBool Hidden() const = 0;

   147 

   148     /**

   149      * Set item static

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

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

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

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

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

   155      *  the menu without removing static items also. 

   156      *

   157      * @param aStatic ETrue if item is hidden

   158      */

   159     virtual void SetStatic( TBool aStatic ) = 0;

   160 

   161     /**

   162      * Is item static

   163      *

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

   165      */

   166     virtual TBool Static() const = 0;

   167 

   168     };

   169 

   170 #endif // C_FSCCONTACTACTIONMENUITEM_H