email/imum/Utils/Inc/MuiuDynamicSettingItemBase.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2006 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:  MuiuDynamicSettingItemBase.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MUIUDYNSETTINGITEMBASE_H__
       
    21 #define __MUIUDYNSETTINGITEMBASE_H__
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <muiuflags.h>
       
    26 #include "MuiuDynamicSettingsArray.hrh"
       
    27 #include "MuiuDynamicHeader.h"
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 *  ?one_line_short_description.
       
    33 *  ?other_description_lines
       
    34 *
       
    35 *  @lib ?library
       
    36 *  @since S60 3.0
       
    37 */
       
    38 class CMuiuSettingBase : public CBase
       
    39     {
       
    40     public: // Constructors and Destructor
       
    41 
       
    42         /**
       
    43         * Destructor
       
    44         * @since S60 3.0
       
    45         */
       
    46         virtual ~CMuiuSettingBase();
       
    47 
       
    48         /**
       
    49         *
       
    50         * @since S60 3.0
       
    51         */
       
    52         static CMuiuSettingBase* NewL();
       
    53         static CMuiuSettingBase* NewLC();
       
    54 
       
    55     public: // Operators
       
    56 
       
    57         /**
       
    58         *
       
    59         * @since S60 3.0
       
    60         */
       
    61         CMuiuSettingBase& operator=(
       
    62             const CMuiuSettingBase& aBaseItem );
       
    63 
       
    64     public: // New virtual functions
       
    65 
       
    66         /**
       
    67         *
       
    68         * @since S60 3.0
       
    69         */
       
    70         virtual inline TMuiuDynSettingsType Type() const;
       
    71 
       
    72         /**
       
    73         *
       
    74         * @since S60 3.0
       
    75         */
       
    76         virtual inline TInt64 Value() const;
       
    77 
       
    78         /**
       
    79         *
       
    80         * @since S60 3.0
       
    81         */
       
    82         virtual inline void SetValue( const TInt64 aValue );
       
    83 
       
    84         /**
       
    85         *
       
    86         * @since S60 3.0
       
    87         * @return
       
    88         */
       
    89         virtual inline const TMuiuSettingsText* Text() const;
       
    90 
       
    91         /**
       
    92         * Returns the text value for the UI. Returns the user assigned value
       
    93         * or empty text. Empty text is given if user assigned value is not
       
    94         * defined
       
    95         *
       
    96         * @since S60 5.0
       
    97         * @return Visible text value.
       
    98         */
       
    99         virtual inline const TDesC& VisibleText() const;
       
   100 
       
   101         /**
       
   102         *
       
   103         * @since S60 3.0
       
   104         * @param aText
       
   105         */
       
   106         virtual inline void SetText( const TMuiuSettingsText* aText );
       
   107 
       
   108         /*
       
   109         *
       
   110         * @since S60 3.0
       
   111         */
       
   112         virtual inline TBool HasLinkArray() const;
       
   113 
       
   114     protected: // Constructors
       
   115 
       
   116         /**
       
   117         *
       
   118         * @since S60 3.0
       
   119         */
       
   120         CMuiuSettingBase();
       
   121 
       
   122         /**
       
   123         *
       
   124         * @since S60 3.0
       
   125         */
       
   126         void ConstructL();
       
   127 
       
   128     public: // Data
       
   129 
       
   130         TMuiuFlags              iItemFlags;
       
   131         TMuiuDynSettingsType    iItemType;
       
   132         TMuiuSettingsText*      iItemLabel;
       
   133         TUid                    iItemId;
       
   134         TInt                    iItemResourceId;
       
   135     };
       
   136 
       
   137 #include "MuiuDynamicSettingItemBase.inl"
       
   138 
       
   139 #endif //__MUIUDYNSETTINGITEMBASE_H__
       
   140 
       
   141 // End of file