aknPopup.h

00001 /*
00002 * ============================================================================
00003 *  Name     : AknPopup.h
00004 *  Part of  : Avkon
00005 *
00006 *  Description:
00007 * Support for Avkon Popped-up lists
00008 *
00009 *  Version:
00010 *
00011 *  Copyright © 2002 Nokia Corporation.
00012 *  This material, including documentation and any related 
00013 *  computer programs, is protected by copyright controlled by 
00014 *  Nokia Corporation. All rights are reserved. Copying, 
00015 *  including reproducing, storing,  adapting or translating, any 
00016 *  or all of this material requires the prior written consent of 
00017 *  Nokia Corporation. This material also contains confidential 
00018 *  information which may not be disclosed to others without the 
00019 *  prior written consent of Nokia Corporation.
00020 * ============================================================================
00021 */
00023 #if !defined(__AKNPOPUP_H__)
00024 #define __AKNPOPUP_H__
00025 
00026 #include <coecntrl.h>
00027 #include <eikcmobs.h>
00028 #include <eiklbx.h>
00029 #include <aknpopuplayout.h>
00030 #include <aknintermediate.h>
00031 #include <aknpopupfader.h>
00033 class CAknPopupHeadingPane;
00034 class CEikButtonGroupContainer;
00035 class CEikListBox;
00036 class CAknSearchField;
00037 class CAknPopupListExtension;
00072 class CAknPopupList : public CEikBorderedControl,
00073                       public MEikCommandObserver,
00074                       public MEikListBoxObserver,
00075                       public MCoeControlObserver,
00076                       public MAknIntermediateState,
00077                       public MAknFadedComponent
00078     {
00079 public: // enums 
00081     DECLARE_TYPE_ID(0x20018439)
00083 public:
00095     IMPORT_C static CAknPopupList* NewL( 
CEikListBox* aListBox, 
00097        TInt aCbaResource,
AknPopupLayouts::TAknPopupLayouts aType = AknPopupLayouts::EMenuWindow);
00107         IMPORT_C TBool ExecuteLD();
00114     IMPORT_C void SetTitleL(const TDesC& aTitle);
00120         IMPORT_C void CancelPopup();
00121 public: // Access methods
00128         IMPORT_C CEikButtonGroupContainer* ButtonGroupContainer();
00134         IMPORT_C CAknPopupHeadingPane* Heading();
00141         IMPORT_C CAknPopupHeadingPane* Heading() const;
00148         IMPORT_C CEikListBox* ListBox();
00155         IMPORT_C void SetMaximumHeight(TInt aItems);
00163     IMPORT_C TBool EnableFind(TBool aEnable=ETrue);
00172     IMPORT_C TBool EnableAdaptiveFind(TBool aEnable=ETrue);
00179     IMPORT_C CAknSearchField* FindBox() const;
00180 public:
00188     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00189 protected:
00198     IMPORT_C void ProcessCommandL(TInt aCommandId);
00209     IMPORT_C void HandleListBoxEventL(CEikListBox* aListBox, 
TListBoxEvent aEventType);
00219     IMPORT_C void HandleControlEventL(CCoeControl* aControl,
00220                                       TCoeEvent aEventType);
00221 protected:
00226     IMPORT_C CAknPopupList();
00231     IMPORT_C ~CAknPopupList();
00240     IMPORT_C void ConstructL(CEikListBox* aListBox, 
00241                              TInt aCbaResource,
AknPopupLayouts::TAknPopupLayouts aType );
00250     IMPORT_C virtual void AttemptExitL(TBool aAccept);
00258     IMPORT_C virtual void SetupWindowLayout(
AknPopupLayouts::TAknPopupLayouts aType);
00266     IMPORT_C CEikListBox* ListBox() const;
00274     IMPORT_C const TAknPopupWindowLayoutDef& Layout() const;
00282     IMPORT_C TAknPopupWindowLayoutDef& Layout();
00284 protected:
00295     IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
00297 protected:
00306     IMPORT_C void HandleResourceChange(TInt aType);
00308 protected:
00309         IMPORT_C void FadeBehindPopup(TBool aFade);
00313 private:
00314         // the following needs to be imported, because they need to be
00315         // used in virtual table of any derived class.
00316         IMPORT_C TSize MinimumSize();
00317         IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
00318         IMPORT_C TInt CountComponentControls() const;
00319         IMPORT_C void Draw(const TRect& aRect) const;
00320         IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,
00321                                              TEventCode aType);
00322         IMPORT_C void FocusChanged(TDrawNow aDrawNow);
00324         IMPORT_C void CloseState();
00325         // From MAknFadedComponent
00326         IMPORT_C virtual TInt CountFadedComponents();
00327         IMPORT_C virtual CCoeControl* FadedComponent(TInt aIndex);
00329 private:
00333     IMPORT_C void* ExtensionInterface( TUid aInterface );
00335 private:
00336         void RemoveFindFiltering();
00338 protected: // these are protected to allow overriding virtual functions.
00339         CEikListBox*                            iListBox;
00345     CEikButtonGroupContainer* iPopoutCba;
00351     CAknPopupHeadingPane* iTitle;
00354     TBool* iReturn;
00357     TBool iMarkable;
00360     TInt iCurrentResource;
00363         AknPopupLayouts::TAknPopupLayouts iWindowType;
00368     TAknPopupWindowLayoutDef iLayout;
00372     TBool iAppBroughtForwards;
00375     TAknPopupFader iPopupFader;
00378     CIdle *iIdle;
00382         CActiveSchedulerWait iWait;             // owned, safe to use as direct member data.
00383 private:
00384     CAknPopupListExtension* iPopupListExtension;    // owned
00385         };
00387 #endif
00388