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 interface MFscContactAction.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_FSCCONTACTACTION_H

    20 #define M_FSCCONTACTACTION_H

    21 

    22 #include <e32base.h>

    23 

    24 //<cmail>

    25 #include "fsccontactactionservicedefines.h"

    26 //</cmail>

    27 

    28 // FORWARD DECLARATIONS

    29 class CGulIcon;

    30 

    31 /**

    32  *  Contact action.

    33  *  Defines an interface for contact actions.

    34  *

    35  *  @since S60 3.1

    36  */

    37 class MFscContactAction

    38     {

    39    

    40 public: // Public methods

    41 

    42     /**

    43      * Action uid

    44      *

    45      * @return Uid of the action

    46      */

    47     virtual TUid Uid() const = 0;

    48 

    49     /**

    50      * Action type

    51      *

    52      * @return type of the action

    53      */

    54     virtual TUint64 Type() const = 0;

    55 

    56     /**

    57      * Icon of the action

    58      *  If the action does not have an Icon NULL is returned. 

    59      *  Ownership of the icon is not transferred.

    60      *

    61      * @return icon of the action

    62      */

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

    64 

    65     /**

    66      * Action Menu text of the action

    67      *

    68      * @return action menu text

    69      */

    70     virtual const TDesC& ActionMenuText() const = 0;

    71 

    72     /**

    73      * Visibility reason

    74      *   Method can be used to query a reason text based on 

    75      *   reason id. Reason ids are used with visibility information.

    76      *

    77      * @param aReasonId Id of reason text

    78      * @param aReason Reason text. 

    79      *   Ownership of the descriptor is transfered.

    80      */

    81     virtual void ReasonL( TInt aReasonId, HBufC*& aReason ) const = 0;

    82 

    83     };

    84 

    85 #endif // M_FSCCONTACTACTION_H