diff -r 4ea6f81c838a -r 0e9bb658ef58 inc/alf/alfgridlayoutattributesetter.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/inc/alf/alfgridlayoutattributesetter.h Wed Sep 01 12:23:18 2010 +0100 @@ -0,0 +1,172 @@ +/* +* Copyright (c) 2007 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: Grid layout attribute setter Header. +* +*/ + + +#ifndef ALFGRIDLAYOUTATTRIBUTESETTER_H +#define ALFGRIDLAYOUTATTRIBUTESETTER_H + +//includes + +//widget model includes +#include "alf/alfcommonlayoutattributesetter.h" + +//osn includes +#include + +namespace Alf + { + +/** @class AlfGridLayoutAttributeSetter alfgridlayoutattributesetter.h "alf/alfgridlayoutattributesetter.h" + * The implementation of the grid attribute setter. + * + * @interfaces IAlfAttributeSetter + * @lib alfwidgetmodel.lib + * @since S60 ?S60_version + * @status Draft + */ + +class AlfGridLayoutAttributeSetter : public AlfCommonLayoutAttributeSetter + { + +public: + + /** + * Constructor. + * + * @param aType Type of the attribute setter. + */ + OSN_IMPORT AlfGridLayoutAttributeSetter(); + + /** + * Destructor. + */ + OSN_IMPORT virtual ~AlfGridLayoutAttributeSetter(); + + + /** + * Sets the attribute values to the target visual. + * + * @exception osncore::AlfVisualException Thrown with the error code osncore::EInvalidVisual\n + * when supplied visual is not a grid layout visual. + * @since S60 ?S60_version + * @param aVisual The target visual. Doesn't take ownership + * @param aContainer The container holding the value of the attributes. + * Ownership of the object is not transferred. + * @param aData Used with data attributes to fetch the data. + */ + OSN_IMPORT virtual void setAttributeValue ( + CAlfVisual &aVisual, + AlfAttributeContainer* aContainer, + IAlfMap* aData ); + + /** + * Creates a command to change the value of an attribute in the target visual gradually with a transition. + * + * @deprecated use createAndSendCommands instead. + * @param aVisual The target visual. Doesn't take ownership + * @param aContainer The container holding the new value of the attribute. Ownership of the object is not transferred. + * @param aData Not used currently. + * @param aTransitionTime Time used for the transition. + * @param aRefVisual Optional reference visual. If not NULL, the target value of the attribute is defined by adding + * the value specific by aContainer to the corresponding attribute value in the reference visual. + * @return The command to gradually change the attribute in the target visual. + */ + OSN_IMPORT virtual TAlfCommand* createCommand ( + CAlfVisual& aVisual, + AlfAttributeContainer* aContainer, + IAlfMap* aData, + int aTransitionTime = 0, + CAlfVisual* aRefVisual = 0); + + /** + * Creates commands to change the given attribute values in the target visual gradually with a transition. + * Then sends the commands via the ALF environment. + * + * @param aVisual The target visual. Doesn't take ownership + * @param aContainer The attribute container holding the attribute value(s) + * used by the attribute setter. Ownership is not transferred. The container + * can hold new values for multiple different attributes, in which case several + * commands are executed. + * @param aRefVisual Optional reference visual. If valid pointer, the target value of the attribute is defined by adding + * the value specific by aContainer to the corresponding attribute value in the reference visual. + */ + OSN_IMPORT virtual void createAndSendCommands ( + CAlfVisual& aVisual, + AlfAttributeContainer* aContainer, + CAlfVisual* aRefVisual = 0); + +protected: + /** + * From AlfCommonLayoutAttributeSetter + * Sets an dynamic attribute value in the target visual using transitions defined in attributes + * + * @param aVisual The target visual. Doesn't take ownership + * @param aAttr The attribute to process. Doesn't take ownership + * @param aContainer The container holding attributes. Ownership of the object is not transferred. + */ + virtual void handleDynamicAttribute ( CAlfVisual &aVisual, AlfAttribute& aAttr, AlfAttributeContainer& aContainer); + + /** + * From AlfCommonLayoutAttributeSetter + * Sets an value for static attribute in the target visual immediately without a transition using data in map. + * + * @exception osncore::AlfDataException Thrown with the error code osncore::ECommonError\n + * when invalid data is supplied for grid layout. + * @exception osncore::AlfException Thrown with the error code osncore::ECommonError\n + * when there is an exception in setting attributes for grid layout. + * @param aVisual The target visual. Doesn't take ownership + * @param aAttr The attribute to process. Doesn't take ownership + * @param aContainer The container holding attributes. Ownership of the object is not transferred. + * @param aData Contains data.Ownership of the object is not transferred. + */ + virtual void handleStaticDataAttribute ( CAlfVisual &aVisual, AlfAttribute& aAttr, AlfAttributeContainer& aContainer, IAlfMap* aData ); + + /** + * From AlfCommonLayoutAttributeSetter + * Sets an value for dynamic attribute value in the target visual using transitions and data in map. + * + * @param aVisual The target visual. Doesn't take ownership + * @param aAttr The attribute to process. Doesn't take ownership + * @param aContainer The container holding attributes. Ownership of the object is not transferred. + * @param aData Contains data.Ownership of the object is not transferred. + */ + virtual void handleDynamicDataAttribute ( CAlfVisual &aVisual, AlfAttribute& aAttr, AlfAttributeContainer& aContainer, IAlfMap* aData ); + + /** + * From AlfCommonLayoutAttributeSetter + * Sets an value of a static attribute to target visual immediately without a transition. + * + * @exception osncore::AlfException Thrown with the error code osncore::ECommonError\n + * when there is an exception in setting attributes for grid layout. + * @exception osncore::AlfAttributeException Thrown with the error code osncore::EInvalidAttribute\n + * when invalid attributes are supplied for grid layout. + * @param aVisual The target visual. Doesn't take ownership + * @param aAttr The attribute to process. Doesn't take ownership + * @param aContainer The container holding attributes. Ownership of the object is not transferred. + * @param aData Contains data.Ownership of the object is not transferred. + */ + virtual void handleStaticAttribute ( CAlfVisual &aVisual, AlfAttribute& aAttr, AlfAttributeContainer& aContainer); + +private: // data + }; + + } // namespace Alf + +#endif // ALFGRIDLAYOUTATTRIBUTESETTER_H +// End of file + +