-#ifndef __DALI_TOOLKIT_CONTROL_H__
-#define __DALI_TOOLKIT_CONTROL_H__
+#ifndef DALI_TOOLKIT_CONTROL_H
+#define DALI_TOOLKIT_CONTROL_H
/*
- * Copyright (c) 2016 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.
// EXTERNAL INCLUDES
#include <dali/public-api/actors/custom-actor.h>
-#include <dali/public-api/common/dali-common.h>
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
#include <dali/public-api/events/long-press-gesture-detector.h>
#include <dali/public-api/events/pan-gesture-detector.h>
#include <dali/public-api/events/pinch-gesture-detector.h>
#include <dali/public-api/events/tap-gesture-detector.h>
#include <dali/public-api/images/image.h>
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/visuals/visual-properties.h>
+
namespace Dali
{
* | keyEvent | @ref KeyEventSignal() |
* | keyInputFocusGained | @ref KeyInputFocusGainedSignal() |
* | keyInputFocusLost | @ref KeyInputFocusLostSignal() |
+ * | resourceReady | @ref ResourceReadySignal() |
* | tapped | @ref GetTapGestureDetector().DetectedSignal() |
* | panned | @ref GetPanGestureDetector().DetectedSignal() |
* | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
* |------------------------|----------------------------------------------------|
* | accessibilityActivated | %OnAccessibilityActivated() |
*/
-class DALI_IMPORT_API Control : public CustomActor
+class DALI_TOOLKIT_API Control : public CustomActor
{
public:
enum
{
/**
- * @brief name "styleName", type std::string.
+ * @brief The name of the style to be applied to the control.
+ * @details Name "styleName", type Property::STRING.
+ * @see Toolkit::Control::SetStyleName()
* @SINCE_1_0.0
- * @see SetStyleName
*/
STYLE_NAME = PROPERTY_START_INDEX,
+
+ RESERVED_PROPERTY_01, ///< Reserved index for a removed property.
+ RESERVED_PROPERTY_02, ///< Reserved index for a removed property.
+
/**
- * @DEPRECATED_1_1.3
- * @brief name "backgroundColor", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4.
+ * @brief Receives key events to the control.
+ * @details Name "keyInputFocus", type Property::BOOLEAN.
+ * @see Toolkit::Control::SetKeyInputFocus()
* @SINCE_1_0.0
- * @see SetStyleName
*/
- BACKGROUND_COLOR,
+ KEY_INPUT_FOCUS,
+
/**
- * @DEPRECATED_1_1.3
- * @brief name "backgroundImage", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map.
- * @SINCE_1_0.0
+ * @brief The background of the control.
+ *
+ * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
+ * @SINCE_1_1.3
*/
- BACKGROUND_IMAGE,
+ BACKGROUND,
+
/**
- * @brief name "keyInputFocus", type bool.
- * @SINCE_1_0.0
- * @see SetKeyInputFocus
+ * @brief The outer space around the control.
+ * @details Name "margin", type Property::EXTENTS.
+ * @SINCE_1_2.62
+ * @note Margin property is to be supported by Layout algorithms and containers in future.
*/
- KEY_INPUT_FOCUS,
+ MARGIN,
+
/**
- * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL.
- * @SINCE_1_1.3
+ * @brief The inner space of the control.
+ * @details Name "padding", type Property::EXTENTS.
+ * @SINCE_1_2.62
*/
- BACKGROUND,
+ PADDING
};
};
// Typedefs
- /// @brief Key Event signal type;
+ /// @brief Key Event signal type. @SINCE_1_0.0
typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
- /// @brief Key InputFocusType signal type;
+ /// @brief Key InputFocusType signal type. @SINCE_1_0.0
typedef Signal<void ( Control ) > KeyInputFocusSignalType;
+ /// @brief ResourceReady signal type. @SINCE_1_2.60
+ typedef Signal<void ( Control ) > ResourceReadySignalType;
+
public: // Creation & Destruction
/**
void SetBackgroundColor( const Vector4& color );
/**
- * @DEPRECATED_1_1.3
- *
- * @brief Retrieves the background color of the control.
- *
+ * @brief Clears the background.
* @SINCE_1_0.0
- * @return The background color of the control
*/
- Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
+ void ClearBackground();
+
+ // Resources
/**
- * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
- *
- * @brief Sets an image as the background of the control.
+ * @brief Query if all resources required by a control are loaded and ready.
*
- * @SINCE_1_0.0
- * @param[in] image The image to set as the background
+ * Most resources are only loaded when the control is placed on stage.
+ * @SINCE_1_2.60
+ * @return true if the resources are loaded and ready, false otherwise
*/
- void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
+ bool IsResourceReady() const;
/**
- * @brief Clears the background.
- * @SINCE_1_0.0
+ * @brief Get the loading state of the visual resource.
+ *
+ * @SINCE_1_3_5
+ * @param[in] index The Property index of the visual
+ * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
*/
- void ClearBackground();
+ Visual::ResourceStatus GetVisualResourceStatus( const Dali::Property::Index index );
// Signals
KeyInputFocusSignalType& KeyInputFocusGainedSignal();
/**
- * @brief This signal is emitted when the control loses Key Input Focus
- * which could be due to it being gained by another Control or Actor or just cleared from
+ * @brief This signal is emitted when the control loses Key Input Focus.
+ *
+ * This could be due to it being gained by another Control or Actor or just cleared from
* this control as no longer required.
*
* A callback of the following type may be connected:
*/
KeyInputFocusSignalType& KeyInputFocusLostSignal();
+ /**
+ * @brief This signal is emitted after all resources required by a control are loaded and ready.
+ *
+ * Most resources are only loaded when the control is placed on stage.
+ *
+ * If resources are shared between ImageViews, they are cached.
+ * In this case, the ResourceReady signal may be sent before there is an object to connect to.
+ * To protect against this, IsResourceReady() can be checked first.
+ *
+ * @code
+ * auto newControl = Control::New();
+ * newControl.SetResource( resourceUrl );
+ * if ( newControl.IsResourceReady() )
+ * {
+ * // do something
+ * }
+ * else
+ * {
+ * newControl.ResourceReadySignal.Connect( .... )
+ * }
+ * @endcode
+ *
+ * A callback of the following type may be connected:
+ * @code
+ * void YourCallbackName( Control control );
+ * @endcode
+ *
+ * @SINCE_1_2.60
+ * @return The signal to connect to
+ * @note A RelayoutRequest is queued by Control before this signal is emitted
+ */
+ ResourceReadySignalType& ResourceReadySignal();
+
public: // Intended for control developers
/**
} // namespace Dali
-#endif // __DALI_TOOLKIT_CONTROL_H__
+#endif // DALI_TOOLKIT_CONTROL_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff