aknchoicelist.h

00001 /*
00002 * ============================================================================
00003 *  Name        : aknchoicelist.h
00004 *  Part of     : UI Framework core / AvKon
00005 *  Description : CAknChoiceList - Choice list for S60 
00006 *  Version     : %version: 10 % 
00007 *
00008 *  Copyright © 2005 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 */
00020 #ifndef AKNCHOICELIST_H
00021 #define AKNCHOICELIST_H
00022 
00023 // includes 
00024 #include <akncontrol.h>
00025 #include <coecobs.h>
00027 // forward declarations  
00028 class CAknButton;
00029 class CEikLabel;
00030 class CAknChoiceListPopup;
00031 class CAknChoiceListPopupList;
00032 class CAknsFrameBackgroundControlContext;
00033 class CAknInfoPopupNoteController;
00035 // Class declaration
00045 class CAknChoiceList : public CAknControl, public MCoeControlObserver
00046     {   
00047 public:
00049     /* Flags for choice list types and positioning */   
00050     enum TAknChoiceListFlags
00051         {
00052         /* Using default choice list with popup list */
EAknChoiceListWithCurrentSelection = 0x01,
00054         /* Using user defined button to open choice list */
EAknChoiceListWithoutCurrentSelection = 0x02,
00056         /* Popup positioning flags */
EAknChoiceListPositionLeft = 0x04,   
EAknChoiceListPositionRight = 0x08,   
EAknChoiceListPositionBottom = 0x10  
00060         };    
00062      /* Tooltip positioning */
00063      enum TTooltipPosition
00064         {
EPositionTop = 1, /* Tooltip alignment vertically to top */
EPositionBottom, /* Tooltip alignment vertically to bottom */
EPositionLeft, /* Tooltip alignment horizontally to left */
EPositionRight /* Tooltip alignment horizontally to right */
00069         };
00070 public: 
00083     IMPORT_C static CAknChoiceList* NewL( CCoeControl* aParent, CDesCArray* aItemArray, TInt aFlags = EAknChoiceListWithCurrentSelection, CAknButton* aButton = NULL );
00096     IMPORT_C static CAknChoiceList* NewLC( CCoeControl* aParent, CDesCArray* aItemArray, TInt aFlags = EAknChoiceListWithCurrentSelection, CAknButton* aButton = NULL );
~CAknChoiceList();
00109     IMPORT_C TInt ShowChoiceListL();
00115     IMPORT_C void SetSelectedIndex( const TInt aIndex );
00121     IMPORT_C TInt SelectedIndex() const;
00129     IMPORT_C void SetItems( CDesCArray* aArray );
00136     IMPORT_C void SetItemsL( TInt aResourceId );
00144     IMPORT_C TInt AddItemL( const TDesC* aDesC );
00150     IMPORT_C void RemoveItem( const TInt aIndex );    
00157     IMPORT_C void SetFlags( const TInt aFlags );
00163     IMPORT_C TInt Flags() const;
00169     IMPORT_C void SetButtonL( CAknButton* aButton );
00174     IMPORT_C void HideChoiceList();
00180     IMPORT_C void SetTooltipTextL( const TDesC& aText );
00189     IMPORT_C void SetTooltipTimeouts( const TInt aBeforeTimeout,
00190                                       const TInt aInViewTimeout );
00196     IMPORT_C void SetTooltipPosition( const TTooltipPosition aPosition );
00198 // From CCoeControl
00205     IMPORT_C CCoeControl* ComponentControl( TInt aIndex ) const;
00211     IMPORT_C TInt CountComponentControls() const;
00217     IMPORT_C TSize MinimumSize();    
00223     IMPORT_C void HandleResourceChange( TInt aType );    
00231     IMPORT_C TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType );    
00237     IMPORT_C void Draw( const TRect& aRect ) const;
00246     IMPORT_C virtual void PositionChanged();
00249 // From MCoeControlObserver
00258     IMPORT_C void HandleControlEventL( CCoeControl* aControl, TCoeEvent aEventType );
00260 public: 
00261     // new functions
00270     IMPORT_C TInt InsertItemL( const TInt aIndex, const TDesC& aText );
00272 protected: 
00274 // from CCoeControl         
00279     void SizeChanged();
00285     void HandlePointerEventL( const TPointerEvent& aPointerEvent );    
00287 private:
CAknChoiceList(); 
00301     void ConstructL( CCoeControl* aParent, CDesCArray* aItemArray, TInt aFlags, CAknButton* aButton );    
00307     void ConstructTypicalChoiceListL();
00312     void SetPopupRect();
00317     void UpdateLabelL();
00322     void ShowTooltipL();
00325 private: // data
00330     TInt iFlags;
00335     TInt iSelectedIndex;
00340     TBool iIsClosed;    
CAknButton* iButton;
CEikLabel* iLabel;
00361     CDesCArray* iArray;    
00368     CAknChoiceListPopup* iPopup;
CAknInfoPopupNoteController* iTooltip;
00380     HBufC* iTooltipText;
00386     TInt iTooltipWaitInterval;
00392     TInt iTooltipInViewInterval;
TTooltipPosition iTooltipPosition;
00401     };    
00403 #endif // AKNCHOICELIST_H
00404 
00405 // end of file