Tizen 2.4 SDK Rev6 Release

[framework/graphics/dali-toolkit.git] / dali-toolkit / public-api / controls / control-impl.h

diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h
index e63cece..1231a8d 100644 (file)
--- a/dali-toolkit/public-api/controls/control-impl.h
+++ b/dali-toolkit/public-api/controls/control-impl.h
@@ -69,12 +69,12 @@ public:
    *
    * If touch is required then the user can connect to this class' touch signal.
    * @since_tizen 2.4
-   * @return A handle to the ControlImpl instance.
+   * @return A handle to the ControlImpl instance
    */
   static Toolkit::Control New();
 
   /**
-   * @brief Virtual destructor.
+   * @brief Virtual destructor
    * @since_tizen 2.4
    */
   virtual ~Control();
@@ -108,6 +108,7 @@ public:
    */
   void SetBackgroundImage( Image image );
 
+
   /**
    * @copydoc Dali::Toolkit::Control::ClearBackground
    */
@@ -123,7 +124,7 @@ public:
    * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
    * @endcode
    * @since_tizen 2.4
-   * @param[in]  type  The gesture type(s) to enable.
+   * @param[in]  type  The gesture type(s) to enable
    */
   void EnableGestureDetection( Gesture::Type type );
 
@@ -132,7 +133,7 @@ public:
    *
    * Like EnableGestureDetection, this can also be called using bitwise or.
    * @since_tizen 2.4
-   * @param[in]  type  The gesture type(s) to disable.
+   * @param[in]  type  The gesture type(s) to disable
    * @see EnableGetureDetection
    */
   void DisableGestureDetection( Gesture::Type type );
@@ -143,7 +144,7 @@ public:
    * API and modify the detection.
    *
    * @since_tizen 2.4
-   * @return The pinch gesture detector.
+   * @return The pinch gesture detector
    * @pre Pinch detection should have been enabled via EnableGestureDetection().
    * @see EnableGestureDetection
    */
@@ -155,7 +156,7 @@ public:
    * API and modify the detection.
    *
    * @since_tizen 2.4
-   * @return The pan gesture detector.
+   * @return The pan gesture detector
    * @pre Pan detection should have been enabled via EnableGestureDetection().
    * @see EnableGestureDetection
    */
@@ -167,7 +168,7 @@ public:
    * API and modify the detection.
    *
    * @since_tizen 2.4
-   * @return The tap gesture detector.
+   * @return The tap gesture detector
    * @pre Tap detection should have been enabled via EnableGestureDetection().
    * @see EnableGestureDetection
    */
@@ -179,7 +180,7 @@ public:
    * API and modify the detection.
    *
    * @since_tizen 2.4
-   * @return The long press gesture detector.
+   * @return The long press gesture detector
    * @pre Long press detection should have been enabled via EnableGestureDetection().
    * @see EnableGestureDetection
    */
@@ -202,7 +203,7 @@ public:
    * @brief Gets whether this control supports two dimensional keyboard navigation.
    *
    * @since_tizen 2.4
-   * @return true if this control supports two dimensional keyboard navigation.
+   * @return True if this control supports two dimensional keyboard navigation.
    */
   bool IsKeyboardNavigationSupported();
 
@@ -239,7 +240,7 @@ public:
    * @brief Gets whether this control is a focus group for keyboard navigation.
    *
    * @since_tizen 2.4
-   * @return true if this control is set as a focus group for keyboard navigation.
+   * @return True if this control is set as a focus group for keyboard navigation.
    */
   bool IsKeyboardFocusGroup();
 
@@ -276,7 +277,7 @@ public:
    * @brief Called by the KeyInputFocusManager to emit key event signals.
    *
    * @since_tizen 2.4
-   * @param[in] event The key event.
+   * @param[in] event The key event
    * @return True if the event was consumed.
    */
   DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
@@ -437,7 +438,7 @@ public: // API for derived classes to override
    * Could be overridden by derived classes.
    *
    * @since_tizen 2.4
-   * @param[in] child The added actor.
+   * @param[in] child The added actor
    */
   virtual void OnControlChildAdd( Actor& child );
 
@@ -447,7 +448,7 @@ public: // API for derived classes to override
    * Could be overridden by derived classes.
    *
    * @since_tizen 2.4
-   * @param[in] child The removed actor.
+   * @param[in] child The removed actor
    */
   virtual void OnControlChildRemove( Actor& child );
 
@@ -457,7 +458,7 @@ public: // API for derived classes to override
    * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
    *
    * @since_tizen 2.4
-   * @param[in] styleManager  The StyleManager object.
+   * @param[in] styleManager  The StyleManager object
    * @param[in] change  Information denoting what has changed.
    */
   virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
@@ -469,7 +470,7 @@ public: // API for derived classes to override
    *
    * Derived classes should override this to perform custom accessibility activation.
    * @since_tizen 2.4
