X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol.h;h=157e56b920b25609b970bf816b582c6f0ad8fba3;hb=63f9b5207c2794cdc460d587723be89585872a51;hp=3bada38fa4cca7652227354a95bd0123ed915dc7;hpb=b591ef50e17d16b10cf49affe0122f4727245c65;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 3bada38..157e56b 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -130,6 +130,10 @@ public: */ struct KeyboardFocus { + /** + * @brief Keyboard focus direction + * @SINCE_1_0.0 + */ enum Direction { LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0 @@ -169,14 +173,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 @@ -188,7 +192,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 @@ -198,14 +202,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 ); @@ -216,7 +220,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. */ @@ -225,15 +228,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(); @@ -326,6 +329,8 @@ public: Vector4 GetBackgroundColor() const; /** + * @DEPRECATED_1_2.8, use Property::BACKGROUND instead + * * @brief Sets an image as the background of the control. * * @SINCE_1_0.0 @@ -357,7 +362,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