classicui_plat/popups_api/inc/AknPopupFieldText.h
author hgs
Fri, 23 Jul 2010 17:08:56 +0800
changeset 45 667edd0b8678
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: 
hgs
parents:
diff changeset
    15
*     Represents a text combo box type control, used to implement the
hgs
parents:
diff changeset
    16
*     Series 60 text pop-up field.
hgs
parents:
diff changeset
    17
*     This control can be constructed directly from resource.
hgs
parents:
diff changeset
    18
*
hgs
parents:
diff changeset
    19
*
hgs
parents:
diff changeset
    20
*/
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#if !defined(__AKNPOPUPFIELDTEXT_H__)
hgs
parents:
diff changeset
    24
#define __AKNPOPUPFIELDTEXT_H__
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
#include "AknPopupField.h"
hgs
parents:
diff changeset
    27
#include "AknQueryValueText.h"
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * Represents a text combo box type control which is used to implement
hgs
parents:
diff changeset
    31
 * the Series 60 text pop-up field. This control can be constructed directly
hgs
parents:
diff changeset
    32
 * from a resource. 
hgs
parents:
diff changeset
    33
 */
hgs
parents:
diff changeset
    34
class CAknPopupFieldText : public CAknPopupField
hgs
parents:
diff changeset
    35
	{
hgs
parents:
diff changeset
    36
public: 
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
    /**
hgs
parents:
diff changeset
    39
     * C++ default constructor.
hgs
parents:
diff changeset
    40
     */
hgs
parents:
diff changeset
    41
	IMPORT_C CAknPopupFieldText();
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Destructor.
hgs
parents:
diff changeset
    45
     */
hgs
parents:
diff changeset
    46
	IMPORT_C ~CAknPopupFieldText();
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
    /**
hgs
parents:
diff changeset
    49
     * Gets the current value  text stored in the @c CaknQueryValueText member.
hgs
parents:
diff changeset
    50
     *
hgs
parents:
diff changeset
    51
     * @return Pointer to the current value text. 
hgs
parents:
diff changeset
    52
     */
hgs
parents:
diff changeset
    53
	IMPORT_C HBufC* CurrentValueTextLC();
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
     * Gets the current value index from the @c CAknQueryValueText member.
hgs
parents:
diff changeset
    57
     *
hgs
parents:
diff changeset
    58
     * @return The current value index.
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
	IMPORT_C TInt CurrentValueIndex() const;
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
     * Sets the current value index to the @c CAknQueryValueText member.
hgs
parents:
diff changeset
    64
     *
hgs
parents:
diff changeset
    65
     * @param aIndex The current value index.
hgs
parents:
diff changeset
    66
     */
hgs
parents:
diff changeset
    67
	IMPORT_C void SetCurrentValueIndex(const TInt aIndex);
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Gets the @c MdcArray from the @c CAknQueryValueText member. This array 
hgs
parents:
diff changeset
    71
     * contains the selection array of the popup field.
hgs
parents:
diff changeset
    72
     *
hgs
parents:
diff changeset
    73
     * @return Selection array of the popup field.
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
	IMPORT_C const MDesCArray* MdcArray() const;
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * Sets or clears @c EAutoAppendBitIndexCalls flag from @c CAknQueryValue.
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * @param aAppend If @c ETrue, the flag is set.
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
	IMPORT_C void SetAutoAppend(TBool aAppend);
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
public: // from CCoeControl
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
    /**
hgs
parents:
diff changeset
    87
     * From @c CCoeControl.
hgs
parents:
diff changeset
    88
     * 
hgs
parents:
diff changeset
    89
     * Constructs the control from a resource file.
hgs
parents:
diff changeset
    90
     *
hgs
parents:
diff changeset
    91
     * @param aReader Resource reader.
hgs
parents:
diff changeset
    92
     */
hgs
parents:
diff changeset
    93
    IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
hgs
parents:
diff changeset
    94
    
hgs
parents:
diff changeset
    95
    /**
hgs
parents:
diff changeset
    96
     * From @c CCoeControl.
hgs
parents:
diff changeset
    97
     * 
hgs
parents:
diff changeset
    98
     * Handles pointer events.
hgs
parents:
diff changeset
    99
     *
hgs
parents:
diff changeset
   100
     * @param aPointerEvent The pointer event.
hgs
parents:
diff changeset
   101
     */
hgs
parents:
diff changeset
   102
    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
private: // Methods from CAknPopupField that were public
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
    /**
hgs
parents:
diff changeset
   107
     * 2nd phase constructor.
hgs
parents:
diff changeset
   108
     */
hgs
parents:
diff changeset
   109
	void ConstructL();
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
	/**
hgs
parents:
diff changeset
   112
	* This method should not be used. 
hgs
parents:
diff changeset
   113
	* It is here to hide it from users, this will panic if you use it.
hgs
parents:
diff changeset
   114
	*/
hgs
parents:
diff changeset
   115
	void SetQueryValueL(MAknQueryValue* aValue);
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
private: // from CCoeControl
hgs
parents:
diff changeset
   118
	IMPORT_C void Reserved_1();
hgs
parents:
diff changeset
   119
	IMPORT_C void Reserved_2();
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
private:
hgs
parents:
diff changeset
   122
    /**
hgs
parents:
diff changeset
   123
    * From CAknControl
hgs
parents:
diff changeset
   124
    */
hgs
parents:
diff changeset
   125
    IMPORT_C void* ExtensionInterface( TUid aInterface );
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
private: // personal
hgs
parents:
diff changeset
   128
	void CommonConstructL(TInt aTextArrayResourceId, TInt aInitialIndex);
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
private:
hgs
parents:
diff changeset
   131
	// the following members are owned
hgs
parents:
diff changeset
   132
	CDesCArray* iArray;	// the array of text items
hgs
parents:
diff changeset
   133
	CAknQueryValueTextArray* iTextArray;	
hgs
parents:
diff changeset
   134
	CAknQueryValueText* iTextValue;
hgs
parents:
diff changeset
   135
    TInt iSpare[2];
hgs
parents:
diff changeset
   136
	};
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
#endif // __AKNPOPUPFIELDTEXT_H__