epoc32/include/mw/aknnumseced.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2002-2004 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  An editor for a numeric password
    15 *
    16 */
    17 
    18 
    19 #if !defined(__AKNNUMSECED_H__)
    20 #define __AKNNUMSECED_H__
    21 
    22 //  INCLUDES
    23 #if !defined(__EIKBCTRL_H__)
    24 #include <eikbctrl.h>
    25 #endif
    26 
    27 #include <eikseced.h>
    28 
    29 // CLASS DECLARATION
    30 
    31 /**
    32 *  An editor for a numeric password. 
    33 *  Implementation of Avkon numeric secret editor which expands
    34 *  @c CEikSecretEditor to better cope with numeric passwords e.g. PINs.
    35 *
    36 *  @since Series 60 0.9
    37 */
    38 class CAknNumericSecretEditor : public CEikSecretEditor
    39 	{
    40 public:
    41     /**
    42     * C++ default constructor.
    43     */
    44 	IMPORT_C CAknNumericSecretEditor();
    45 	
    46 	/**
    47     * Destructor.
    48     */
    49     ~CAknNumericSecretEditor();
    50     
    51 public:	// from CCoeControl
    52 
    53     /**
    54     * From @c CCoeControl. Gets the control's input capabilities.
    55     * Gets input capabilities that describe which forms of text input are
    56     * consumed by a control.
    57     *
    58     * If this function is overrided in a subclass, the subclass should
    59     * obtain this class' InputCapabilities' object provider through
    60     * TCoeInputCapabilities::ObjectProvider() and set that as a part of
    61     * the subclass' InputCapabilities object provider chain to ensure
    62     * maximum functionality.
    63     *
    64     * @return The control's input capabilities.
    65     */
    66 	IMPORT_C virtual TCoeInputCapabilities InputCapabilities() const;
    67     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
    68 protected:
    69     // methods to enable CAknNumericSecretEditor to inherit from 
    70     // CEikSecretEditor
    71     
    72     /**
    73     * Appends a character to the password.
    74     * @param aKeyCode A numeric character to be appended to the password.
    75     */
    76     IMPORT_C virtual void AppendCharacterL( TInt aKeyCode );
    77     
    78     /**
    79     * Creates a FEP state handler (@c CAknEdwinState ) with default values.
    80     * @return A Pointer to a FEP state handler.
    81     */
    82 	IMPORT_C virtual MCoeFepAwareTextEditor_Extension1::CState* CreateFepStateL();
    83 private: // from CCoeControl
    84 	IMPORT_C void Reserved_1();
    85 	IMPORT_C void Reserved_2();
    86 private:
    87     /**
    88     * From CAknControl
    89     */
    90     IMPORT_C void* ExtensionInterface( TUid aInterface );
    91 
    92 private: // from MCoeFepAwareTextEditor
    93 	IMPORT_C void MCoeFepAwareTextEditor_Reserved_2();
    94 private:  // from MCoeFepAwareTextEditor_Extension1
    95 	IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_2();
    96 	IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_3();
    97 	IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_4();
    98 private: // Data
    99 	TInt iSpare;
   100 	};
   101 
   102 #endif	// AKNNUMSECED_H
   103             
   104 // End of File