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     };

    40     

    41     inline NmAction(int priorityIndex);

    42     inline void setPriorityIndex(int priorityIndex);

    43     inline int priorityIndex() const;

    44     inline void setAvailabilityCondition(NmAvailabilityCondition condition);

    45     inline NmAvailabilityCondition availabilityCondition() const;

    46 

    47 private:

    48     int mIndex;

    49     NmAvailabilityCondition mAvailabilityCondition;

    50 };

    51 

    52 /*!

    53      Constructor \a priorityIndex defines place of action in menus

    54  */

    55 inline NmAction::NmAction(int priorityIndex) 

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

    57 {

    58     

    59 }

    60 

    61 /*!

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

    63  */

    64 inline void NmAction::setPriorityIndex(int priorityIndex)

    65 {

    66     mIndex = priorityIndex;

    67 }

    68 

    69 /*!

    70     Returns priority index

    71  */

    72 inline int NmAction::priorityIndex() const

    73 {

    74     return mIndex;

    75 }

    76 

    77 /*!

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

    79  */

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

    81 {

    82     mAvailabilityCondition = condition;

    83 }

    84 

    85 /*!

    86     returns availibility condition

    87  */

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

    89 {

    90     return mAvailabilityCondition;

    91 };

    92 

    93 

    94 

    95 #endif  //NMACTION_H_