X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Faccessibility-manager%2Faccessibility-manager.h;h=4a1c1486521d32bf3b643d4606f82a7658b4a632;hb=cb30ef68af0383b073ba2d425d3d95c1e916cbb4;hp=59ec87693745f65f40dd8adde8fe3b889e82a71c;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h index 59ec876..4a1c148 100644 --- a/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h +++ b/dali-toolkit/public-api/accessibility-manager/accessibility-manager.h @@ -20,7 +20,6 @@ // EXTERNAL INCLUDES #include -#include namespace Dali { @@ -33,12 +32,12 @@ namespace Internal DALI_INTERNAL class AccessibilityManager; } /** - * @addtogroup dali_toolkit_accessibility_manager + * @addtogroup dali_toolkit_managers * @{ */ /** - * @brief Manages registration of actors in a accessibility focus chain and changing the + * @brief Manages registration of actors in an accessibility focus chain and changing the * focused actor within that chain. * * This class provides the functionality of registering the focus order and description @@ -66,12 +65,13 @@ public: * @brief Accessibility Action Signal. * * The connected signal callback should return true if handled. + * @SINCE_1_0.0 */ typedef Signal< bool ( AccessibilityManager& ) > AccessibilityActionSignalType; ///< Generic signal type @SINCE_1_0.0 typedef Signal< bool ( AccessibilityManager&, const Dali::TouchEvent& )> AccessibilityActionScrollSignalType; ///< Scroll signal type @SINCE_1_0.0 /** - * @brief Accessibility needs four information which will be read by screen-reader. + * @brief Enumeration for accessibility that needs four information which will be read by screen-reader. * * Reading order : Label -> Trait -> Optional (Value and Hint) * @SINCE_1_0.0 @@ -86,7 +86,7 @@ public: }; /** - * @brief Overshoot direction. + * @brief Enumeration for overshoot direction. * @SINCE_1_0.0 */ enum FocusOvershotDirection @@ -98,24 +98,27 @@ public: public: /// @brief Focus changed signal + /// @SINCE_1_0.0 typedef Signal< void ( Actor, Actor ) > FocusChangedSignalType; /// @brief Focus overshooted signal + /// @SINCE_1_0.0 typedef Signal< void ( Actor, FocusOvershotDirection ) > FocusOvershotSignalType; /// @brief Focused actor activated signal + /// @SINCE_1_0.0 typedef Signal< void ( Actor ) > FocusedActorActivatedSignalType; /** - * @brief Create a AccessibilityManager handle; this can be initialised with AccessibilityManager::New(). + * @brief Creates an AccessibilityManager handle; this can be initialised with AccessibilityManager::New(). * - * Calling member functions with an uninitialised handle is not allowed. + * Calling member functions with an uninitialized handle is not allowed. * @SINCE_1_0.0 */ AccessibilityManager(); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -123,18 +126,18 @@ public: ~AccessibilityManager(); /** - * @brief Get the singleton of AccessibilityManager object. + * @brief Gets the singleton of AccessibilityManager object. * * @SINCE_1_0.0 - * @return A handle to the AccessibilityManager control. + * @return A handle to the AccessibilityManager control */ static AccessibilityManager Get(); /** - * @brief Set the information of the specified actor's accessibility attribute. + * @brief Sets the information of the specified actor's accessibility attribute. * * @SINCE_1_0.0 - * @param actor The actor the text to be set with + * @param actor The actor, the text to be set with * @param type The attribute type the text to be set with * @param text The text for the actor's accessibility information * @pre The AccessibilityManager has been initialized. @@ -143,7 +146,7 @@ public: void SetAccessibilityAttribute(Actor actor, AccessibilityAttribute type, const std::string& text); /** - * @brief Get the text of the specified actor's accessibility attribute. + * @brief Gets the text of the specified actor's accessibility attribute. * * @SINCE_1_0.0 * @param actor The actor to be queried @@ -155,10 +158,10 @@ public: std::string GetAccessibilityAttribute(Actor actor, AccessibilityAttribute type) const; /** - * @brief Set the focus order of the actor. + * @brief Sets the focus order of the actor. * - * The focus order of each actor in the focus chain is unique. If - * there is another actor assigned with the same focus order + * The focus order of each actor in the focus chain is unique. + * If there is another actor assigned with the same focus order * already, the new actor will be inserted to the focus chain with * that focus order, and the focus order of the original actor and * all the actors followed in the focus chain will be increased @@ -176,7 +179,7 @@ public: void SetFocusOrder(Actor actor, const unsigned int order); /** - * @brief Get the focus order of the actor. + * @brief Gets the focus order of the actor. * * When the focus order is 0, it means the focus order of the actor * is undefined. @@ -207,24 +210,24 @@ public: unsigned int GenerateNewFocusOrder() const; /** - * @brief Get the actor that has the specified focus order. + * @brief Gets the actor that has the specified focus order. * - * It will return an empty handle if the actor is not in the stage - * or has a focus order of 0. + * It will return an empty handle if no actor in the stage + * has the specified focus order. * * @SINCE_1_0.0 * @param order The focus order of the actor * * @return The actor that has the specified focus order or an empty - * handle if no actor in the stage has the specified focus order. + * handle if no actor in the stage has the specified focus order * @pre The AccessibilityManager has been initialized. */ Actor GetActorByFocusOrder(const unsigned int order); /** - * @brief Move the focus to the specified actor. + * @brief Moves the focus to the specified actor. * - * Only one actor can be focused at the same time. The actor must + * Only one actor can be focused at the same time. The actor must * have a defined focus order and must be focusable, visible and in * the stage. * @@ -237,38 +240,38 @@ public: bool SetCurrentFocusActor(Actor actor); /** - * @brief Get the current focused actor. + * @brief Gets the current focused actor. * * @SINCE_1_0.0 - * @return A handle to the current focused actor or an empty handle if no actor is focused. + * @return A handle to the current focused actor or an empty handle if no actor is focused * @pre The AccessibilityManager has been initialized. */ Actor GetCurrentFocusActor(); /** - * @brief Get the focus group of current focused actor. + * @brief Gets the focus group of current focused actor. * * @SINCE_1_0.0 * @return A handle to the immediate parent of the current focused * actor which is also a focus group, or an empty handle if no actor - * is focused. + * is focused * @pre The AccessibilityManager has been initialized. * */ Actor GetCurrentFocusGroup(); /** - * @brief Get the focus order of currently focused actor. + * @brief Gets the focus order of currently focused actor. * @SINCE_1_0.0 * @return The focus order of the currently focused actor or 0 if no - * actor is in focus. + * actor is in focus * @pre The AccessibilityManager has been initialized. * */ unsigned int GetCurrentFocusOrder(); /** - * @brief Move the focus to the next focusable actor in the focus + * @brief Moves the focus to the next focusable actor in the focus * chain (according to the focus traversal order). * * When the focus movement is wrapped around, the focus will be moved @@ -281,7 +284,7 @@ public: bool MoveFocusForward(); /** - * @brief Move the focus to the previous focusable actor in the + * @brief Moves the focus to the previous focusable actor in the * focus chain (according to the focus traversal order). * * When the focus movement is wrapped around, the focus will be @@ -295,51 +298,51 @@ public: bool MoveFocusBackward(); /** - * @brief Clear the focus from the current focused actor if any, so + * @brief Clears the focus from the current focused actor if any, so * that no actor is focused in the focus chain. * - * It will emit focus changed signal without current focused actor + * It will emit focus changed signal without current focused actor. * @SINCE_1_0.0 * @pre The AccessibilityManager has been initialized. */ void ClearFocus(); /** - * @brief Clear the every registered focusable actor from focus-manager. + * @brief Clears every registered focusable actor from focus-manager. * @SINCE_1_0.0 * @pre The AccessibilityManager has been initialized. */ void Reset(); /** - * @brief Set whether an actor is a focus group that can limit the + * @brief Sets whether an actor is a focus group that can limit the * scope of focus movement to its child actors in the focus chain. * * @SINCE_1_0.0 - * @param actor The actor to be set as a focus group. - * @param isFocusGroup Whether to set the actor to be a focus group or not. + * @param actor The actor to be set as a focus group + * @param isFocusGroup Whether to set the actor to be a focus group or not * @pre The AccessibilityManager has been initialized. * @pre The Actor has been initialized. */ void SetFocusGroup(Actor actor, bool isFocusGroup); /** - * @brief Check whether the actor is set as a focus group or not. + * @brief Checks whether the actor is set as a focus group or not. * * @SINCE_1_0.0 - * @param actor The actor to be checked. - * @return Whether the actor is set as a focus group. + * @param actor The actor to be checked + * @return Whether the actor is set as a focus group * @pre The AccessibilityManager has been initialized. * @pre The Actor has been initialized. */ bool IsFocusGroup(Actor actor) const; /** - * @brief Set whether the group mode is enabled or not. + * @brief Sets whether the group mode is enabled or not. * * When the group mode is enabled, the focus movement will be limited to the child actors * of the current focus group including the current focus group itself. The current focus - * group is the closest ancestor of the current focused actor that set as a focus group. + * group is the closest ancestor of the current focused actor that is set as a focus group. * @SINCE_1_0.0 * @param enabled Whether the group mode is enabled or not * @pre The AccessibilityManager has been initialized. @@ -347,7 +350,7 @@ public: void SetGroupMode(bool enabled); /** - * @brief Get whether the group mode is enabled or not. + * @brief Gets whether the group mode is enabled or not. * * @SINCE_1_0.0 * @return Whether the group mode is enabled or not. @@ -356,7 +359,7 @@ public: bool GetGroupMode() const; /** - * @brief Set whether focus will be moved to the beginning of the + * @brief Sets whether focus will be moved to the beginning of the * focus chain when it reaches the end or vice versa. * * When both the wrap mode and the group mode are enabled, focus will be @@ -368,7 +371,7 @@ public: void SetWrapMode(bool wrapped); /** - * @brief Get whether the wrap mode is enabled or not. + * @brief Gets whether the wrap mode is enabled or not. * * @SINCE_1_0.0 * @return Whether the wrap mode is enabled or not. @@ -377,7 +380,7 @@ public: bool GetWrapMode() const; /** - * @brief Set the focus indicator actor. + * @brief Sets the focus indicator actor. * * This will replace the default focus indicator actor in * AccessibilityManager and will be added to the focused actor as a @@ -391,7 +394,7 @@ public: void SetFocusIndicatorActor(Actor indicator); /** - * @brief Get the focus indicator actor. + * @brief Gets the focus indicator actor. * * @SINCE_1_0.0 * @return A handle to the focus indicator actor @@ -411,7 +414,7 @@ public: /** * @brief Returns the current position of the read action. * @SINCE_1_0.0 - * @return The current event position. + * @return The current event position */ Vector2 GetReadPosition() const; @@ -425,7 +428,7 @@ public: * void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ FocusChangedSignalType& FocusChangedSignal(); @@ -438,7 +441,7 @@ public: * void YourCallbackName(Actor currentFocusedActor, FocusOvershotDirection direction); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ FocusOvershotSignalType& FocusOvershotSignal(); @@ -451,12 +454,12 @@ public: * void YourCallbackName(Actor activatedActor); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ FocusedActorActivatedSignalType& FocusedActorActivatedSignal(); - public: // Accessibility action signals. + public: // Accessibility action signals /** * @brief This is emitted when accessibility(screen-reader) feature turned on or off. @@ -466,7 +469,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& StatusChangedSignal(); @@ -479,7 +482,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionNextSignal(); @@ -492,7 +495,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionPreviousSignal(); @@ -505,7 +508,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionActivateSignal(); @@ -518,7 +521,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadSignal(); @@ -531,7 +534,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionOverSignal(); @@ -544,7 +547,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadNextSignal(); @@ -557,7 +560,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadPreviousSignal(); @@ -570,7 +573,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionUpSignal(); @@ -583,7 +586,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionDownSignal(); @@ -596,7 +599,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionClearFocusSignal(); @@ -609,7 +612,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionBackSignal(); @@ -622,7 +625,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionScrollUpSignal(); @@ -635,91 +638,91 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionScrollDownSignal(); /** * @brief This is emitted when accessibility action is received to scroll left to the - * previous page (by two finger swipe left) + * previous page (by two finger swipe left). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionPageLeftSignal(); /** * @brief This is emitted when accessibility action is received to scroll right to the - * next page (by two finger swipe right) + * next page (by two finger swipe right). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionPageRightSignal(); /** * @brief This is emitted when accessibility action is received to scroll up to the - * previous page (by one finger swipe left and right) + * previous page (by one finger swipe left and right). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionPageUpSignal(); /** * @brief This is emitted when accessibility action is received to scroll down to the - * next page (by one finger swipe right and left) + * next page (by one finger swipe right and left). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionPageDownSignal(); /** * @brief This is emitted when accessibility action is received to move the focus to - * the first item on the screen (by one finger swipe up and down) + * the first item on the screen (by one finger swipe up and down). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionMoveToFirstSignal(); /** * @brief This is emitted when accessibility action is received to move the focus to - * the last item on the screen (by one finger swipe down and up) + * the last item on the screen (by one finger swipe down and up). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionMoveToLastSignal(); /** * @brief This is emitted when accessibility action is received to focus and read from the - * first item on the top continously (by three fingers single tap) + * first item on the top continously (by three fingers single tap). * * A callback of the following type may be connected: * @code @@ -732,27 +735,27 @@ public: /** * @brief This is emitted when accessibility action is received to move the focus to and - * read from the next item continously (by three fingers double tap) + * read from the next item continously (by three fingers double tap). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadFromNextSignal(); /** * @brief This is emitted when accessibility action is received to zoom (by one finger - * triple tap) + * triple tap). * * A callback of the following type may be connected: * @code * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionZoomSignal(); @@ -765,7 +768,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadIndicatorInformationSignal(); @@ -778,7 +781,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionReadPauseResumeSignal(); @@ -791,7 +794,7 @@ public: * bool YourCallback( AccessibilityManager& manager ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionSignalType& ActionStartStopSignal(); @@ -804,7 +807,7 @@ public: * bool YourCallback( AccessibilityManager& manager, const TouchEvent& event ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ AccessibilityActionScrollSignalType& ActionScrollSignal();