/*
* 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: layout attribute setters base implementation header.
*
*/
#ifndef ALFCOMMONLAYOUTATTRIBUTESETTER_H
#define ALFCOMMONLAYOUTATTRIBUTESETTER_H
#include <osn/osndefines.h>
#include <memory>
#include <osn/ustring.h>
#include "alf/alfcommonvisualattributesetter.h"
using namespace osncore;
using std::auto_ptr;
namespace Alf
{
/**
* @class AlfCommonLayoutAttributeSetter alfcommonlayoutattributesetter.h "alf/alfcommonlayoutattributesetter.h"
* Base implementation for layout attribute setters. Attribute setters for custom layouts can derive from this
* class.
* @see IAlfAttributeSetter
*
* @lib alfwidgetmodel.lib
* @since S60 ?S60_version
* @status Draft
* @interfaces IAlfAttributeSetter
*/
class AlfCommonLayoutAttributeSetter : public AlfCommonVisualAttributeSetter
{
public:
/**
* Constructor.
*
* @param aType Type of the attribute setter.
*/
OSN_IMPORT AlfCommonLayoutAttributeSetter();
/**
* Destructor.
*/
OSN_IMPORT virtual ~AlfCommonLayoutAttributeSetter();
/**
* Sets the attribute values to the target visual.
* @exception osncore::AlfVisualException Thrown with error code osncore::EInvalidVisual if aVisual is not
* a layout.
*
* @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.
*
* @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.
* @ret 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 = NULL );
/**
* 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 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.
*/
OSN_IMPORT virtual void createAndSendCommands(
CAlfVisual& aVisual,
AlfAttributeContainer* aContainer,
CAlfVisual* aRefVisual = NULL );
protected:
/**
* From AlfCommonVisualAttributeSetter
* Sets an value of a static attribute to target visual immediately without a transition.
*
* @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.
*/
void handleStaticAttribute(CAlfVisual &aVisual, AlfAttribute& aAttr,
AlfAttributeContainer& aContainer);
/**
* From AlfCommonVisualAttributeSetter
* 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.
*/
void handleDynamicAttribute(CAlfVisual &aVisual, AlfAttribute& aAttr,
AlfAttributeContainer& aContainer);
/**
* From AlfCommonVisualAttributeSetter
* Sets an value for static attribute in the target visual immediately without a transition using 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.
*/
void handleStaticDataAttribute(CAlfVisual &aVisual, AlfAttribute& aAttr,
AlfAttributeContainer& aContainer, IAlfMap* aData);
/**
* From AlfCommonVisualAttributeSetter
* 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.
*/
void handleDynamicDataAttribute(CAlfVisual &aVisual, AlfAttribute& aAttr,
AlfAttributeContainer& aContainer, IAlfMap* aData);
};
} // namespace Alf
#endif // ALFCOMMONLAYOUTATTRIBUTESETTER_H