public: // Creation & Destruction
/**
- * @brief Create an uninitialized GestureDetector; this can be initialized with one of the derived gestures' New() methods.
+ * @brief Create an uninitialized GestureDetector.
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * This can be initialized with one of the derived gesture detectors' New() methods. For example, PanGestureDetector::New().
+ *
+ * Calling member functions with an uninitialized Dali::GestureDetector handle is not allowed.
* @SINCE_1_0.0
*/
GestureDetector();
/**
- * @brief Downcast an Object handle to GestureDetector handle.
+ * @brief Downcast a handle to GestureDetector handle.
*
* If handle points to a GestureDetector object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a GestureDetector object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a GestureDetector object or an uninitialized handle
*/
static GestureDetector DownCast( BaseHandle handle );
protected:
/**
- * @brief This constructor is used by Dali New() methods of derived classes.
+ * @brief This constructor is used by New() methods of derived classes (For example, PanGestureDetector::New()).
*
* @SINCE_1_0.0
* @param [in] internal A pointer to a newly allocated Dali resource.
/**
* @brief Copy constructor.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
*/
Gesture( const Gesture& rhs );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
+ * @return A reference to this
*/
Gesture& operator=( const Gesture& rhs );
* pressed.
*
* Currently KeyEvent is also being used to relay messages from the
- * IMF keyboard to Core. In future IMF may communicate via its own
+ * IMF(Input Method Framework) keyboard to the internal core. In future IMF may communicate via its own
* module.
* @SINCE_1_0.0
*/
* @brief Check to see if Shift key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if shift modifier
+ * @return True if shift modifier
*/
bool IsShiftModifier() const;
* @brief Check to see if Ctrl (control) key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if ctrl modifier
+ * @return True if ctrl modifier
*/
bool IsCtrlModifier() const;
* @brief Check to see if Alt key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if alt modifier
+ * @return True if alt modifier
*/
bool IsAltModifier() const;
/**
* @brief Keycode for the key pressed.
+ *
+ * @remarks We recommend not to use this key code value
+ * directly because its meaning might be changed in the future. Currently, it means a
+ * platform-specific key code. You need to use IsKey() to know what a key event means
+ * instead of direct comparison of key code value.
*/
int keyCode;
/**
* @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized LongPressGestureDetector handle is not allowed.
* @SINCE_1_0.0
*/
LongPressGestureDetector();
static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
/**
- * @brief Downcast an Object handle to LongPressGestureDetector handle.
+ * @brief Downcast a handle to LongPressGestureDetector handle.
*
* If handle points to a LongPressGestureDetector object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a LongPressGestureDetector object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a LongPressGestureDetector object or an uninitialized handle
*/
static LongPressGestureDetector DownCast( BaseHandle handle );
public: // Not intended for Application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by LongPressGestureDetector::New() methods.
*
* @SINCE_1_0.0
* @param [in] internal A pointer to a newly allocated Dali resource.
/**
* @brief A LongPressGesture is emitted when the user touches and holds the screen with the stated number of fingers.
*
- * This gesture can be in one of two states, when the long-press gesture is first detected: "Started";
- * and when the long-press gesture ends: "Finished".
+ * This gesture can be in one of two states, when the long-press gesture is first detected: Gesture::Started
+ * and when the long-press gesture ends: Gesture::Finished.
*
* Long press gesture finishes when all touches have been released.
*
* @brief Constructor
*
* @SINCE_1_0.0
- * @param[in] state The state of the gesture
+ * @param[in] state The state of the gesture
*/
LongPressGesture(Gesture::State state);
/**
* @brief Copy constructor
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
*/
LongPressGesture( const LongPressGesture& rhs );
/**
* @brief Assignment operator
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
+ * @return A reference to this
*/
LongPressGesture& operator=( const LongPressGesture& rhs );
/**
* @brief Create an uninitialized PanGestureDetector; this can be initialized with PanGestureDetector::New().
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized PanGestureDetector handle is not allowed.
* @SINCE_1_0.0
*/
PanGestureDetector();
static PanGestureDetector New();
/**
- * @brief Downcast an Object handle to PanGestureDetector handle.
+ * @brief Downcast a handle to PanGestureDetector handle.
*
* If handle points to a PanGestureDetector object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a PanGestureDetector object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a PanGestureDetector object or an uninitialized handle
*/
static PanGestureDetector DownCast( BaseHandle handle );
* @brief Returns the angle by index that this pan gesture detector emits a signal.
*
* @SINCE_1_0.0
- * @return an angle threshold pair, or a zero valued angle pair when index is invalid.
+ * @return An angle threshold pair, or a zero valued angle pair when index is invalid.
* @pre The gesture detector has been initialized.
* @pre The index is less than GetAngleCount()
*/
public: // Not intended for Application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by PanGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param [in] internal A pointer to a newly allocated Dali resource.
*/
explicit DALI_INTERNAL PanGestureDetector(Internal::PanGestureDetector* internal);
/**
* @brief A PanGesture is emitted when the user moves one or more fingers in a particular direction.
*
- * This gesture can be in one of three states, when the pan gesture is first detected: "Started";
- * when the pan gesture is continuing: "Continuing"; and finally, when the pan gesture ends:
- * "Finished".
+ * This gesture can be in one of three states, when the pan gesture is first detected: Gesture::Started
+ * when the pan gesture is continuing: Gesture::Continuing and finally, when the pan gesture ends:
+ * Gesture::Finished.
*
* A pan gesture will end in the following ways:
* - User releases the primary finger (the first touch).
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] state The state of the gesture
+ * @param[in] state The state of the gesture
*/
PanGesture(Gesture::State state);
/**
* @brief Copy constructor.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
*/
PanGesture( const PanGesture& rhs );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
+ * @return A reference to this
*/
PanGesture& operator=( const PanGesture& rhs );
/**
* @brief Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized PinchGestureDetector handle is not allowed.
* @SINCE_1_0.0
*/
PinchGestureDetector();
static PinchGestureDetector New();
/**
- * @brief Downcast an Object handle to PinchGestureDetector handle.
+ * @brief Downcast a handle to PinchGestureDetector handle.
*
* If handle points to a PinchGestureDetector object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a PinchGestureDetector object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a PinchGestureDetector object or an uninitialized handle
*/
static PinchGestureDetector DownCast( BaseHandle handle );
public: // Not intended for Application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by PinchGestureDetector::New() methods.
*
* @SINCE_1_0.0
* @param [in] internal A pointer to a newly allocated Dali resource.
* @brief A PinchGesture is emitted when the user moves two fingers towards or away from each other.
*
* This gesture can be in one of three states; when the pinch gesture is first detected, its
- * state is set to "Started". After this, if there is change in the gesture, the state will
- * be "Continuing". Finally, when the gesture ends, the state of the gesture changes to
- * "Finished".
+ * state is set to Gesture::Started. After this, if there is change in the gesture, the state will
+ * be Gesture::Continuing. Finally, when the gesture ends, the state of the gesture changes to
+ * Gesture::Finished.
*
* A pinch gesture will continue to be sent to the actor under the center point of the pinch
* until the pinch ends.
* @brief Default Constructor.
*
* @SINCE_1_0.0
- * @param[in] state The state of the gesture
+ * @param[in] state The state of the gesture
*/
PinchGesture(Gesture::State state);
/**
* @brief Copy constructor.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
*/
PinchGesture( const PinchGesture& rhs );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
+ * @return A reference to this
*/
PinchGesture& operator=( const PinchGesture& rhs );
* @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the
* application.
*
- * See TapGestureDetector::SetTapsRequired
+ * See @ref TapGestureDetector::SetTapsRequired
*
- * A Tap Gesture is a discrete gesture, which means it does not have any state information attached
+ * A TapGesture is a discrete gesture, which means it does not have any state information attached
* to it. Please see TapGesture for more information.
*
* The application programmer can use this gesture detector as follows:
* @endcode
*
* @SINCE_1_0.0
- * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) ARE supported.
+ * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) are supported.
*
* Signals
* | %Signal Name | Method |
/**
* @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized TapGestureDetector handle is not allowed.
* @SINCE_1_0.0
*/
TapGestureDetector();
* @brief Create an initialized TapGestureDetector with the specified parameters.
*
* @SINCE_1_0.0
- * @param[in] tapsRequired The minimum & maximum number of taps required.
+ * @param[in] tapsRequired The minimum & maximum number of taps required.
* @return A handle to a newly allocated Dali resource.
*/
static TapGestureDetector New( unsigned int tapsRequired );
/**
- * @brief Downcast an Object handle to TapGestureDetector handle.
+ * @brief Downcast a handle to TapGestureDetector handle.
*
* If handle points to a TapGestureDetector object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a TapGestureDetector object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a TapGestureDetector object or an uninitialized handle
*/
static TapGestureDetector DownCast( BaseHandle handle );
public: // Not intended for Application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by TapGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param [in] internal A pointer to a newly allocated Dali resource.
*/
explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
};
/**
* @brief Copy constructor
* @SINCE_1_0.0
+ * @param rhs A reference to the copied handle
*/
TapGesture( const TapGesture& rhs );
/**
* @brief Assignment operator
* @SINCE_1_0.0
+ * @param rhs A reference to the copied handle
+ * @return A reference to this
*/
TapGesture& operator=( const TapGesture& rhs );
/**
* @brief Constructor
* @SINCE_1_0.0
- * @param[in] time The time the event occurred
+ * @param[in] time The time the event occurred
*/
TouchEvent(unsigned long time);
* @SINCE_1_0.0
* @param[in] type The type of the wheel event
* @param[in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
- * @param[in] modifiers modifier keys pressed during the event (such as shift, alt and control)
+ * @param[in] modifiers Modifier keys pressed during the event (such as shift, alt and control)
* @param[in] point The co-ordinates of the cursor relative to the top-left of the screen.
* @param[in] z The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
* @param[in] timeStamp The time the wheel is being rolled.
* @brief Check to see if Shift key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if shift modifier
+ * @return True if shift modifier
*/
bool IsShiftModifier() const;
* @brief Check to see if Ctrl (control) key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if ctrl modifier
+ * @return True if ctrl modifier
*/
bool IsCtrlModifier() const;
* @brief Check to see if Alt key modifier has been supplied.
*
* @SINCE_1_0.0
- * @return bool true if alt modifier
+ * @return True if alt modifier
*/
bool IsAltModifier() const;
projects / platform / core / uifw / dali-core.git / commitdiff