#define __DALI_TOOLKIT_CONTROL_H__
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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/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() |
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,
+
/**
* @DEPRECATED_1_1.3
- * @brief name "backgroundColor", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4.
+ * @brief The background color of the control.
+ *
+ * Mutually exclusive with BACKGROUND_IMAGE & BACKGROUND.
+ * @details Name "backgroundColor", type Property::VECTOR4.
+ * @see Toolkit::Control::SetStyleName()
* @SINCE_1_0.0
- * @see SetStyleName
*/
BACKGROUND_COLOR,
+
/**
* @DEPRECATED_1_1.3
- * @brief name "backgroundImage", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map.
+ * @brief The background image of the control.
+ *
+ * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND.
+ * @details Name "backgroundImage", type Property::MAP.
* @SINCE_1_0.0
*/
BACKGROUND_IMAGE,
+
/**
- * @brief name "keyInputFocus", type bool.
+ * @brief Receives key events to the control.
+ * @details Name "keyInputFocus", type Property::BOOLEAN.
+ * @see Toolkit::Control::SetKeyInputFocus()
* @SINCE_1_0.0
- * @see SetKeyInputFocus
*/
KEY_INPUT_FOCUS,
+
/**
- * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL.
+ * @brief The background of the control.
+ *
+ * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE.
+ * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
* @SINCE_1_1.3
*/
BACKGROUND,
+
+ /**
+ * @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.
+ */
+ MARGIN,
+
+ /**
+ * @brief The inner space of the control.
+ * @details Name "padding", type Property::EXTENTS.
+ * @SINCE_1_2.62
+ */
+ 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 ClearBackground();
+ // Resources
+
+ /**
+ * @brief Query if all resources required by a control are loaded and ready.
+ *
+ * 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
+ */
+ bool IsResourceReady() const;
+
+ /**
+ * @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
+ */
+ 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
/**
projects / platform / core / uifw / dali-toolkit.git / blobdiff