fep/aknfep/UiPlugins/AknFepUiInterface/AvkonImpl/inc/AknFepPredictiveSettingData.h
changeset 40 2cb9bae34d17
parent 31 f1bdd6b078d1
child 49 37f5d84451bd
equal deleted inserted replaced
31:f1bdd6b078d1 40:2cb9bae34d17
     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 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 
       
    26 
       
    27 /*
       
    28  * ============================================================================
       
    29  *  Name     : CAknFepPredictiveSettingData from AknFepPredictiveSettingData.h
       
    30  * ============================================================================
       
    31  */
       
    32 
       
    33 #ifndef __AKN_FEP_PREDICTIVESETTING_DATA_H
       
    34 #define __AKN_FEP_PREDICTIVESETTING_DATA_H
       
    35 
       
    36 #include <e32base.h>
       
    37 
       
    38 /**
       
    39  * Class: 		CAknFepPredictiveSettingData
       
    40  *
       
    41  * Discussion:	An aggregate class containing data for all editing controls
       
    42  *				This class is used as a central respository for all data
       
    43  *				to be displayed and editted within this app.
       
    44  */
       
    45 class CAknFepPredictiveSettingData : public CBase
       
    46 {
       
    47 public:
       
    48 	/**
       
    49  	* Function: 	NewL
       
    50 	*
       
    51  	* Discussion:	Factory function used to create a new instance of
       
    52  	* 				CAknFepPredictiveSettingData
       
    53 	*
       
    54  	* Returns:		A newly created instance of CAknFepPredictiveSettingData with all data
       
    55  	*				items valid
       
    56 	*/
       
    57 	static CAknFepPredictiveSettingData* NewL();
       
    58 
       
    59 	/**
       
    60  	* Function: 	NewLC
       
    61 	*
       
    62  	* Discussion:	Factory function used to create a new instance of
       
    63  	* 				CAknFepPredictiveSettingData and leave a pointer to it on the cleanup
       
    64  	*				stack
       
    65 	*
       
    66  	* Returns:		A newly created instance of CAknFepPredictiveSettingData with all data
       
    67  	*				items valid
       
    68 	*/
       
    69 	static CAknFepPredictiveSettingData* NewLC();
       
    70 
       
    71 	/**
       
    72 	* Function:		~CAknFepPredictiveSettingData
       
    73 	*
       
    74 	* Discussion: 	Virtual destructor for CAknFepPredictiveSettingData. Ensures that all
       
    75 	*				allocated memory is returned to the heap before deletion
       
    76 	* 				of object.
       
    77 	*
       
    78 	*/
       
    79 	virtual ~CAknFepPredictiveSettingData();
       
    80 
       
    81     /**
       
    82     * Function:    LoadL
       
    83     * 
       
    84     * Discussion:  Loads itself with parameters passed.
       
    85     * 
       
    86     */
       
    87     void LoadL(TInt aAutoWordCompl,
       
    88 			   TInt aTypingCorrection,
       
    89 			   TInt aNumberCandidates,
       
    90 			   TInt aPrimaryCandidate,
       
    91 			   TInt aPhysicalKeyboards,
       
    92 			   TInt aAWCBitmask);
       
    93     
       
    94     /**
       
    95     * Function:     SaveL
       
    96     * 
       
    97     * Discussion:   Saves itself.
       
    98     * 
       
    99     */
       
   100 	void SaveL() const;
       
   101     
       
   102 	/**
       
   103  	* Function: 	AutoWordCompl
       
   104 	*
       
   105  	* Discussion:	Trivial accessor function
       
   106 	*
       
   107  	* Returns:		A reference to the iAutoWordCompl member
       
   108 	*/
       
   109 	inline TInt& AutoWordCompl() {return iAutoWordCompl; }
       
   110 	
       
   111 	/**
       
   112  	* Function: 	TypingCorrection
       
   113 	*
       
   114  	* Discussion:	Trivial accessor function
       
   115 	*
       
   116  	* Returns:		A reference to the iTypingCorrection member
       
   117 	*/
       
   118 	inline TInt& TypingCorrection() { return iTypingCorrection; }
       
   119 
       
   120 	
       
   121 	/**
       
   122  	* Function: 	NumberCandidates
       
   123 	*
       
   124  	* Discussion:	Trivial accessor function
       
   125 	*
       
   126  	* Returns:		A reference to the iNumberCandidates member
       
   127 	*/
       
   128 	inline TInt& NumberCandidates() {return iNumberCandidates; }
       
   129 	
       
   130 	/**
       
   131  	* Function: 	PrimaryCandidate
       
   132 	*
       
   133  	* Discussion:	Trivial accessor function
       
   134 	*
       
   135  	* Returns:		A reference to the iPrimaryCandidate member
       
   136 	*/
       
   137 	inline TInt& PrimaryCandidate() {return iPrimaryCandidate; }
       
   138 	
       
   139 	/**
       
   140 	* Function:     PhysicalKeyboards
       
   141 	*
       
   142 	* Discussion:   Trivial accessor function
       
   143 	*
       
   144 	* Returns:      Value of iPhysicalKeyboards member
       
   145 	*/
       
   146 	inline TInt PhysicalKeyboards() {return iPhysicalKeyboards; }
       
   147 
       
   148     /**
       
   149     * Function:     AWCBitmask
       
   150     *
       
   151     * Discussion:   Trivial accessor function
       
   152     *
       
   153     * Returns:      Value of iPhysicalKeyboards member
       
   154     */
       
   155     inline TInt& AWCBitmask() {return iAWCBitmask; }
       
   156 private:
       
   157 	/**
       
   158 	* Function:		CAknFepPredictiveSettingData
       
   159 	*
       
   160 	* Discussion: 	Hidden, first-stage non-leaving constructor.
       
   161 	*
       
   162 	*/
       
   163 	CAknFepPredictiveSettingData();
       
   164 
       
   165 	/**
       
   166 	* Function:		ConstructL
       
   167 	*
       
   168 	* Discussion: 	Hidden, second-stage possibly-leaving constructor.
       
   169 	*
       
   170 	*/
       
   171 	void ConstructL();
       
   172 
       
   173 
       
   174 public:
       
   175 	TInt iAutoWordCompl;					/* Data for AutoWordCompl field          */
       
   176 	TInt iTypingCorrection;					/* Data for TypingCorrection text field  */
       
   177 	TInt iNumberCandidates;					/* Data for NumberCandidates field       */
       
   178 	TInt iPrimaryCandidate;					/* Data for PrimaryCandidate field       */
       
   179     TInt iPhysicalKeyboards;                /* Data for PhysicalKeyboards field      */
       
   180     TInt iAWCBitmask;                       /* AWC data in bitmask form              */
       
   181     
       
   182 };
       
   183 
       
   184 #endif // __AKN_FEP_PREDICTIVESETTING_DATA_H
       
   185