uiresources_pub/skins_api/inc/AknsBasicBackgroundControlContext.h
changeset 0 05e9090e2422
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/uiresources_pub/skins_api/inc/AknsBasicBackgroundControlContext.h	Thu Dec 17 09:14:12 2009 +0200
@@ -0,0 +1,151 @@
+/*
+* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Defines a public class CAknsBasicBackgroundControlContext.
+*
+*/
+
+
+#ifndef AKNSBASICBACKGROUNDCONTROLCONTEXT_H
+#define AKNSBASICBACKGROUNDCONTROLCONTEXT_H
+
+//  INCLUDES
+#include <AknsControlContext.h>
+
+// FORWARD DECLARATIONS
+class TAknsBackground;
+
+// CLASS DECLARATION
+
+/**
+*  Implementation of a control context that provides a layout background with
+*  a background bitmap and its layout rectangle.
+*
+*  This is a public class with exported functions.
+*  The class is not intended for derivation outside the library.
+*
+*  @lib AknSkins.lib
+*
+*  @since 2.0
+*/
+NONSHARABLE_CLASS(CAknsBasicBackgroundControlContext) : public CBase, 
+    public MAknsControlContext
+    {
+    public:  // Constructors and destructor
+        
+        /**
+        * Two-phased constructor.
+        *
+        * @since 2.0
+        *
+        * @param aImageID Item ID of the background bitmap.
+        *
+        * @param aRect Rectangle where the bitmap should be laid out.
+        *
+        * @param aParentAbsolute ETrue if parent absolute layout should be
+        *   used, EFalse otherwise. If a parent absolute layout is used,
+        *   the parent position must be set and updated using SetParentPos.
+        *
+        * @return Newly constructed object.
+        */
+        IMPORT_C static CAknsBasicBackgroundControlContext* NewL(
+            const TAknsItemID& aImageID, const TRect& aRect, 
+            TBool aParentAbsolute );
+        
+        /**
+        * Destructor.
+        */
+        virtual ~CAknsBasicBackgroundControlContext();
+
+    public: // New functions
+        
+        /**
+        * Sets the item ID of the background bitmap.
+        *
+        * @since 2.0
+        *
+        * @param aID Item ID of the bitmap.
+        */
+        IMPORT_C void SetBitmap( const TAknsItemID& aID );
+
+        /**
+        * Sets the layout rectangle of the bitmap.
+        *
+        * @since 2.0
+        *
+        * @param aRect Rectangle where the bitmap should be laid out.
+        */
+        IMPORT_C void SetRect( const TRect& aRect );
+
+        /**
+        * Sets the parent position for the layout. This is only
+        * used if parent absolute layout was enabled during construction.
+        *
+        * @since 2.0
+        *
+        * @param aPos Parent position in screen relative coordinates.
+        */
+        IMPORT_C void SetParentPos( const TPoint& aPos );
+
+        /**
+        * Sets the parent context (drawn beneath the context itself).
+        * No ownership is claimed. The parent context object must be
+        * valid as long as it is set as parent context.
+        *
+        * @since 2.6
+        *
+        * @param aParentContext Pointer to the parent context, or
+        *   @c NULL (default value) if none used.
+        */
+        IMPORT_C void SetParentContext( MAknsControlContext* aParentContext );
+
+    public: // Functions from MAknsControlContext
+        
+        /**
+        * @copydoc MAknsControlContext::SupplySkinParameter
+        */
+        TInt SupplySkinParameter( TAknsCCParameter aParam );
+
+        /**
+        * @copydoc MAknsControlContext::SupplySkinObject
+        */
+        TAny* SupplySkinObject( TAknsCCObject aObject );
+
+        /**
+        * @copydoc MAknsControlContext::IsCompatibleWithType
+        */
+        TBool IsCompatibleWithType( const TAknsControlContextType aType ) const;
+        
+    protected:
+
+        /**
+        * C++ constructor.
+        */
+        CAknsBasicBackgroundControlContext();
+
+        /**
+        * Symbian 2nd phase constructor.
+        */
+        void ConstructL( const TRect& aRect, TBool aParentAbsolute,
+            const TAknsItemID& aImageID );
+    
+    protected:  // Data
+        
+        TAknsBackground* iLayout; //<! Background layout structure.
+        MAknsControlContext* iParentContext; //<! Parent context (not owned).
+
+    };
+
+#endif      // AKNSBASICBACKGROUNDCONTROLCONTEXT_H
+            
+// End of File