X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol.h;h=cdeee6b38cd34c5b7ea8a55d0be6bed89a7313ab;hp=6a5ba6233326d87f376a230621b8554725879ed6;hb=92a400c3857fbf6c1e63693f22c94dcffe50e522;hpb=502a6996c58f8b8de2dd530235852d53d01d2ac0 diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index 6a5ba62..cdeee6b 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -91,11 +91,36 @@ public: { enum { - STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string @SINCE_1_0.0 - BACKGROUND_COLOR, ///< name "background-color", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 @SINCE_1_0.0 - BACKGROUND_IMAGE, ///< name "background-image", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map @SINCE_1_0.0 - KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool @SINCE_1_0.0 - BACKGROUND, ///< name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map @SINCE_1_1.3 + /** + * @brief name "styleName", type std::string + * @SINCE_1_0.0 + * @see SetStyleName + */ + STYLE_NAME = PROPERTY_START_INDEX, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 + * @SINCE_1_0.0 + * @see SetStyleName + */ + BACKGROUND_COLOR, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map + * @SINCE_1_0.0 + */ + BACKGROUND_IMAGE, + /** + * @brief name "keyInputFocus", type bool + * @SINCE_1_0.0 + * @see SetKeyInputFocus + */ + KEY_INPUT_FOCUS, + /** + * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map + * @SINCE_1_1.3 + */ + BACKGROUND, }; }; @@ -144,14 +169,14 @@ public: // Creation & Destruction /** * @brief Copy constructor. * - * Creates another handle that points to the same real object + * Creates another handle that points to the same real object. * @SINCE_1_0.0 * @param[in] uiControl Handle to copy */ Control(const Control& uiControl); /** - * @brief Dali::Control is intended as a base class + * @brief Dali::Control is intended as a base class. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -163,7 +188,7 @@ public: // operators /** * @brief Assignment operator. * - * Changes this handle to point to another real object + * Changes this handle to point to another real object. * @SINCE_1_0.0 * @param[in] handle Object to assign this to * @return reference to this @@ -173,14 +198,14 @@ public: // operators public: /** - * @brief Downcast an Object handle to Control. + * @brief Downcast a handle to Control handle. * * If handle points to a Control the downcast produces valid * handle. If not the returned handle is left uninitialized. * * @SINCE_1_0.0 * @param[in] handle Handle to an object - * @return handle to a Control or an uninitialized handle + * @return A handle to a Control or an uninitialized handle */ static Control DownCast( BaseHandle handle ); @@ -191,7 +216,6 @@ public: * * The key event can originate from a virtual or physical keyboard. * @SINCE_1_0.0 - * @return True if the control has foucs, False otherwise. * @pre The Control has been initialized. * @pre The Control should be on the stage before setting keyboard focus. */ @@ -200,15 +224,15 @@ public: /** * @brief Quries whether the control has key input focus. * - * Note: The control can be set to have the focus and still not receive all the key events if another control has over ridden it. - * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the - * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more - * controls above it in the focus stack. - * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor() * @SINCE_1_0.0 * @return true if this control has keyboard input focus * @pre The Control has been initialized. * @pre The Control should be on the stage before setting keyboard focus. + * @note The control can be set to have the focus and still not receive all the key events if another control has over ridden it. + * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the + * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more + * controls above it in the focus stack. + * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor(). */ bool HasKeyInputFocus(); @@ -271,7 +295,6 @@ public: /** * @brief Retrieves the name of the style to be applied to the control (if any). - * * @SINCE_1_0.0 * @return A string matching a style or an empty string. */ @@ -292,7 +315,7 @@ public: void SetBackgroundColor( const Vector4& color ); /** - * @deprecated DALi 1.1.3 API removed. + * @DEPRECATED_1_1.3 * * @brief Retrieves the background color of the control. * @@ -333,7 +356,7 @@ public: KeyEventSignalType& KeyEventSignal(); /** - * @brief This signal is emitted when the control gets Key Input Focus + * @brief This signal is emitted when the control gets Key Input Focus. * * A callback of the following type may be connected: * @code