X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Ffocus-manager%2Fkeyboard-focus-manager.h;h=78152a125ee87ecfb4b9be08f10e4a1b00d6ec00;hp=68638a3150c50126977e2ebc7c1f842f3c0f958d;hb=f3da11c2818c6d17706fbb2417f21b602b3190f5;hpb=68106e2cbb8541c18a77f39770ea7759f44e02a0 diff --git a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h index 68638a3..78152a1 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class KeyboardFocusManager; } +/** + * @addtogroup dali_toolkit_focus_manager + * @{ + */ /** * @brief Provides the functionality of handling keyboard navigation @@ -42,12 +46,12 @@ class KeyboardFocusManager; * is changed. * * Signals - * | %Signal Name | Method | - * |----------------------------------|------------------------------------| - * | keyboard-pre-focus-change | @ref PreFocusChangeSignal() | - * | keyboard-focus-changed | @ref FocusChangedSignal() | - * | keyboard-focus-group-changed | @ref FocusGroupChangedSignal() | - * | keyboard-focused-actor-activated | @ref FocusedActorActivatedSignal() | + * | %Signal Name | Method | + * |-------------------------------|------------------------------------| + * | keyboardPreFocusChange | @ref PreFocusChangeSignal() | + * | keyboardFocusChanged | @ref FocusChangedSignal() | + * | keyboardFocusGroupChanged | @ref FocusGroupChangedSignal() | + * | keyboardFocusedActorAenterKey | @ref FocusedActorEnterKeySignal() | */ class DALI_IMPORT_API KeyboardFocusManager : public BaseHandle { @@ -55,7 +59,7 @@ class DALI_IMPORT_API KeyboardFocusManager : public BaseHandle public: /// @brief Pre focus change signal - typedef Signal< Actor ( Actor, Actor, Control::KeyboardFocusNavigationDirection ) > PreFocusChangeSignalType; + typedef Signal< Actor ( Actor, Actor, Control::KeyboardFocus::Direction ) > PreFocusChangeSignalType; /// @brief Focus changed signal typedef Signal< void ( Actor, Actor ) > FocusChangedSignalType; @@ -63,8 +67,8 @@ public: /// @brief Focus group changed signal typedef Signal< void ( Actor, bool ) > FocusGroupChangedSignalType; - /// @brief Focused actor activated signal - typedef Signal< void ( Actor ) > FocusedActorActivatedSignalType; + /// @brief Focused actor has the enter key pressed signal + typedef Signal< void ( Actor ) > FocusedActorEnterKeySignalType; /** * @brief Create a KeyboardFocusManager handle; this can be initialised with KeyboardFocusManager::New(). @@ -117,7 +121,7 @@ public: * @param direction The direction of focus movement * @return true if the movement was successful */ - bool MoveFocus(Control::KeyboardFocusNavigationDirection direction); + bool MoveFocus(Control::KeyboardFocus::Direction direction); /** * @brief Clear the focus from the current focused actor if any, so @@ -214,7 +218,7 @@ public: // Signals * * A callback of the following type may be connected: * @code - * Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocusNavigationDirection direction); + * Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocus::Direction direction); * @endcode * @pre The Object has been initialized. * @return The signal to connect to. @@ -251,16 +255,16 @@ public: // Signals FocusGroupChangedSignalType& FocusGroupChangedSignal(); /** - * @brief This signal is emitted when the current focused actor is activated. + * @brief This signal is emitted when the current focused actor has the enter key pressed on it. * * A callback of the following type may be connected: * @code - * void YourCallbackName(Actor activatedActor); + * void YourCallbackName(Actor enterPressedActor); * @endcode * @pre The Object has been initialized. * @return The signal to connect to. */ - FocusedActorActivatedSignalType& FocusedActorActivatedSignal(); + FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal(); // Not intended for application developers @@ -273,6 +277,9 @@ public: // Signals }; // class KeyboardFocusManager +/** + * @} + */ } // namespace Toolkit } // namespace Dali