email/imum/Utils/Inc/MuiuDynamicSettingItemEditText.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:  MuiuDynamicSettingItemEditText.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MUIUDYNSETTINGITEMEDITTEXT_H__
       
    21 #define __MUIUDYNSETTINGITEMEDITTEXT_H__
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32base.h>
       
    25 #include "MuiuDynamicSettingItemBase.h"
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 *  ?one_line_short_description.
       
    31 *  ?other_description_lines
       
    32 *
       
    33 *  @lib ?library
       
    34 *  @since S60 3.0
       
    35 */
       
    36 class CMuiuSettingsEditText : public CMuiuSettingBase
       
    37     {
       
    38     public: // Constructors and Destructor
       
    39 
       
    40         /**
       
    41         * Destructor
       
    42         * @since S60 3.0
       
    43         */
       
    44         virtual ~CMuiuSettingsEditText();
       
    45 
       
    46         /**
       
    47         *
       
    48         * @since S60 3.0
       
    49         */
       
    50         static CMuiuSettingsEditText* NewL();
       
    51         static CMuiuSettingsEditText* NewLC();
       
    52 
       
    53     public: // Operators
       
    54 
       
    55         /**
       
    56         *
       
    57         * @since S60 3.0
       
    58         */
       
    59         CMuiuSettingsEditText& operator=(
       
    60             const CMuiuSettingsEditText& aBaseItem );
       
    61 
       
    62     public: // New virtual functions
       
    63 
       
    64         /**
       
    65         *
       
    66         * @since S60 3.0
       
    67         * @return
       
    68         */
       
    69         virtual inline const TMuiuSettingsText* Text() const;
       
    70 
       
    71         /**
       
    72         * Returns the text value for the UI. Returns the user assigned value
       
    73         * or empty text. Empty text is given if user assigned value is not
       
    74         * defined
       
    75 
       
    76         * @since S60 5.0
       
    77         * @return Text value or empty text
       
    78         */
       
    79         virtual const TDesC& VisibleText() const;
       
    80 
       
    81         /**
       
    82         *
       
    83         * @since S60 3.0
       
    84         * @param aText
       
    85         */
       
    86         virtual inline void SetText( const TMuiuSettingsText* aText );
       
    87 
       
    88         /**
       
    89         * Set empty text's value. Empty text is used when the Text is not
       
    90         * defined.
       
    91         *
       
    92         * @see VisibleText()
       
    93         * @param aEmptyText Empty text.
       
    94         * @since S60 5.0
       
    95         */
       
    96         virtual inline void SetEmptyText( const TDesC& aEmptyText );
       
    97 
       
    98 
       
    99 
       
   100     protected: // Constructors
       
   101 
       
   102         /**
       
   103         *
       
   104         * @since S60 3.0
       
   105         */
       
   106         CMuiuSettingsEditText();
       
   107 
       
   108         /**
       
   109         *
       
   110         * @since S60 3.0
       
   111         */
       
   112         void ConstructL();
       
   113 
       
   114     protected: // Data
       
   115         /// Own. Text value of this setting item
       
   116         TMuiuSettingsText*  iUserText;
       
   117         /// Own. Value that is shown when iUserText is undefined
       
   118         TMuiuSettingsText*  iEmptyText;
       
   119 
       
   120     public: // Data
       
   121         TInt                iItemMaxLength;
       
   122     };
       
   123 
       
   124 #include "MuiuDynamicSettingItemEditText.inl"
       
   125 
       
   126 #endif //__MUIUDYNSETTINGITEMEDITTEXT_H__
       
   127 
       
   128 // End of file