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:

    15 *

    16 */

    17 

    18 #ifndef NMACTION_H_

    19 #define NMACTION_H_

    20 

    21 #include <hbaction.h>

    22 

    23 /*!

    24     \class NmAction

    25     \brief NMail action object. Derived from HbAction. Includes priority

    26     \value indicating the priority of the command in the list.

    27 */

    28 class NmAction : public HbAction

    29 {

    30 public:

    31     /*!

    32      * \enum NmAvailabilityCondition

    33      * \brief Defines conditions when action might not be available.

    34      */

    35     enum NmAvailabilityCondition

    36     {

    37         NmAlways = 0,   // Action is always available

    38         NmSendable,     // Action is not available if the related message cannot be send

    39         NmAttachable    // Action is not available if attachment cannot be added        

    40     };

    41     

    42     inline NmAction(int priorityIndex);

    43     inline void setPriorityIndex(const int priorityIndex);

    44     inline int priorityIndex() const;

    45     inline void setAvailabilityCondition(NmAvailabilityCondition condition);

    46     inline NmAvailabilityCondition availabilityCondition() const;

    47 

    48 private:

    49     int mIndex;

    50     NmAvailabilityCondition mAvailabilityCondition;

    51 };

    52 

    53 /*!

    54      Constructor \a priorityIndex defines place of action in menus

    55  */

    56 inline NmAction::NmAction(int priorityIndex) 

    57     : HbAction(), mIndex(priorityIndex), mAvailabilityCondition(NmAlways)

    58 {

    59     

    60 }

    61 

    62 /*!

    63      Sets priority index. \a priorityIndex defines action place in menus

    64  */

    65 inline void NmAction::setPriorityIndex(int priorityIndex)

    66 {

    67     mIndex = priorityIndex;

    68 }

    69 

    70 /*!

    71     Returns priority index

    72  */

    73 inline int NmAction::priorityIndex() const

    74 {

    75     return mIndex;

    76 }

    77 

    78 /*!

    79     Sets condition is action available or not \a condition is condition state

    80  */

    81 inline void NmAction::setAvailabilityCondition(NmAction::NmAvailabilityCondition condition)

    82 {

    83     mAvailabilityCondition = condition;

    84 }

    85 

    86 /*!

    87     returns availibility condition

    88  */

    89 inline NmAction::NmAvailabilityCondition NmAction::availabilityCondition() const

    90 {

    91     return mAvailabilityCondition;

    92 };

    93 

    94 

    95 

    96 #endif  //NMACTION_H_