#define DALI_TOOLKIT_CONTROL_DATA_IMPL_H
/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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 <string>
// INTERNAL INCLUDES
-#include <dali-toolkit/internal/visuals/visual-resource-observer.h>
+#include <dali-toolkit/internal/visuals/visual-event-observer.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
#include <dali/devel-api/common/owner-container.h>
#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
#include <dali-toolkit/internal/controls/tooltip/tooltip.h>
#include <dali-toolkit/internal/builder/style.h>
#include <dali-toolkit/internal/builder/dictionary.h>
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
namespace Dali
{
/**
* @brief Holds the Implementation for the internal control class
*/
-class Control::Impl : public ConnectionTracker, public Visual::ResourceObserver
+class Control::Impl : public ConnectionTracker, public Visual::EventObserver
{
public:
/**
* @brief Constructor.
- * @param[in] controlImpl The control which own this implementation
+ * @param[in] controlImpl The control which owns this implementation
*/
Impl( Control& controlImpl );
/**
* @brief Called when a resource is ready.
* @param[in] object The visual whose resources are ready
- * @note Overriding method in Visual::ResourceObserver.
+ * @note Overriding method in Visual::EventObserver.
*/
- virtual void ResourceReady( Visual::Base& object );
+ void ResourceReady( Visual::Base& object ) override;
+
+ /**
+ * @brief Called when an event occurs.
+ * @param[in] object The visual whose events occur
+ * @param[in] signalId The signal to emit. See Visual to find supported signals
+ * @note Overriding method in Visual::EventObserver.
+ */
+ void NotifyVisualEvent( Visual::Base& object, Property::Index signalId ) override;
/**
* @copydoc Dali::Toolkit::DevelControl::RegisterVisual()
void StartObservingVisual( Toolkit::Visual::Base& visual);
/**
+ * @copydoc Dali::Toolkit::DevelControl::GetVisualResourceStatus()
+ */
+ Toolkit::Visual::ResourceStatus GetVisualResourceStatus( Property::Index index ) const;
+
+ /**
+ * @param[in,out] animation Handle to existing animation, or an empty handle that
+ * can be set to a New animation if createAnimation is true
+ * @param[in] transitionData The transition data describing the animation
+ * @param[in] createAnimation True if the animation should be created
+ */
+ void AddTransitions( Dali::Animation& animation,
+ const Toolkit::TransitionData& transitionData,
+ bool createAnimation = false );
+
+ /**
* @copydoc Dali::Toolkit::DevelControl::CreateTransition()
*/
Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
/**
+ * @copydoc Dali::Toolkit::DevelControl::DoAction()
+ */
+ void DoAction( Dali::Property::Index visualIndex, Dali::Property::Index actionId, const Dali::Property::Value attributes );
+
+ /**
* @brief Function used to set control properties.
* @param[in] object The object whose property to set
* @param[in] index The index of the property to set
bool IsResourceReady() const;
/**
- * @copydoc CustomActorImpl::OnStageDisconnection()
+ * @copydoc CustomActorImpl::OnSceneDisconnection()
+ */
+ void OnSceneDisconnection();
+
+ /**
+ * @brief Sets the margin.
+ * @param[in] margin Margin is a collections of extent ( start, end, top, bottom )
+ */
+ void SetMargin( Extents margin );
+
+ /**
+ * @brief Returns the value of margin
+ * @return The value of margin
+ */
+ Extents GetMargin() const;
+
+ /**
+ * @brief Sets the padding.
+ * @param[in] padding Padding is a collections of extent ( start, end, top, bottom ).
+ */
+ void SetPadding( Extents padding );
+
+ /**
+ * @brief Returns the value of padding
+ * @return The value of padding
*/
- void OnStageDisconnection();
+ Extents GetPadding() const;
+
+ /**
+ * @brief Set the input method context.
+ * @param[in] inputMethodContext The input method context.
+ */
+ void SetInputMethodContext( InputMethodContext& inputMethodContext );
+
+ /**
+ * @brief Filter an key event.
+ * @param[in] event The key to be filtered.
+ * @return True if the key handled, otherwise false.
+ */
+ bool FilterKeyEvent( const KeyEvent& event );
+
+ /**
+ * @copydoc DevelControl::VisualEventSignal()
+ */
+ DevelControl::VisualEventSignalType& VisualEventSignal();
+
+ /**
+ * @brief Sets the shadow with a property map.
+ * @param[in] map The shadow property map
+ */
+ void SetShadow(const Property::Map& map);
+
+ /**
+ * @brief Clear the shadow.
+ */
+ void ClearShadow();
private:
*/
void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, VisualState::Type enabled, DepthIndexValue::Type depthIndexValueSet, int depthIndex = 0 );
+ /**
+ * @brief Emits the resource ready signal.
+ */
+ void EmitResourceReadySignal();
+
+ /**
+ * @brief Callbacks called on idle.
+ */
+ void OnIdleCallback();
+
public:
Control& mControlImpl;
std::string mStyleName;
Vector4 mBackgroundColor; ///< The color of the background visual
Vector3* mStartingPinchScale; ///< The scale when a pinch gesture starts, TODO: consider removing this
+ Extents mMargin; ///< The margin values
+ Extents mPadding; ///< The padding values
Toolkit::Control::KeyEventSignalType mKeyEventSignal;
Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusGainedSignal;
Toolkit::Control::KeyInputFocusSignalType mKeyInputFocusLostSignal;
Toolkit::Control::ResourceReadySignalType mResourceReadySignal;
+ DevelControl::VisualEventSignalType mVisualEventSignal;
// Gesture Detection
PinchGestureDetector mPinchGestureDetector;
// Tooltip
TooltipPtr mTooltip;
+ InputMethodContext mInputMethodContext;
+ CallbackBase* mIdleCallback; ///< The idle callback to emit the resource ready signal.
+
ControlBehaviour mFlags : CONTROL_BEHAVIOUR_FLAG_COUNT; ///< Flags passed in from constructor.
bool mIsKeyboardNavigationSupported :1; ///< Stores whether keyboard navigation is supported by the control.
bool mIsKeyboardFocusGroup :1; ///< Stores whether the control is a focus group.
+ bool mIsEmittingResourceReadySignal :1; ///< True during ResourceReady().
+ bool mNeedToEmitResourceReady :1; ///< True if need to emit the resource ready signal again.
RegisteredVisualContainer mRemoveVisuals; ///< List of visuals that are being replaced by another visual once ready
+
// Properties - these need to be members of Internal::Control::Impl as they access private methods/data of Internal::Control and Internal::Control::Impl.
static const PropertyRegistration PROPERTY_1;
static const PropertyRegistration PROPERTY_2;
static const PropertyRegistration PROPERTY_10;
static const PropertyRegistration PROPERTY_11;
static const PropertyRegistration PROPERTY_12;
+ static const PropertyRegistration PROPERTY_13;
+ static const PropertyRegistration PROPERTY_14;
+ static const PropertyRegistration PROPERTY_15;
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff