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=3b6b33fab0c94a3fff56ab8d74dbf12c2d4fdc20;hp=a1e51f551afce605f88413d0f911743eed9883a8;hb=07bbc876b9b069903dd4ed86c9dd5f2f66fc3b86;hpb=dc3613bb6248908c267a76e378b04962bce85664 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 a1e51f5..3b6b33f 100644 --- a/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h +++ b/dali-toolkit/public-api/focus-manager/keyboard-focus-manager.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_KEYBOARD_FOCUS_MANAGER_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class KeyboardFocusManager; } +/** + * @addtogroup dali-toolkit-focus-manager + * @{ + */ /** * @brief Provides the functionality of handling keyboard navigation @@ -47,7 +51,7 @@ class KeyboardFocusManager; * | keyboard-pre-focus-change | @ref PreFocusChangeSignal() | * | keyboard-focus-changed | @ref FocusChangedSignal() | * | keyboard-focus-group-changed | @ref FocusGroupChangedSignal() | - * | keyboard-focused-actor-activated | @ref FocusedActorActivatedSignal() | + * | keyboard-focused-actor-enter-key | @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