#define DALI_TOOLKIT_INTERNAL_VISUAL_H
/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <dali-toolkit/internal/visuals/transition-data-impl.h>
#include <dali-toolkit/internal/visuals/visual-factory-cache.h>
#include <dali-toolkit/devel-api/direction-enums.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+#include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
namespace Dali
{
namespace Visual
{
-class ResourceObserver;
+class EventObserver;
+
+using FittingMode = DevelVisual::FittingMode;
/**
* Base class for all Control rendering logic. A control may have multiple visuals.
/**
* @copydoc Toolkit::Visual::Base::GetName
*/
- const std::string& GetName();
+ const std::string& GetName() const;
/**
* @copydoc Toolkit::Visual::Base::SetSize
* If the visual isn't staged (i.e. it doesn't have a renderer),
* then this will not add an animation.
*
+ * If the animator is valid and the transition handle is empty - it will
+ * be created.
+ *
* @param[in] transition The animation to create or attach to
* @param[in] animator The animation parameters of the property.
*/
Internal::TransitionData::Animator& animator );
/**
- * @brief Add an observer to watch for when the Visuals resources are loaded.
+ * @brief Add an observer to watch for when the Visuals have events to notify
* Currently only supports a single observer
- *
*/
- void AddResourceObserver( Visual::ResourceObserver& observer );
+ void AddEventObserver( Visual::EventObserver& observer );
/**
* @brief Remove an observer
*/
- void RemoveResourceObserver( Visual::ResourceObserver& observer );
+ void RemoveEventObserver( Visual::EventObserver& observer );
/**
* @brief Called when the visuals resources are loaded / ready
*/
Toolkit::Visual::ResourceStatus GetResourceStatus() const;
-protected:
+ /**
+ * @brief Get the fitting mode for the visual
+ */
+ FittingMode GetFittingMode() const;
+
+ /**
+ * @brief Get the actual Visual Object.
+ * @return The actual visual object
+ * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects.
+ */
+ virtual Base& GetVisualObject();
+
+ /**
+ * @brief Query whether resources requires to be loaded synchronously.
+ * @return Returns true if synchronous resource loading is required, false otherwise.
+ */
+ bool IsSynchronousLoadingRequired() const;
+
+ /**
+ * @brief Get the type of this visual.
+ *
+ * @return The the type of this visual.
+ */
+ Toolkit::Visual::Type GetType() const;
+
+ protected:
/**
* @brief Constructor.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] fittingMode The value that determines how the visual should be fit to the view
+ * @param[in] type The type of the this visual
*/
- Base( VisualFactoryCache& factoryCache );
+ Base( VisualFactoryCache& factoryCache, FittingMode fittingMode, Toolkit::Visual::Type type );
/**
* @brief A reference counted object may only be deleted by calling Unreference().
* @param[in] actionId The action to perform
* @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content )
*/
- virtual void OnDoAction( const Property::Index actionId, const Property::Value attributes );
+ virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes );
protected:
*/
bool IsOnStage() const;
+ /**
+ * @brief Query whether the corners of the visual requires to be rounded.
+ *
+ * @return Returns true if the rounded corner is required, false otherwise.
+ */
+ bool IsRoundedCornerRequired() const;
+
private:
/**