eikbtgrp.h

00001 /*
00002 * ============================================================================
00003 *  Name        : eikbtgrp.h
00004 *  Part of     : UI Framework / EIKON Concrete Controls
00005 *  Description : EIKON button group base class definitions.
00006 *  Version     : %version: %
00007 *
00008 *  Copyright © 2002-2007 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 * Template version: 4.1
00018 */
00019 
00020 #ifndef __EIKBTGRP_H__
00021 #define __EIKBTGRP_H__
00022 
00023 #include <e32std.h>
00024 
00025 class CCoeControl;
00026 class CEikCommandButton;
00027 class CFbsBitmap;
00028 class MEikCommandObserver;
00029 
00038 class MEikButtonGroup
00039     {
00040 public:
00044     void Release();
00045     
00055     virtual void SetCommandL(
00056         TInt aPosition,
00057         TInt aCommandId,
00058         const TDesC* aText,
00059         const CFbsBitmap* aBitmap,
00060         const CFbsBitmap* aMask) = 0;
00061        
00069     virtual void SetCommandL(TInt aPosition, 
00070         TInt aResourceId) = 0;
00071 
00077     virtual void SetCommandSetL(TInt aResourceId) = 0;
00078     
00088     virtual void AddCommandL(
00089         TInt aPosition,
00090         TInt aCommandId,
00091         const TDesC* aText,
00092         const CFbsBitmap* aBitmap,
00093         const CFbsBitmap* aMask) = 0;
00094         
00105     virtual void AddCommandToStackL(
00106         TInt aPosition,
00107         TInt aCommandId,
00108         const TDesC* aText,
00109         const CFbsBitmap* aBitmap,
00110         const CFbsBitmap* aMask) = 0;
00111        
00119     virtual void AddCommandToStackL(TInt aPosition, 
00120         TInt aResourceId) = 0;
00121     
00128     virtual void AddCommandSetToStackL(TInt aResourceId) = 0;
00129 
00135     virtual void SetDefaultCommand(TInt aCommandId) = 0;
00136     
00145     virtual TSize CalcMinimumSizeL(TInt aResourceId) = 0;
00146     
00156     virtual void RemoveCommandFromStack(TInt aPosition, 
00157         TInt aCommandId) = 0;
00158     
00165     virtual TInt CommandPos(TInt aCommandId) const = 0;
00166     
00173     virtual void DimCommand(TInt aCommandId, 
00174         TBool aDimmed) = 0;
00175     
00183     virtual TBool IsCommandDimmed(TInt aCommandId) const = 0;
00184     
00193     virtual void MakeCommandVisible(TInt aCommandId, 
00194         TBool aVisible) = 0;
00195     
00203     virtual TBool IsCommandVisible(TInt aCommandId) const = 0;
00204     
00210     IMPORT_C virtual void AnimateCommand(TInt aCommandId);
00211     
00217     virtual CCoeControl* AsControl() = 0;
00218     
00224     virtual const CCoeControl* AsControl() const = 0;
00225     
00233     virtual void SetBoundingRect(const TRect& aBoundingRect) = 0;
00234     
00242     virtual void ReduceRect(TRect& aBoundingRect) const = 0;
00243 
00250     virtual CCoeControl* GroupControlById(TInt aCommandId) const = 0;
00251 
00258     virtual CEikCommandButton* GroupControlAsButton(TInt aCommandId) const = 0;
00259 
00266     virtual TInt CommandId(TInt aCommandPos) const = 0;
00267     
00273     virtual TInt ButtonCount() const = 0;
00274     
00280     virtual TUint ButtonGroupFlags() const = 0;
00281 
00287     virtual void SetMSKCommandObserver(MEikCommandObserver* aCommandObserver) = 0;
00288     
00295     virtual void DimCommandByPosition(TInt aPosition, 
00296         TBool aDimmed) = 0;
00297     
00304     virtual TBool IsCommandDimmedByPosition(TInt aPosition) const = 0;
00305     
00312     virtual void MakeCommandVisibleByPosition(TInt aPosition, 
00313         TBool aVisible) = 0;
00314 
00321     virtual TBool IsCommandVisibleByPosition(TInt aPosition) const = 0;
00322     
00328     virtual void AnimateCommandByPosition(TInt aPosition) = 0;
00329     
00330 private:
00331     IMPORT_C void Reserved_1();
00332     };
00333     
00334 
00341 class MEikEnhancedButtonGroup : public MEikButtonGroup
00342     {
00343 public:
00349     IMPORT_C virtual void OfferCommandListL(const RArray<TInt>& aCommandList) = 0;
00350 
00356     IMPORT_C virtual void OfferCommandListL(const TInt aResourceId) = 0;
00357     
00364     IMPORT_C virtual TBool IsCommandInGroup(const TInt aCommandId) const = 0;
00365     
00372     IMPORT_C virtual void ReplaceCommand(const TInt aCommandId, const TInt aResourceId) = 0;  
00373     };
00374 
00375 // __EIKBTGRP_H__
00376 #endif