X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol.h;h=58f3205bca4c0c1331b6adcbb9b6a01bc4856ac0;hb=a1569d27e91ea58dbfbcdb3692fe10a971d06732;hp=c68d41a0ecd6a32fe23c17643718398c90e90ed3;hpb=8cd51ee7d23a0981aaacfae27cf39d4c80c898cf;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index c68d41a..58f3205 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -97,35 +97,65 @@ 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, + /** * @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 or Vector4 for Color. + * @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 }; }; @@ -420,12 +450,30 @@ public: * * 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();