-   * @return true if this control can perform accessibility activation.
+   * @return True if this control can perform accessibility activation.
    */
   virtual bool OnAccessibilityActivated();
 
@@ -478,8 +479,8 @@ public: // API for derived classes to override
    * pan gesture.
    *
    * @since_tizen 2.4
-   * @param[in] gesture The pan gesture.
-   * @return true if the pan gesture has been consumed by this control
+   * @param[in] gesture The pan gesture
+   * @return True if the pan gesture has been consumed by this control.
    */
   virtual bool OnAccessibilityPan( PanGesture gesture );
 
@@ -488,8 +489,8 @@ public: // API for derived classes to override
    * touch event.
    *
    * @since_tizen 2.4
-   * @param[in] touchEvent The touch event.
-   * @return true if the touch event has been consumed by this control
+   * @param[in] touchEvent The touch event
+   * @return True if the touch event has been consumed by this control.
    */
   virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
 
@@ -499,16 +500,16 @@ public: // API for derived classes to override
    *
    * @since_tizen 2.4
    * @param[in] isIncrease Whether the value should be increased or decreased
-   * @return true if the value changed action has been consumed by this control
+   * @return True if the value changed action has been consumed by this control.
    */
   virtual bool OnAccessibilityValueChange( bool isIncrease );
 
   /**
    * @brief This method should be overridden by deriving classes when they wish to respond
-   * the accessibility zoom action
+   * the accessibility zoom action.
    *
    * @since_tizen 2.4
-   * @return true if the zoom action has been consumed by this control
+   * @return True if the zoom action has been consumed by this control.
    */
   virtual bool OnAccessibilityZoom();
 
@@ -535,10 +536,10 @@ public: // API for derived classes to override
    *
    * A control needs to override this function in order to support two dimensional keyboard navigation.
    * @since_tizen 2.4
-   * @param[in] currentFocusedActor The current focused actor.
-   * @param[in] direction The direction to move the focus towards.
+   * @param[in] currentFocusedActor The current focused actor
+   * @param[in] direction The direction to move the focus towards
    * @param[in] loopEnabled Whether the focus movement should be looped within the control.
-   * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
+   * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused.
    */
   virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
 
@@ -549,7 +550,7 @@ public: // API for derived classes to override
    * before the focus is actually moved to the chosen actor.
    *
    * @since_tizen 2.4
-   * @param[in] commitedFocusableActor The commited focusable actor.
+   * @param[in] commitedFocusableActor The commited focusable actor
    */
   virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
 
@@ -558,7 +559,7 @@ public: // API for derived classes to override
    *
    * Derived classes should override this to perform custom actions.
    * @since_tizen 2.4
-   * @return true if this control supported this action.
+   * @return True if this control supported this action.
    */
   virtual bool OnKeyboardEnter();
 
@@ -572,7 +573,7 @@ public: // API for derived classes to override
    * pinch scale.
    *
    * @since_tizen 2.4
-   * @param[in]  pinch  The pinch gesture.
+   * @param[in]  pinch  The pinch gesture
    * @note If overridden, then the default behaviour will not occur.
    * @note Pinch detection should be enabled via EnableGestureDetection().
    * @see EnableGestureDetection
@@ -586,7 +587,7 @@ public: // API for derived classes to override
    * is enabled.
    *
    * @since_tizen 2.4
-   * @param[in]  pan  The pan gesture.
+   * @param[in]  pan  The pan gesture
    * @note There is no default behaviour with panning.
    * @note Pan detection should be enabled via EnableGestureDetection().
    * @see EnableGestureDetection
@@ -600,7 +601,7 @@ public: // API for derived classes to override
    * is enabled.
    *
    * @since_tizen 2.4
-   * @param[in]  tap  The tap gesture.
+   * @param[in]  tap  The tap gesture
    * @note There is no default behaviour with a tap.
    * @note Tap detection should be enabled via EnableGestureDetection().
    * @see EnableGestureDetection
@@ -614,7 +615,7 @@ public: // API for derived classes to override
    * detection is enabled.
    *
    * @since_tizen 2.4
-   * @param[in]  longPress  The long press gesture.
+   * @param[in]  longPress  The long press gesture
    * @note There is no default behaviour associated with a long press.
    * @note Long press detection should be enabled via EnableGestureDetection().
    * @see EnableGestureDetection
@@ -656,22 +657,22 @@ private:
 };
 
 /**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
  *
  * @since_tizen 2.4
  * @param handle
  * @return implementation
- * @pre handle is initialized and points to a control
+ * @pre handle is initialized and points to a control.
  */
 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
 
 /**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
  *
  * @since_tizen 2.4
  * @param handle
  * @return implementation
- * @pre handle is initialized and points to a control
+ * @pre handle is initialized and points to a control.
  */
 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );