williamr@2: /*
williamr@2: * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: *
williamr@2: */
williamr@2:
williamr@2: // AknQueryValueDate.h
williamr@2: //
williamr@2: // Copyright (c) 2001 Symbian Ltd. All rights reserved.
williamr@2: //
williamr@2:
williamr@2: #if !defined(__AKNQUERYVALUEDATE_H__)
williamr@2: #define __AKNQUERYVALUEDATE_H__
williamr@2:
williamr@2: #include <bamdesca.h>
williamr@2: #include <eikdialg.h>
williamr@2: #include "AknQueryValue.h"
williamr@2:
williamr@2: class CAknQueryValueDateArray;
williamr@2:
williamr@2: /**
williamr@2: * Encapsulates a date value. Provides an interface to create a dialog
williamr@2: * containing a time query control, which will edit the value. Optionally
williamr@2: * Allows the value to be changed by selecting from a list of values.
williamr@2: *
williamr@2: */
williamr@2: NONSHARABLE_CLASS(CAknQueryValueDate) : public CAknQueryValue
williamr@2: {
williamr@2: public:
williamr@2: /**
williamr@2: * Two-phased constructor.
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C static CAknQueryValueDate* NewL();
williamr@2:
williamr@2: /**
williamr@2: * Two-phased constructor.
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C static CAknQueryValueDate* NewLC();
williamr@2:
williamr@2: /**
williamr@2: * destructor
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C virtual ~CAknQueryValueDate();
williamr@2:
williamr@2: /**
williamr@2: * Set the array.
williamr@2: *
williamr@2: * @param aArray pointer to array, ownership is not passed
williamr@2: */
williamr@2: IMPORT_C void SetArrayL(const CAknQueryValueDateArray* aArray);
williamr@2:
williamr@2: /**
williamr@2: * Set the string used for the query caption to be a string other than the default.
williamr@2: *
williamr@2: * @param aResourceId resource id of string to use for caption.
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C void SetQueryCaption(TInt aResourceId);
williamr@2:
williamr@2: /**
williamr@2: * Return the current value, which may have been set by the user
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C TTime Value() const;
williamr@2:
williamr@2: public: // from MAknQueryValue
williamr@2: IMPORT_C virtual const MDesCArray* MdcArray() const;
williamr@2: IMPORT_C virtual HBufC* CurrentValueTextLC();
williamr@2: IMPORT_C virtual TInt CurrentValueIndex() const;
williamr@2: IMPORT_C virtual void SetCurrentValueIndex(const TInt aIndex);
williamr@2: IMPORT_C virtual TBool CreateEditorL();
williamr@2:
williamr@2: protected:
williamr@2: CAknQueryValueDate();
williamr@2:
williamr@2: /**
williamr@2: * 2nd stage construction.
williamr@2: *
williamr@2: */
williamr@2: void ConstructL();
williamr@2:
williamr@2: /**
williamr@2: * Search for the current time in the list, and set the current index
williamr@2: * to be the found index. If not found, set current index to 1 after the size of the array.
williamr@2: *
williamr@2: */
williamr@2: void CalculateCurrentIndex();
williamr@2:
williamr@2: virtual void AppendValueIfNewL();
williamr@2:
williamr@2: private: // from MAknQueryValue
williamr@2: IMPORT_C void Reserved_MAknQueryValue();
williamr@2:
williamr@2: private:
williamr@2: // the following are member variables
williamr@2: TInt iQueryCaptionId;
williamr@2: TTime iTime;
williamr@2: TInt iCurrentIndex;
williamr@2: // the following are not owned
williamr@2: const CAknQueryValueDateArray* iArray;
williamr@2: };
williamr@2:
williamr@2:
williamr@2: /**
williamr@2: * Wraps an array of dates, adapts it into a descriptor array.
williamr@2: *
williamr@2: */
williamr@2: NONSHARABLE_CLASS(CAknQueryValueDateArray) : public CBase, public MDesCArray
williamr@2: {
williamr@2: public:
williamr@2: /**
williamr@2: * Typedef for array containing TTime items
williamr@2: *
williamr@2: */
williamr@2: typedef CArrayFix<TTime> TimeArray;
williamr@2:
williamr@2:
williamr@2: enum {KSafeSizeOfDescriptorForTTimeFormat = 128};
williamr@2:
williamr@2: public:
williamr@2: /**
williamr@2: * Two-phased constructor.
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C static CAknQueryValueDateArray* NewL(TInt aResourceId);
williamr@2:
williamr@2: /**
williamr@2: * Two-phased constructor.
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C static CAknQueryValueDateArray* NewLC(TInt aResourceId);
williamr@2:
williamr@2: IMPORT_C ~CAknQueryValueDateArray();
williamr@2:
williamr@2: /**
williamr@2: * Set the array of values.
williamr@2: * Note that client can use any implementation of array class, but must pass in a
williamr@2: * TArray generated from it (by calling the Array() method on the array class)
williamr@2: *
williamr@2: * @param aArray array of values, ownership is not passed
williamr@2: */
williamr@2: IMPORT_C void SetArray(TimeArray& aArray);
williamr@2:
williamr@2: /**
williamr@2: * Get the array of values as a TArray.
williamr@2: * Note that client can use any implementation of array class, but the array is
williamr@2: * treated as a TArray.
williamr@2: *
williamr@2: * @return array of values, ownership is not passed
williamr@2: */
williamr@2: IMPORT_C TimeArray* Array() const;
williamr@2:
williamr@2: /**
williamr@2: * Return the TTime format string that is used to generate MDesCArray values
williamr@2: *
williamr@2: * @return format string
williamr@2: */
williamr@2: IMPORT_C const HBufC* FormatString() const;
williamr@2:
williamr@2: #ifdef __WINS__
williamr@2: /**
williamr@2: * Return the size of a maximal time string formated using the format string
williamr@2: * that was supplied during construction of this instance.
williamr@2: * Two versions to eliminate compiler warnings.
williamr@2: *
williamr@2: * @return length of formatted string.
williamr@2: */
williamr@2: IMPORT_C const TInt FormattedStringSize() const;
williamr@2: #else
williamr@2: /**
williamr@2: * See const TInt FormattedStringSize() const;
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C TInt FormattedStringSize() const;
williamr@2: #endif // __WINS__
williamr@2:
williamr@2: public:
williamr@2: // from MDesCArray
williamr@2: /**
williamr@2: * @return count of contained array
williamr@2: *
williamr@2: */
williamr@2: IMPORT_C virtual TInt MdcaCount() const;
williamr@2:
williamr@2: /**
williamr@2: * Returns array element, converting value to text.
williamr@2: * <p> WARNING: the returned pointer is only valid until the next time this
williamr@2: * method is invoked.
williamr@2: *
williamr@2: * @param aIndex of element to return
williamr@2: * @return descriptor representing array element, ownership is not passed
williamr@2: */
williamr@2: IMPORT_C virtual TPtrC MdcaPoint(TInt aIndex) const;
williamr@2:
williamr@2: protected:
williamr@2: CAknQueryValueDateArray();
williamr@2:
williamr@2: /**
williamr@2: * 2nd stage construction.
williamr@2: *
williamr@2: */
williamr@2: void ConstructL(TInt aResourceId);
williamr@2:
williamr@2: private:
williamr@2: // the following members are owned
williamr@2: HBufC* iLastGeneratedTextValue;
williamr@2: HBufC* iFormatString;
williamr@2: // the following members are not owned
williamr@2: TimeArray* iArray;
williamr@2: TInt iFormattedStringSize;
williamr@2: };
williamr@2:
williamr@2: #endif // __AKNQUERYVALUEDATE_H__
williamr@2: