if (pHeader != null)
{
pHeader->SetStyle(HEADER_STYLE_TITLE);
- pHeader->SetTitleText(L"Acessibility Sample");
+ pHeader->SetTitleText(L"Accessibility Sample");
}
//Draw Image
*/
enum AccessibilityScreenReaderStatus
{
- ACCESSIBILITY_SCREEN_READER_STATUS__NONE, /**< initial value.*/
- ACCESSIBILITY_SCREEN_READER_STATUS_ERROR, /**<screen reader has been occurred error.*/
- ACCESSIBILITY_SCREEN_READER_STATUS_READY, /**< screen reader is idle*/
- ACCESSIBILITY_SCREEN_READER_STATUS_PLAYING, /**< screen reader is playing*/
- ACCESSIBILITY_SCREEN_READER_STATUS_PAUSE, /**< screen reader is paused*/
+ ACCESSIBILITY_SCREEN_READER_STATUS__NONE, /**< Initial value to which the screen reader is set */
+ ACCESSIBILITY_SCREEN_READER_STATUS_ERROR, /**< An error has occurred */
+ ACCESSIBILITY_SCREEN_READER_STATUS_READY, /**< Screen reader is idle */
+ ACCESSIBILITY_SCREEN_READER_STATUS_PLAYING, /**< Screen reader is in use */
+ ACCESSIBILITY_SCREEN_READER_STATUS_PAUSE, /**< Screen reader has been paused */
};
}} //Tizen::Ui
*
* @return An error code
* @param[in] dataType The data type
- * @param[in] data The data to be copied
+ * @param[in] data The data to copy
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
/**
* @file FUiClipboardTypes.h
- * @brief This is the header file for the Clipboard enumeration.
+ * @brief This is the header file for the enumerations of the Clipboard class.
*
- * The Clipboard enumeration defines the data types for the system clipboard.
+ * The %ClipboardDataType enumeration defines the data types for the system clipboard.
*/
#ifndef _FUI_CLIPBOARD_ENUM_H_
/**
* @file FUiCompositeMode.h
- * @brief This is the header file for the %Container class.
+ * @brief This is the header file for the Container class.
*
- * This header file contains the declarations of the %Container class.
+ * This header file contains the declarations of the enumerations of the Container class.
*/
#ifndef _FUI_COMPOSITE_MODE_H_
/** Composites two UI controls using alpha-blending */
COMPOSITE_MODE_ALPHA_BLENDING,
- /** Composites two UI controls in the way that the given chroma key color from one control is made transparent */
+ /** Composites two UI controls in a way that the given chroma key color from one control is made transparent */
COMPOSITE_MODE_CHROMA_KEY,
- /** Composites two UI controls in the way that one control overwrites another control */
+ /** Composites two UI controls in a way that one control overwrites another control */
COMPOSITE_MODE_OVERWRITE,
/** Does not composite the given control */
* @since 2.0
*
* @return An error code
- * @param[in] control The control to be added to the container
+ * @param[in] control The control to add to the container
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c control is an instance of Window, or this control's parent container.
* @since 2.1
*
* @return An error code
- * @param[in] control The control to be added to the container
+ * @param[in] control The control to add to the container
* @param[in] pControl Pointer of the control to be added to the container
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pControl is null.
*
* @since 2.0
*
- * @param[in, out] evaluatedSize The width and the height that need to be evaluated.
+ * @param[in, out] evaluatedSize The width and the height to evaluate
*/
virtual void OnEvaluateSize(Tizen::Graphics::Dimension& evaluatedSize);
* @since 2.0
*
* @return An error code
- * @param[in] control The child control to be removed
+ * @param[in] control The child control to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified instance is not found within the indicated range (that is, the @c control is not found).
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the control to be removed
+ * @param[in] index The index of the control to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is out of range.
* @exception E_SYSTEM A system error has occurred.
*
* @return A Boolean flag that indicates whether the specified @c evaluatedSize
* is modified.
- * @param[in, out] evaluatedSize The width and the height that need to be evaluated.
+ * @param[in, out] evaluatedSize The width and the height to evaluate
*/
virtual bool OnEvaluateSize(Tizen::Graphics::FloatDimension& evaluatedSize);
result SetPosition(float x, float y);\r
\r
/**\r
- * Sets the size of the control.\r
+ * Sets the size of the control. @n
* The @c width and @c height parameters contain the width and height values of the object, respectively.\r
*\r
* @since 2.0\r
result SetSize(const Tizen::Graphics::FloatDimension& size);\r
\r
/**\r
- * Sets the size of the control.\r
+ * Sets the size of the control. @n
* The @c width and @c height parameters contain the width and height values of the object, respectively.\r
*\r
* @since 2.0\r
* @exception E_SYSTEM A system error has occurred.\r
* @remarks Do not override this method.\r
* @remarks Even if this method is invoked, the control is not drawn or shown. @n\r
- * To display the control, use Invalidate() methods. @n\r
+ * To display the control, use the Invalidate() methods. @n
* Once the control's show state is set to @c false,\r
* the show state needs to be set to @c true again before you invalidate the control.\r
* @see GetShowState()\r
* Stops the current UI event dispatch sequence by indicating the current input event is consumed.\r
*\r
* @brief <i> [Deprecated] </i>\r
- * @deprecated This method is deprecated. Instead of using this method, return true inside Propagated Event Listeners which derived from IPropagatedKeyEventListener/IPropagatedTouchEventListener to consume event.\r
+ * @deprecated This method is deprecated. Instead of using this method, use IPropagatedKeyEventListener or IPropagatedTouchEventListener to consume event. @n To propagate the event, return @c true inside the implementation of IPropagatedKeyEventListener or IPropagatedTouchEventListener.
* @since 2.0\r
*\r
* @return An error code\r
* @since 2.1\r
*\r
* @return The bounds of the content area\r
- * @see SetContentAreaBounds()\r
+ * @see SetContentAreaBoundsF()
*/\r
Tizen::Graphics::FloatRectangle GetContentAreaBoundsF(void) const;\r
\r
*\r
* @since 2.0\r
*\r
- * @return The accessibilit container of the control, if the control supports accessibility feature. @n\r
- * Else @c null.\r
+ * @return The accessibility container of the control, if the control supports accessibility feature, @n
+ * else @c null
* @see AccessibilityContainer::GetOwner()\r
*/\r
const AccessibilityContainer* GetAccessibilityContainer(void) const;\r
*\r
* @since 2.0\r
*\r
- * @return The accessibilit container of the control, if the control supports accessibility feature. @n\r
- * Else @c null.\r
+ * @return The accessibility container of the control, if the control supports accessibility feature, @n
+ * else @c null
* @see AccessibilityContainer::GetOwner()\r
*/\r
AccessibilityContainer* GetAccessibilityContainer(void);\r
\r
/**\r
- * Sets a propagated touch event listener to the Control.\r
- * The registered listener will be notified when a touch event occurs in the control. Using the propagated touch event listener, an application can control the touch event routing path.\r
+ * Sets a propagated touch event listener to the %Control instance. @n
+ * The registered listener is notified when a touch event occurs in the control. Using the propagated touch event listener, an application can control the touch event routing path.
*\r
* @since 2.1\r
*\r
- * @param[in] pListener The event listener to which propagated touch events are dispatched.\r
+ * @param[in] pListener The event listener to which the propagated touch events are dispatched
* @remarks The specified event listener should be allocated in heap memory.\r
* To unregister the event listener, pass @c null to @c pListener.\r
\r
void SetPropagatedTouchEventListener(IPropagatedTouchEventListener* pListener);\r
\r
/**\r
- * Sets a propagated key event listener to the Control.\r
- * The registered listener will be notified when a key event occurs in the control. Using the propagated key event listener, an application can control the key event routing path.\r
+ * Sets a propagated key event listener to the %Control instance.
+ * The registered listener is notified when a key event occurs in the control. Using the propagated key event listener, an application can control the key event routing path.
*\r
* @since 2.1\r
*\r
- * @param[in] pListener The event listener to which propagated touch events are dispatched.\r
+ * @param[in] pListener The event listener to which the propagated touch events are dispatched
* @remarks The specified event listener should be allocated in heap memory.\r
* To unregister the event listener, pass @c null to @c pListener.\r
\r
*\r
* @since 2.1\r
*\r
- * @param[in] The pointer to the previous focus of the control\r
+ * @param[in] pPreviousFocus The pointer to the previous focus of the control
* @remarks Focus UI supports linear navigation of controls from top-left to bottom-right direction. This method allows for customizing the default navigation behavior.\r
- * @remarks The platform will not take the ownership of pPreviousFocus after this call.\r
+ * @remarks The platform will not take the ownership of @c pPreviousFocus after this call.
* @see SetNextFocus()\r
* @see GetPreviousFocus()\r
*/\r
*\r
* @since 2.1\r
*\r
- * @param[in] The pointer to the next focus of the control\r
+ * @param[in] pNextFocus The pointer to the next focus of the control
* @remarks Focus UI supports linear navigation of controls from top-left to bottom-right direction. This method allows for customizing the default navigation behavior.\r
- * @remarks The platform will not take the ownership of pNextFocus after this call.\r
+ * @remarks The platform will not take the ownership of @c pNextFocus after this call.
* @see SetPreviousFocus()\r
* @see GetNextFocus()\r
*/\r
void SetNextFocus(Control* pNextFocus);\r
\r
/**\r
- * Gets the previous focus of the control\r
+ * Gets the previous focus of the control.
*\r
* @since 2.1\r
*\r
- * @return The pointer to the previous focus of the control,\r
+ * @return The pointer to the previous focus of the control, @n
* else @c null if the previous focus of the control is not set\r
* @see GetNextFocus()\r
* @see SetNextFocus ()\r
\r
\r
/**\r
- * Gets the next focus of the control\r
+ * Gets the next focus of the control.
*\r
* @since 2.1\r
*\r
- * @return The pointer to the next focus of the control\r
+ * @return The pointer to the next focus of the control, @n
* else @c null if the next focus of the control is not set\r
* @see GetPreviousFocus()\r
* @see SetPreviousFocus ()\r
/**
* Sets the touch press threshold of the Control in inch.
*
- * @since 2.1
+ * @since 2.1
*
- * @param[in] distance The threshold to fire touch move event in inch
- * @remark A touch move event will start to be fired if the move distance from the press point exceeds the touch press threshold value.
- * For example, when the value is 0.5, a touch move event will be fired if the move distance exceeds 0.5 inch.
- * This method is offered to control sensitivity of touch move event.
+ * @param[in] distance The logical threshold to fire touch move event
+ * @remark A touch move events will start to fire if the move distance exceeds the set allowance value.
+ * For example, Set 0.5 if the distance is 0.5 inch.
+ * This method is offered to control sensitivity of move events.
*/
void SetTouchPressThreshold(float distance);
* @since 2.1\r
*\r
* @return An error code\r
- * @param[in] file name The file name of a font-resource which are located in ‘/res/font’\r
- * Sets an empty string to reset.\r
+ * @param[in] fileName The file name of a font-resource located in @b ‘/res/font’, @n
+ * else an empty string to reset
* @exception E_SUCCESS The method is successful.\r
* @exception E_FILE_NOT_FOUND The specified font cannot be found or accessed.\r
* @exception E_UNSUPPORTED_FORMAT The specified font format is not supported.\r
*\r
* @since 2.1\r
*\r
- * @return The font name set in the control @n\r
+ * @return The font name set in the control, @n
* else an empty string if the font is not set\r
* @see SetFontFromFile()\r
*/\r
* Gets the default key event listener.\r
*\r
* @brief <i> [Deprecated] </i>\r
- * @deprecated This method is deprecated.\r
- * @since 2.0 \r
+ * @deprecated This method is deprecated.\r
+ * @since 2.0\r
*\r
- * @return The default key event listener. @n\r
- * If no listener has been set or a system error has occurred, @c null is returned.\r
- * @see SetDefaultKeyEventListener()\r
+ * @return The default key event listener @n
+ * If no listener has been set or a system error has occurred @c null is returned.
+ * @see SetDefaultKeyEventListener()\r
*/\r
IKeyEventListener* GetDefaultkeyEventListener(void) const;\r
\r
* @deprecated This method is deprecated.\r
* @since 2.0\r
*\r
- * @return The default touch event listener.\r
+ * @return The default touch event listener @n
* If no listener has been set or a system error has occurred @c null is returned.\r
* @see SetDefaultTouchEventListener()\r
*/\r
/**
* @class OverlayPanel
- * @brief This class is an implementation of an %OverlayPanel.
+ * @brief This class is an implementation of %OverlayPanel.
*
* @since 2.1
*
* @param[out] info The information of the background buffer
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The operation has failed.
- * @remarks Currently, this function provides buffer information except the pointer of the RGB color buffer. @n
+ * @remarks Currently, this method provides buffer information except the pointer of the RGB color buffer. @n
* Therefore, info.pPixels is always assigned @c null.
*/
result GetBackgroundBufferInfo(Tizen::Graphics::BufferInfo& info) const;
* @exception E_SYSTEM A system error has occurred.
* @exception E_INVALID_ARG The specified @c destType is not of a supported type.
* @remarks If you have set a data binding listener, @n
- this function is returned after that listener is called.
+ this method is returned after that listener is called.
* @see IDataBindingListener
*/
result UpdateAllBindings(DataBindingDestinationType destType);
* @exception E_INVALID_OPERATION The given binding's trigger is not 'explicit' type.
* @exception E_INVALID_ARG The specified @c destType is not supported in binding ID.
* @remarks If you have set a data binding listener, @n
- this function is returned after that listener is called.
+ this method is returned after that listener is called.
* @see IDataBindingListener
*/
result UpdateBinding(const Tizen::Base::String& bindingId, DataBindingDestinationType destType);
* @since 2.0
*
* @return The current focused Window
- * @remarks The method returns the application's current focus owner's ancestor Window or the %Window that is currently focused.
+ * @remarks This method returns the application's current focus owner's ancestor Window or the %Window that is currently focused.
*/
Window* GetCurrentFocusedWindow(void) const;
/**
* @file FUiIAccessibilityListener.h
- * @brief This is the header file for the IAccessibilityListener interface.
+ * @brief This is the header file for the %IAccessibilityListener interface.
*
- * This header file contains the declarations of the IAccessibilityListener interface..
+ * This header file contains the declarations of the %IAccessibilityListener interface.
*/
#ifndef _FUI_IACCESSIBILITY_LISTENER_H_
/**
* @interface IAccessibilityListener
-* @brief This interface is the listener interface for accessibility screen reader
+* @brief This interface is the listener interface for accessibility screen reader.
*
* @since 2.0
*
-* This %IAccessibilityListener defines methods for accessibility screen reader
+* This %IAccessibilityListener interface defines methods for accessibility screen reader.
*
*/
class _OSP_EXPORT_ IAccessibilityListener
* Notifies when the accessibility element gets a focus.
*
* @since 2.0
- * @param[in] control The control that has a accessibility element.
- * @param[in] element The element.
+ * @param[in] control The control that has a accessibility element
+ * @param[in] element The element
*/
virtual void OnAccessibilityFocusIn(const Control& control, const AccessibilityElement& element) = 0;
* Notifies when the accessibility element losts a focus.
*
* @since 2.0
- * @param[in] control The control that has a accessibility element.
- * @param[in] element The element.
+ * @param[in] control The control that has a accessibility element
+ * @param[in] element The element
*/
virtual void OnAccessibilityFocusOut(const Control& control, const AccessibilityElement& element) = 0;
/**
* Notifies when the accessibility element is operated.
*
* @since 2.0
- * @param[in] control The control that has a accessibility element.
- * @param[in] element The element.
+ * @param[in] control The control that has a accessibility element
+ * @param[in] element The element
*/
virtual void OnAccessibilityActionPerformed(const Control& control, const AccessibilityElement& element) = 0;
* Notifies when the accessibility screen status is changed.
*
* @since 2.0
- * @param[in] control The control that has a accessibility element.
- * @param[in] element The focused element.
- * @param[in] status The changed status.
+ * @param[in] control The control that has a accessibility element
+ * @param[in] element The focused element
+ * @param[in] status The changed status
*/
virtual void OnAccessibilityScreenReaderStatusChanged(const Control& control, const AccessibilityElement& element, AccessibilityScreenReaderStatus status) = 0;
* @interface ICustomItemEventListener
* @brief <i> [Deprecated] </i> This interface implements the listener for the item event.
*
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* The %ICustomItemEventListener interface is the listener interface for receiving item events. The class that processes an item event
- * implements this interface, and the instance created with that class is registered with a UI control, using the control's
- * AddCustomItemEventListener() method. When the item event occurs, the OnItemStateChanged() method of that object is invoked.
+ * implements this interface, and the instance created with that class is registered with a UI control, using the CustomList::AddCustomItemEventListener()
+ * method. When the item event occurs, the OnItemStateChanged() method of that object is invoked.
* @endif
*/
class _OSP_EXPORT_ ICustomItemEventListener
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
* @endif
*/
* Called when the state of CustomListItem is changed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source control from which the event is fired
* Called when the state of an element in the CustomListItem is changed.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source control from which the event is fired
* @since 2.0
* @return @c true if it is successful to convert source to target @n
* else @c false
- * @param[in] bindingId the specified binding id
+ * @param[in] bindingId The specified binding ID
* @param[in] sourceType The source data type
* @param[in] sourceData The data source
* @param[in] targetType The target data type
* @since 2.0
* @return @c true if it is successful to convert target to source @n
* else @c false
- * @param[in] bindingId the specified binding id
+ * @param[in] bindingId The specified binding ID
* @param[in] targetType The target data type
* @param[in] targetData The data target
* @param[in] sourceType The source data type
virtual bool TransformTargetToSource(const Tizen::Base::String& bindingId, DataBindingDataType targetType, const Tizen::Base::Object& targetData, DataBindingDataType sourceType, Tizen::Base::Object& sourceData) = 0;
/**
- * Checks whether the this transformer can convert the source type to target type
+ * Checks whether the this transformer can convert the source type to target type.
*
* @since 2.0
- * @return @c true It is possible to transform source type to target type, @n
- * else @c It's not possible
- * @param[in] bindingId the specified binding id
+ * @return @c true if it is possible to transform source type to target type, @n
+ * else @c false
+ * @param[in] bindingId The specified binding ID
* @param[in] sourceType The source data type
- * @param[in] targetType The taret data type
+ * @param[in] targetType The target data type
*/
virtual bool IsSourceToTargetTransformable(const Tizen::Base::String& bindingId, DataBindingDataType sourceType, DataBindingDataType targetType) = 0;
/**
- * Checks whether the this transformer can convert the target type to source type
+ * Checks whether the this transformer can convert the target type to source type.
*
* @since 2.0
- * @return @c true It is possible to transform target type to source type, @n
- * else @c It's not possible
- * @param[in] bindingId the specified binding id
- * @param[in] targetType The taret data type
+ * @return @c true if it is possible to transform target type to source type, @n
+ * else @c false
+ * @param[in] bindingId The specified binding ID
+ * @param[in] targetType The target data type
* @param[in] sourceType The source data type
*/
virtual bool IsTargetToSourceTransformable(const Tizen::Base::String& bindingId, DataBindingDataType targetType, DataBindingDataType sourceType) = 0;
* @since 2.0
* @return @c true if the specified value is valid, @n
* else @c false
- * @param[in] bindingId The binding Id to validate
+ * @param[in] bindingId The binding ID to validate
* @param[in] data The data to validate
*/
virtual bool ValidateDataToTarget(const Tizen::Base::String& bindingId, const Tizen::Base::Object& data) = 0;
* @since 2.0
* @return @c true if the specified value is valid, @n
* else @c false
- * @param[in] bindingId The binding Id to validate
+ * @param[in] bindingId The binding ID to validate
* @param[in] data The data to validate
*/
virtual bool ValidateDataToSource( const Tizen::Base::String& bindingId, const Tizen::Base::Object& data) = 0;
* @brief This is the header file for the %IDateTimeChangeEventListener interface.
*
* This header file contains the declarations of the %IDateTimeChangeEventListener interface. @n
- * If a change event is generated, a method of this class is called. @n
- * So, if applications perform jobs related to change events, they use the methods of this class.
+ * If a change event is generated, a method of this class is interface. @n
+ * So, if applications perform jobs related to change events, they use the methods of this interface.
*
*/
#ifndef _FUI_IDATETIME_CHANGE_EVENT_LISTENER_H_
*
* The %IDateTimeChangeEventListener interface is the listener interface for receiving date and time change events.
* The class that processes a date and time change event implements this interface, and the instance created with that class is
- * registered with a UI control, using the control's AddDateTimeChangeEventListener() method. When the date and time change event
+ * registered with a UI control, using the DateTimePicker::AddDateTimeChangeEventListener() method. When the date and time change event
* occurs, the OnDateTimeChanged() method of that instance is invoked.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_datepicker.htm">DatePicker, TimePicker, and DateTimePicker</a>.
*
* The %IDragDropEventListener interface is the listener interface for receiving drag and drop events.
* The class that processes a drag and drop event implements this interface, and the instance created with that class is
- * registered with a UI control, using the control's AddDragDropEventListener() method. When the drag and drop event occurs, a
+ * registered with a UI control, using the Control::AddDragDropEventListener() method. When the drag and drop event occurs, a
* method of that instance is invoked.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
* @interface IExpandableItemEventListener
* @brief <i> [Deprecated] </i> This interface implements a listener for the item events.
*
- * @deprecated This listener is deprecated. Instead of using this class, use IGroupedTableViewItemEventListener.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedTableViewItemEventListener interface.
* @since 2.0
*
* The %IExpandableItemEventListener interface implements a listener for the item events.
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This listener is deprecated. This listener is deprecated. Instead of using this class, use
- * IGroupedTableViewEventListener.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedTableViewEventListener interface.
* @since 2.0
- * @endif
+ * @endif
*/
virtual ~IExpandableItemEventListener(void) {}
* If a main item is selected, the index of the sub-item is @c -1.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This listener is deprecated. Instead of using this class, use IGroupedTableViewEventListener.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedTableViewEventListener interface.
* @since 2.0
*
* @param[in] source The source control from which the event is fired
* Called when the state of an element in CustomListItem in ExpandableList is changed. @n
* If a main item is selected, the index of the sub-item is @c -1.
* @brief <i> [Deprecated] </i>
- * @deprecated This listener is deprecated. Instead of using this class, use IGroupedTableViewEventListener.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedTableViewEventListener interface.
* @since 2.0
*
* @param[in] source The source control from which the event is fired
* @interface IFastScrollEventListener
* @brief <i> [Deprecated] </i> This interface implements the listener for fast scroll event.
*
- * @deprecated This class is deprecated. Instead of using this class, use the IFastScrollListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IFastScrollListener interface.
* @since 2.0
*
*
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use the IFastScrollListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IFastScrollListener interface.
* @since 2.0
* @endif
*/
* Called when a main index is selected.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use the IFastScrollListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IFastScrollListener interface.
* @since 2.0
*
* @param[in] source The source of the event
* Called when a main index is expanded.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use the IFastScrollListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IFastScrollListener interface.
* @since 2.0
*
* @param[in] source The source of the event
*
* The %IFocusEventListener interface is the listener interface for receiving focus events.
* The class that processes a focus event implements this interface, and the instance created with that class is registered with a
- * UI control, using the control's AddFocusEventListener() method. When the focus event occurs, a method of that instance is
+ * UI control, using the Control::AddFocusEventListener() method. When the focus event occurs, a method of that instance is
* invoked.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
* @interface IGroupedItemEventListener
* @brief <i> [Deprecated] </i> This interface implements the listener for the events on the items of GroupedList.
*
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
*
*
* This is the default constructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @endif
*/
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @endif
*/
/**
* @if OSPDEPREC
* Called when the state of an element in the CustomListItem instance in the GroupedList instance is changed. @n
- * For example, this method is called when an element of %CustomListItem in %GroupedList is checked, unchecked, or selected.
+ * For example, the %OnItemStateChanged() method is called when an element of %CustomListItem in %GroupedList is checked, unchecked, or selected.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
/**
* @if OSPDEPREC
* Called when the state of an item in the grouped list is changed. @n
- * For example, this method is called when an item of the GroupedList control is checked, unchecked, or selected.
+ * For example, the %OnItemStateChanged() method is called when an item of the GroupedList control is checked, unchecked, or selected.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
*
* @since 2.0
* @param[in] source The source of the event
- * @param[in] offset The position to be deleted before the current cursor position.
- * @param[in] charCount The number of characters to be deleted.
+ * @param[in] offset The position to delete before the current cursor position.
+ * @param[in] charCount The number of characters to delete
*/
virtual void DeleteSurroundingText(Tizen::Ui::InputConnection& source, int offset, int charCount) = 0;
*
* @since 2.0
* @param[in] source The source of the event
- * @param[out] text The text to be sent to the Input Method.
- * @param[out] cursorPosition The current cursor position to be sent to the Input Method.
+ * @param[out] text The text to send to the Input Method
+ * @param[out] cursorPosition The current cursor position to send to the Input Method
* @remarks The text will be used for processing the auto-capitalization/auto-period. At least three letters in front of the cursor are required.
*/
virtual void GetPreviousText(Tizen::Ui::InputConnection& source, Tizen::Base::String& text, int& cursorPosition) = 0;
* @brief This is the header file for the %IItemEventListener interface.
*
* This header file contains the declarations of the %IItemEventListener interface. @n
- * If an item event is generated, a method of this class is called. @n
- * So, if an application performs tasks related to the item event, use the methods of this class.
+ * If an item event is generated, a method of this interface is called. @n
+ * So, if an application performs tasks related to the item event, use the methods of this interface.
*
*/
#ifndef _FUI_IITEM_EVENT_LISTENER_H_
* Defines the constants used to identify the item state.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. Instead of using this enumeration, use the ListItemStatus enumeration.
+ * @deprecated This enum is deprecated. Instead of using this enum, use the ListItemStatus enumeration.
* @since 2.0
* @endif
*/
* @if OSPDEPREC
* @interface IItemEventListener
* @brief <i> [Deprecated] </i> This interface implements the listener for the item event.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use tthe IListViewItemEventListener interface.
* @since 2.0
*
* The %IItemEventListener interface is the listener interface for receiving item events. The class that processes an item event
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
* @endif
*/
* Called when an item event occurs.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
*
* The %IKeyEventListener interface is the listener interface for receiving key events, which are fired when hardware keyboard keys are pressed or
* released. The class that processes a key event implements this interface, and the instance created with that class is
- * registered with a UI control, using the control's AddKeyEventListener() method. When the key event occurs, a method of that
+ * registered with a UI control, using the Control::AddKeyEventListener() method. When the key event occurs, a method of that
* instance is invoked.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
//
/**
* @file FUiILanguageEventListener.h
- * @brief This is the header file for the %ILanguageEventListener class.
+ * @brief This is the header file for the %ILanguageEventListener interface.
*
- * This header file contains the declarations of the %ILanguageEventListener class.
+ * This header file contains the declarations of the %ILanguageEventListener interface.
*/
#ifndef _FUI_ILANGUAGE_EVENT_LISTENER_H_
* AddLanguageEventListener() method.
*
* When the current input language is changed (for example, when the user toggles the input language from the virtual
- * keypad, the listener's OnLanguageChanged() method is invoked.
+ * keypad), the listener's OnLanguageChanged() method is invoked.
*/
class _OSP_EXPORT_ ILanguageEventListener
* @brief This is the header file for the %IOrientationEventListener interface.
*
* This header file contains the declarations of the %IOrientationEventListener interface. @n
- * If an orientation event is generated, a method of this class is called. @n
- * So, if an application performs tasks related to the orientation event, use the methods of this class.
+ * If an orientation event is generated, a method of this interface is called. @n
+ * So, if an application performs tasks related to the orientation event, use the methods of this interface.
*
*/
*
* @param[in] source The source of the event
* @param[in] orientationStatus The information about the orientation event
- * @remarks The orientation changed event is fired on %Control for which orientation mode change has been enabled by calling SetOrientation().
+ * @remarks The orientation changed event is fired on Control for which orientation mode change has been enabled by calling SetOrientation().
* @see Tizen::Ui::Controls::Frame
* @see Tizen::Ui::Controls::Form
*/
class KeyEventInfo;
/**
- * @interface IPropagatedKeyEventListener
- * @brief This interface is used as the argument to the propagated key event listener.
+ * @interface IPropagatedKeyEventListener
+ * @brief This interface is used as an argument for the propagated key event listener.
*
- * @since 2.1
+ * @since 2.1
*
* The %IPropagatedKeyEventListener interface is the listener interface for receiving propagated key events.
* The class that processes a propagated key event implements this interface, and the instance created with that class is registered with a
- * UI control, using the control's SetPropagatedKeyEventListener() method. When the key event occurs, a method of that instance which is derived from %IPropagatedKeyEventListener is
+ * UI control, using the Control::SetPropagatedKeyEventListener() method. When the key event occurs, a method of that instance that is derived from %IPropagatedKeyEventListener is
* invoked.
- * Propagated key event listeners work according to the event previewing and bubbling concept. @n
+ * The propagated key event listeners work according to the event previewing and bubbling concept. @n
* When a key event occurs, as a previewing notification it is routed from the top-most Window, which is usually a Frame,
* to a control which is the parent of the control where the event occurs. Then, as a bubbling notification it is routed from
* the control to the top-most Window.
* In both previewing and bubbling paths, event routing can be controlled by the value returned by the listener. Returning @c true, which means
- * the event is processed in the listener of the notified control, stops further routing. Returning @c false allows the next event receiver
- * to listen the event.
+ * the event is processed in the listener of the notified control, stops further routing. Returning @c false allows the next event listener
+ * to listen to the event.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
*/
*
* @since 2.1
*
- * @return Whether the key event is processed by the listener or not.
+ * @return Whether the key event is processed by the listener or not
* @param[in] source The source of the event
* @param[in] keyEventInfo The key event information
*/
*
* @since 2.1
*
- * @return Whether the key event is processed by the listener or not.
+ * @return Whether the key event is processed by the listener or not
* @param[in] source The source of the event
* @param[in] keyEventInfo The key event information
*/
* Called during the previewing step when a key is pressed.
*
* @since 2.1
+ *
* @return Whether the key event is processed by the listener or not
-
* @param[in] source The source of the event
* @param[in] keyEventInfo The key event information
*/
* Called during the previewing step when a key is released.
*
* @since 2.1
+ *
* @return Whether the key event is processed by the listener or not
-
* @param[in] source The source of the event
* @param[in] keyEventInfo The key event information
*/
virtual bool OnPreviewKeyReleased(Control& source, const KeyEventInfo& keyEventInfo) = 0;
/**
- * Called before OnPreviewKeyPressed() or OnPreviewKeyReleased() listener is called, allowing the application to modify the keyEventInfo instance.
- * Before previewing and bubbling paths, this method is called once.
+ * Called before the OnPreviewKeyPressed() or OnPreviewKeyReleased() method is called, allowing the application to modify the KeyEventInfo instance. @n
+ * Before previewing and bubbling paths, the %TranslateKeyEventInfo() method is called once.
*
* @since 2.1
*
- * @return Whether the KeyEventInfo instance is modified or not.
+ * @return Whether the KeyEventInfo instance is modified or not
* @param[in] source The source of the event
- * @param[in,out] keyEventInfo The key event information which can be converted by this method
+ * @param[in,out] keyEventInfo The key event information that can be converted by this method
*/
virtual bool TranslateKeyEventInfo(Control& source, KeyEventInfo& keyEventInfo) { return false; }
class TouchEventInfo;
/**
- * @interface IPropagatedTouchEventListener
- * @brief This interface is used as the argument to the propagated touch event listener.
+ * @interface IPropagatedTouchEventListener
+ * @brief This interface is used as an argument for the propagated touch event listener.
*
* @since 2.1
*
- * The %IPropagatedTouchEventListener interface is the listener interface for receiving propagated touch events.
+ * The %IPropagatedTouchEventListener interface is the listener interface for receiving propagated touch events. @n
* The class that processes a propagated touch event implements this interface, and the instance created with that class is registered with a
- * UI control, using the control's SetPropagatedTouchEventListener() method. When the touch event occurs, a method of that instance which is derived from %IPropagatedTouchEventListener is
+ * UI control, using the Control::SetPropagatedTouchEventListener() method. When the touch event occurs, a method of that instance which is derived from %IPropagatedTouchEventListener is
* invoked.
- * Propagated touch event listeners work according to the event previewing and bubbling concept. @n
+ * The propagated touch event listeners work according to the event previewing and bubbling concept. @n
* When a touch event occurs, as a previewing notification it is routed from the top-most Window, which is usually a Frame,
* to a control which is the parent of the control where the event occurs. Then, as a bubbling notification it is routed from
* the control to the top-most Window.
* In both previewing and bubbling paths, event routing can be controlled by the value returned by the listener. Returning @c true, which means
- * the event is processed in the listener of the notified control, stops further routing. Returning @c false allows the next event receiver
- * to listen the event.
+ * the event is processed in the listener of the notified control, stops further routing. Returning @c false allows the next event listener
+ * to listen to the event.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
*/
virtual ~IPropagatedTouchEventListener(void){}
/**
- * Called during the bubbling step when a touch pressed.
+ * Called during the bubbling step when a touch is pressed.
*
* @since 2.1
*
* @return Whether the touch event is processed by the listener or not
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnTouchPressed(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the bubbling step when a touch released.
+ * Called during the bubbling step when a touch is released.
*
* @since 2.1
*
* @return Whether the touch event is processed by the listener or not
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnTouchReleased(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the bubbling step when a touch moved.
+ * Called during the bubbling step when a touch is moved.
*
* @since 2.1
*
* @return Whether the touch event is processed by the listener or not
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnTouchMoved(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the bubbling step when a touch canceled.
+ * Called during the bubbling step when a touch is canceled.
*
* @since 2.1
*
* @return Whether the touch event is processed by the listener or not
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnTouchCanceled(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the previewing step when a touch pressed.
+ * Called during the previewing step when a touch is pressed.
*
* @since 2.1
+ *
* @return Whether the touch event is processed by the listener or not
-
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnPreviewTouchPressed(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the previewing step when a touch released.
+ * Called during the previewing step when a touch is released.
*
* @since 2.1
+ *
* @return Whether the touch event is processed by the listener or not
-
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnPreviewTouchReleased(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
- * Called during the previewing step when a touch moved.
+ * Called during the previewing step when a touch is moved.
*
* @since 2.1
+ *
* @return Whether the touch event is processed by the listener or not
-
* @param[in] source The source of the event
- * @param[in] touchInfo The touch event information
+ * @param[in] touchEventInfo The touch event information
*/
virtual bool OnPreviewTouchMoved(Control& source, const TouchEventInfo& touchEventInfo) = 0;
/**
* @interface IScrollPanelEventListener
- * @brief This interface implements a listener for %ScrollPanel events.
+ * @brief This interface implements a listener for ScrollPanel events.
*
* @since 2.0
*
- * The %IScrollPanelEventListener interface is the listener interface for receiving change events related to controls (especially an overlay keypad) within the
+ * The %IScrollPanelEventListener interface is the listener interface for receiving change events related to controls (especially an overlay keypad) within
* ScrollPanel. The class that processes a change event implements this interface, and the instance created with that class is
* registered with a UI control, using the control's AddScrollPanelEventListener() method. When the change event occurs, a method
* of that instance is invoked.
* @brief This is the header file for the %ISlidableGroupedListEventListener interface.
*
* This header file contains the declarations of the %ISlidableGroupedListEventListener interface. @n
- * If an event is generated, a method of this class is called. @n
- * So, if an application performs tasks related to item events, it uses the methods of this class.
+ * If an event is generated, a method of this interface is called. @n
+ * So, if an application performs tasks related to item events, it uses the methods of this interface.
*
*/
#ifndef _FUI_ISLIDABLE_GROUPED_LIST_EVENT_LISTENER_H_
* @if OSPDEPREC
* @interface ISlidableGroupedListEventListener
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
*
- * The %ISlidableGroupedListEventListener interface implements a listener for receiving scroll events on %SlidableGroupedList. @n
+ * The %ISlidableGroupedListEventListener interface implements a listener for receiving scroll events on SlidableGroupedList. @n
* The role of this interface is similar to ISlidableListEventListener.
- * The class is registered with a %SlidableGroupedList, using the control's AddSlidableGroupedListEventListener() method.
+ * This interface is registered with a %SlidableGroupedList, using the SlidableGroupedList::AddSlidableGroupedListEventListener() method.
* @endif
*/
class _OSP_EXPORT_ ISlidableGroupedListEventListener
* This is the destructor for this class.
*
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @endif
*/
/**
* @if OSPDEPREC
- * Called when the %SlidableGroupedList is about to be drawn and requests the listener to set the properties of the list such as the total height and the
+ * Called when the SlidableGroupedList is about to be drawn and requests the listener to set the properties of the list such as the total height and the
* number of items in each group.
*
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @param[in] source The source of the event
* @endif
* Called when the items need to be loaded to the top.
*
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @param[in] source The source of the event
* @param[in] groupIndex The index of the list group
* Called when the items need to be loaded to the bottom.
*
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
* @param[in] source The source of the event
* @param[in] groupIndex The index of the list group
* The user-allocated resources associated with the item to be unloaded need to be freed when OnUnloadItemRequested() is called.
*
* @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableGroupedList.
- * @deprecated This class is deprecated. Instead of using this class, use IGroupedListViewItemEventListener class.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
* @brief This is the header file for the %ISlidableListEventListener interface.
*
* This header file contains the declarations of the %ISlidableListEventListener interface. @n
- * If the event is generated, a method of this class is called. @n
- * So, if applications do jobs related to item events, use the methods of this class.
+ * If the event is generated, a method of this interface is called. @n
+ * So, if applications do jobs related to item events, use the methods of this interface.
*
*/
#ifndef _FUI_ISLIDABLE_LIST_EVENT_LISTENER_H_
/**
* @if OSPDEPREC
* @interface ISlidableListEventListener
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
*
* @if OSPDEPREC
* This is the destructor for this class.
*
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
* @endif
*/
* @if OSPDEPREC
* Called when the slidable list is about to be drawn and requests to set the properties of the list such as the total height.
*
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
* @if OSPDEPREC
* Called when the items need to be loaded to the top.
*
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
* @if OSPDEPREC
* Called when the items need to be loaded to the bottom.
*
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
* Called when an item is about to be unloaded from memory. @n
* The user-allocated resources associated with the item must be freed before unloading, when OnUnloadItemRequested() is called.
*
- * @brief <i> [Deprecated] </i> This interface implements the listener for events on %SlidableList.
- * @deprecated This class is deprecated. Instead of using this class, use IListViewItemEventListener class.
+ * @brief <i> [Deprecated] </i> This interface implements the listener for events on SlidableList.
+ * @deprecated This interface is deprecated. Instead of using this interface, use the IListViewItemEventListener interface.
* @since 2.0
*
* @param[in] source The source of the event
{
/**
- * @class ITouchCustomGestureEventListener
+ * @interface ITouchCustomGestureEventListener
* @brief This interface is used as the argument to the touch custom gesture event listener.
* @since 2.0
*
* The %ITouchCustomGestureEventListener interface is the listener interface for receiving custom gesture events.
* The class that processes a custom gesture event implements this interface, and the instance created with that class is registered with a
- * gesture detector, using the gesture detector's AddGestureEventListener() method. When the custom gesture event occurs, a method of that instance is
+ * gesture detector, using the TouchGestureDetector::AddGestureEventListener() method. When the custom gesture event occurs, a method of that instance is
* invoked.
*
*/
*
* The %ITouchEventListener interface is the listener interface for receiving touch events.
* The class that processes a touch event implements this interface, and the instance created with that class is registered with a
- * UI control, using the control's AddTouchEventListener() method. When the touch event occurs, a method of that instance is
+ * UI control, using the Control::AddTouchEventListener() method. When the touch event occurs, a method of that instance is
* invoked.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
*
* @brief <i> [Deprecated] </i>
* @deprecated This callback is deprecated.
- * If you want to listen to "long press" touch event, it is recommended to use TouchLongPressGestureDetector class.
+ * If you want to listen to "long press" touch event, it is recommended to use the TouchLongPressGestureDetector class.
* @since 2.0
*
* @param[in] source The source of the event
*
* @brief <i> [Deprecated] </i>
* @deprecated This callback is deprecated.
- * If you want to listen to "double press" touch event, it is recommended to use TouchTapGestureDetector class.
+ * If you want to listen to "double press" touch event, it is recommended to use the TouchTapGestureDetector class.
* @since 2.0
*
* @param[in] source The source of the event
virtual void OnTouchFocusIn(const Tizen::Ui::Control& source, const Tizen::Graphics::Point& currentPosition, const Tizen::Ui::TouchEventInfo& touchInfo) = 0;
/**
- * Called when the user touches down on a control and drags finger out of control's bounds
+ * Called when the user touches down on a control and drags finger out of control's bounds.
*
* @since 2.0
*
*
* The %ITouchFlickGestureEventListener interface is the listener interface for receiving flick gesture events.
* The class that processes a flick gesture event implements this interface, and the instance created with that class is registered with a
- * flick gesture detector, using the gesture detector's AddFlickGestureEventListener() method. When the flick gesture event occurs, a method of that instance is
+ * flick gesture detector, using the TouchFlickGestureDetector::AddFlickGestureEventListener() method. When the flick gesture event occurs, a method of that instance is
* invoked.
*
*/
{
/**
- * @class ITouchGestureEventListener
- * @brief This is a base interface that all gesture event listeners must implement.
+ * @interface ITouchGestureEventListener
+ * @brief This interface is a base interface that all gesture event listeners must implement.
*
* @since 2.0
*
*
* The %ITouchLongPressGestureEventListener interface is the listener interface for receiving long press gesture events.
* The class that processes a long press gesture event implements this interface, and the instance created with that class is registered with a
- * long press gesture detector, using the gesture detector's AddLongPressGestureEventListener() method. When the long press gesture event occurs, a method of that instance is
+ * long press gesture detector, using the TouchLongPressGestureDetector::AddLongPressGestureEventListener() method. When the long press gesture event occurs, a method of that instance is
* invoked.
*/
class _OSP_EXPORT_ ITouchLongPressGestureEventListener
*
* The %ITouchPanningGestureEventListener interface is the listener interface for receiving panning gesture events.
* The class that processes a panning gesture event implements this interface, and the instance created with that class is registered with a
- * panning gesture detector, using the gesture detector's AddPanningGestureEventListener() method. When the panning gesture event occurs, a method of that instance is
+ * panning gesture detector, using the TouchPanningGestureDetector::AddPanningGestureEventListener() method. When the panning gesture event occurs, a method of that instance is
* invoked.
*
*/
*
* The %ITouchPinchGestureEventListener interface is the listener interface for receiving pinch gesture events.
* The class that processes a pinch gesture event implements this interface, and the instance created with that class is registered with a
- * pinch gesture detector, using the gesture detector's AddPinchGestureEventListener() method. When the pinch gesture event occurs, a method of that instance is
+ * pinch gesture detector, using the TouchPinchGestureDetector::AddPinchGestureEventListener() method. When the pinch gesture event occurs, a method of that instance is
* invoked.
*
*/
*
* The %ITouchRotationGestureEventListener interface is the listener interface for receiving pinch gesture events.
* The class that processes a rotation gesture event implements this interface, and the instance created with that class is registered with a
- * rotation gesture detector, using the gesture detector's AddRotationGestureEventListener() method. When the rotation gesture event occurs, a method of that instance is
+ * rotation gesture detector, using the TouchRotationGestureDetector::AddRotationGestureEventListener() method. When the rotation gesture event occurs, a method of that instance is
* invoked.
*
*/
*
* The %ITouchTapGestureEventListener interface is the listener interface for receiving tap gesture events.
* The class that processes a tap gesture event implements this interface, and the instance created with that class is registered with a
- * tap gesture detector, using the gesture detector's AddTapGestureEventListener() method. When the tap gesture event occurs, a method of that instance is
+ * tap gesture detector, using the TouchTapGestureDetector::AddTapGestureEventListener() method. When the tap gesture event occurs, a method of that instance is
* invoked.
*
*/
*
* @since 2.0
*
- * The %IWindowEventListener interface for receiving window events. The class that processes a window event
- * implements this interface, and the instance created with that class is registered with a Window using Window's
- * AddWindowEventListener() method. When the window event occurs, the OnWindowActivated(), or OnWindowDeactivated() method of that instance is invoked.
+ * The %IWindowEventListener interface is a listener interface for receiving window events. The class that processes a window event
+ * implements this interface, and the instance created with that class is registered with a Window using the Window::AddWindowEventListener()
+ * method. When the window event occurs, the OnWindowActivated(), or OnWindowDeactivated() method of that instance is invoked.
*/
class _OSP_EXPORT_ IWindowEventListener
: public Tizen::Base::Runtime::IEventListener
*
* @final This class is not intended for extension.
*
- * Example:
+ * The following examples demonstrate how to use the %InputConnection class.
*
* This is a simple editor that uses an %InputConnection.
*
* Sets the cursor at the specified position.
*
* @since 2.0
- * @param[in] position The cursor position that is to be set
+ * @param[in] position The cursor position that is to set
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
result SetCursorPosition(int position);
/**
- * Sets the bounds of the cursor
+ * Sets the bounds of the cursor.
*
* @since 2.0
- * @param[in] rect the rectangle to be set
+ * @param[in] rect The rectangle to set
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
result SetCursorBounds(const Tizen::Graphics::Rectangle& rect);
/**
- * Sets the bounds of the cursor
+ * Sets the bounds of the cursor.
*
* @since 2.1
- * @param[in] rect the rectangle to be set
+ * @param[in] rect The rectangle to set
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @file FUiInputConnectionTypes.h
* @brief This is the header file for the data types.
*
- * This header file contains the declarations of commonly used types.
+ * This header file contains the declarations of the commonly used data types.
*
*/
/**
* @enum InputPanelStyle
- * Defines the style of the InputPanel.
+ * Defines the style of the input panel.
*
* @since 2.0
*/
/**
* @enum InputPanelShowState
- * Defines the state of the InputPanel
+ * Defines the state of the input panel.
*
* @since 2.0
*/
/**
* @enum AutoCapitalizationMode
- * Defines the type of the AutoCapitalization
+ * Defines the type of auto-capitalization mode.
*
* @since 2.0
*/
enum AutoCapitalizationMode
{
- AUTO_CAPITALIZATION_MODE_NONE, /**< AutoCapitalization None Mode */
- AUTO_CAPITALIZATION_MODE_WORD, /**< AutoCapitalization WORD Mode */
- AUTO_CAPITALIZATION_MODE_SENTENCE, /**< AutoCapitalization Sentence Mode */
- AUTO_CAPITALIZATION_MODE_ALL /**< AutoCapitalization All Mode */
+ AUTO_CAPITALIZATION_MODE_NONE, /**< Auto-capitalization mode is set to None */
+ AUTO_CAPITALIZATION_MODE_WORD, /**< Auto-capitalization mode is Word */
+ AUTO_CAPITALIZATION_MODE_SENTENCE, /**< Auto-capitalization mode is Sentence */
+ AUTO_CAPITALIZATION_MODE_ALL /**< Auto-capitalization mode is set to All */
};
/**
*
* @since 2.1
*
- * @param[in] keyCode The key code which represents the key of interest
- * @param[in] keyModifier The key modifier which modifies the normal action of the key
+ * @param[in] keyCode The key code that represents the key of interest
+ * @param[in] keyModifiers The key modifier that modifies the normal action of the key
* @see Tizen::Ui::KeyCode
* @see Tizen::Ui::KeyModifier
*/
virtual ~KeyEventInfo(void);
/**
- * Sets the key code
+ * Sets the key code.
*
* @since 2.1
*
KeyCode GetKeyCode(void) const;
/**
- * Sets bitwise ored key modifiers of the keyboard such as Control, Shift, Numeric lock, and so on.
+ * Sets the bitwise ORed key modifiers of the keyboard such as Control, Shift, Numeric lock, and so on.
*
* @since 2.1
*
- * @param[in] keyModifiers The key modifiers which can be combined using the bitwise OR operator
+ * @param[in] keyModifiers The key modifiers that can be combined using the bitwise OR operator
* @see GetKeyModifier()
* @see Tizen::Ui::KeyModifier
*
*
* @since 2.1
*
- * @return The bitwise oring key modifiers
+ * @return The bitwise ORing key modifiers
* @see SetKeyModifier()
* @see Tizen::Ui::KeyModifier
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks The listener is called after the key event is delivered to the focused control's key event listeners, but before the
* key event is passed onto the focused control itself. @n
* Moreover, if the key needs to be consumed by the control itself, the added listeners will not be notified.
*
* @since 2.0
*
- * @return listener The current application-wide key event listener to be removed
+ * @return listener The current application-wide key event listener to remove
* @see AddKeyEventListener()
*/
void RemoveKeyEventListener(IKeyEventListener& listener);
//
/**
* @file FUiKeyTypes.h
-* @brief This is the header file for the Key enumeration.
+* @brief This is the header file for the key enumeration.
*
-* This header file contains the declarations of the Key enumeration.
+* This header file contains the declarations of the key enumeration.
*/
#ifndef _FUI_KEY_TYPES_H_
#define _FUI_KEY_TYPES_H_
*
* Defines the list of keys supported by the system. @n
* Note that certain keys may not be available on all devices. @n
- * Please use the Tizen::Ui::KeyboardMap class to query the availability of a specific key on the target device.
+ * Please use the Tizen::Ui::KeyboardMap class to query the availability of a specific key on a target device.
*
* @since 2.0
*/
/**
* @enum KeyState
*
- * Defines the state of the key.
+ * Defines the state of a key.
*
* @since 2.0
*/
enum KeyModifier
{
KEY_MODIFIER_NONE = 0, /**< No active modifiers */
- KEY_MODIFIER_SHIFT = 1 << 0, /**< "Shift" is pressed */
- KEY_MODIFIER_CTRL = 1 << 1, /**< "Control" is pressed */
- KEY_MODIFIER_ALT = 1 << 2, /**< "Alt" is pressed */
- KEY_MODIFIER_WIN = 1 << 3, /**< "Win" (between "Ctrl" and "Alt") is pressed */
+ KEY_MODIFIER_SHIFT = 1 << 0, /**< "Shift" is being pressed */
+ KEY_MODIFIER_CTRL = 1 << 1, /**< "Control" is being pressed */
+ KEY_MODIFIER_ALT = 1 << 2, /**< "Alt" is being pressed */
+ KEY_MODIFIER_WIN = 1 << 3, /**< "Win" (between "Ctrl" and "Alt") is being pressed */
KEY_MODIFIER_SCROLL_LOCK = 1 << 4, /**< "Scroll" is locked */
- KEY_MODIFIER_NUM_LOCK = 1 << 5, /**< "Number" is locked */
+ KEY_MODIFIER_NUM_LOCK = 1 << 5, /**< "Num Lock" on the keyboard is locked */
KEY_MODIFIER_CAPS_LOCK = 1 << 6, /**< "Caps" is locked */
};
* keys have one or more text labels.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enum is deprecated because it is not supported by platform.
+ * @deprecated This enum is deprecated because it is not supported by the platform.
* @since 2.0
* @endif
*/
* @if OSPDEPREC
* @class KeyboardMap
* @brief <i> [Deprecated] </i> This class manages the hardware keyboard key mapping.
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* The %KeyboardMap class maintains a map of hardware keys. You can query the current
* specific key. Furthermore, you can query the labels that are printed on the
* hardware keyboard of a specific key.
*
- * The following example demonstrates how to get the type of the keyboard and the property of each key:
+ * The following example demonstrates how to use the %KeyboardMap class to get the type of the keyboard and the property of each key.
*
* @code
* KeyboardMap* pKeyboardMap = KeyboardMap::GetInstance();
* This destructor overrides Tizen::Base::Object::~Object().
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
* @endif
*/
* Gets the pointer to the %KeyboardMap instance.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return The current %KeyboardMap instance
* Checks whether the specified key is a printing key (the key has one or more labels printed on the corresponding key).
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return @c true if the specified key is a printing key, @n
* Checks whether the specified key is available on the current keyboard.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return @c true if the specified key is available on the current keyboard, @n
* Gets the name of the keyboard type.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return The name of the keyboard type
* Gets the label of the specified key.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return The text of the label, @n
* This is the default constructor for this class.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
* @endif
*/
* Initializes this instance of %KeyboardMap.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This class is deprecated because it is not supported by platform.
+ * @deprecated This class is deprecated because it is not supported by the platform.
* @since 2.0
*
* @return An error code
/**
* Sets the relation of the specified child control for the edge with other control.
*
- * @since 2.1
+ * @since 2.0
*
* @return An error code
* @param[in] childControl The control for which the relation is set
* @since 2.0
*
* @return The name of Panel, @n
- * else an empty string if the Panel is not specified
+ * else an empty string if the %Panel is not specified
*/
Tizen::Base::String GetPanelId(void) const;
/**
* Registers a form factory. @n
- * The IFormFactory::CreateFormN() is called when a new form is required.
+ * The IFormFactory::CreateFormN() method is called when a new form is required.
*
* @since 2.0
*
* @return An error code
* @param[in] formFactory The user-defined form factory instance
* @exception E_SUCCESS The method is successful.
- * @see IFormFactory, IFormFactory::CreateFormN()
+ * @see IFormFactory
+ * @see IFormFactory::CreateFormN()
*/
result RegisterFormFactory(const IFormFactory& formFactory);
/**
* Registers a panel factory. @n
- * The IPanelFactory::CreatePanelN() is called when a new panel is required.
+ * The IPanelFactory::CreatePanelN() method is called when a new panel is required.
*
* @since 2.0
*
* @return An error code
* @param[in] panelFactory The user-defined panel factory instance
* @exception E_SUCCESS The method is successful.
- * @see IPanelFactory, IPanelFactory::CreatePanelN()
+ * @see IPanelFactory
+ * @see IPanelFactory::CreatePanelN()
*/
result RegisterPanelFactory(const IPanelFactory& panelFactory);
/**
* Registers scene(s) with the specified resource ID.
- * This method does not remove a scene that is already registered.
+ * The %RegisterScene() method does not remove a scene that is already registered.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OBJ_ALREADY_EXIST The listener with the specified type is already added.
- * @see RemoveSceneManagerEventListener(), ISceneManagerEventListener,
- * ISceneManagerEventListener::OnSceneTransitionCompleted(),
- * ISceneManagerEventListener::OnSceneTransitionStarted()
+ * @see RemoveSceneManagerEventListener()
+ * @see ISceneManagerEventListener
+ * @see ISceneManagerEventListener::OnSceneTransitionCompleted()
+ * @see ISceneManagerEventListener::OnSceneTransitionStarted()
*/
result AddSceneManagerEventListener(ISceneManagerEventListener& sceneManagerEventListener);
* @param[in] sceneManagerEventListener An instance of ISceneManagerEventListener to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified listener is not found.
- * @see AddSceneManagerEventListener(), ISceneManagerEventListener
+ * @see AddSceneManagerEventListener()
+ * @see ISceneManagerEventListener
*/
result RemoveSceneManagerEventListener(ISceneManagerEventListener& sceneManagerEventListener);
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c sceneId is invalid.
* @exception E_OBJ_ALREADY_EXIST The listener with the specified type is already added.
- * @see RemoveSceneEventListener, ISceneEventListener,
- * ISceneEventListener::OnSceneActivatedN(), ISceneEventListener::OnSceneDeactivated()
+ * @see RemoveSceneEventListener()
+ * @see ISceneEventListener
+ * @see ISceneEventListener::OnSceneActivatedN()
+ * @see ISceneEventListener::OnSceneDeactivated()
*/
result AddSceneEventListener(const SceneId& sceneId, ISceneEventListener& sceneEventListener);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c sceneId is invalid.
* @exception E_OBJ_NOT_FOUND The specified @c sceneId is not found.
- * @see AddSceneEventListener, ISceneEventListener
+ * @see AddSceneEventListener()
+ * @see ISceneEventListener
*/
result RemoveSceneEventListener(const SceneId& sceneId, ISceneEventListener& sceneEventListener);
*
* @return An error code
* @param[in] sceneId The target scene ID
- * @param[in] pSceneAnimationProvider An instance of ISceneAnimationProvider to set, or null to clear previous one.
+ * @param[in] pSceneAnimationProvider An instance of ISceneAnimationProvider to set, @n else @c null to clear previous one
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c sceneId is invalid.
* @exception E_OBJ_NOT_FOUND The specified scene is not found.
* @since 2.0
*
* @return An error code
- * @param[in] pSceneTransitionPolicyProvider An instance of ISceneTransitionPolicyProvider to set,
- * or null to clear previous one.
+ * @param[in] pSceneTransitionPolicyProvider An instance of ISceneTransitionPolicyProvider to set, @n
+ * else @c null to clear previous one
* @exception E_SUCCESS The method is successful.
- * @see ISceneTransitionPolicyProvider, ISceneTransitionPolicyProvider::GetNextScene(), GoForward()
+ * @see ISceneTransitionPolicyProvider
+ * @see ISceneTransitionPolicyProvider::GetNextScene()
+ * @see GoForward()
*/
result SetSceneTransitionPolicyProvider(ISceneTransitionPolicyProvider* pSceneTransitionPolicyProvider);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @remarks It throws an E_INVALID_ARG exception if the animationType is SCENE_TRANSITION_ANIMATION_TYPE_NONE
* or SCENE_TRANSITION_ANIMATION_TYPE_CUSTOM.
- * @see GoForward(), GoBackward()
+ * @see GoForward()
+ * @see GoBackward()
*/
result SetFormTransitionAnimationDefaultValues(SceneTransitionAnimationType animationType, long duration,
Tizen::Ui::Animations::AnimationInterpolatorType interpolatorType);
*
* @return An error code
* @param[in] sceneTransition The scene transition that describes the destination and options
- * @param[in] pArgs A pointer to an IList that contains the scene transition parameters
+ * @param[in] pArgs A pointer to Tizen::Base::Collection::IList that contains the scene transition parameters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_IN_PROGRESS A previous transition is in progress.
*
* @return An error code
* @param[in] transitionId The transition ID that describes the destination and options
- * @param[in] pArgs A pointer to an IList that contains the scene transition parameters
+ * @param[in] pArgs A pointer to Tizen::Base::Collection::IList that contains the scene transition parameters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_IN_PROGRESS A previous transition is in progress.
*
* @return An error code
* @param[in] sceneTransition The scene transition that describes the destination and options
- * @param[in] pArgs A pointer to an IList that contains the scene transition parameters
+ * @param[in] pArgs A pointer to Tizen::Base::Collection::IList that contains the scene transition parameters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_IN_PROGRESS A previous transition is in progress.
*
* @return An error code
* @param[in] transitionId The transition ID that describes the destination and options
- * @param[in] pArgs A pointer to an IList that contains the scene transition parameters
+ * @param[in] pArgs A pointer to Tizen::Base::Collection::IList that contains the scene transition parameters
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_IN_PROGRESS A previous transition is in progress.
* @return @c true if the scene instance has not been destroyed, @n
* else @c false
* @param[in] sceneId The scene ID
- * @remarks This function is useful to check state of the scene, because the scene lifetime is determined
+ * @remarks This method is useful to check state of the scene, because the scene lifetime is determined
* by scene transition option and user can destroy the scene in real time.
*/
bool IsSceneAlive(const SceneId& sceneId) const;
* @exception E_SUCCESS The method is successful.
* @exception E_OPERATION_FAILED The current scene is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If a user sets a form as a current form on a frame by calling SetCurrentForm(),
+ * @remarks If a user sets a form as a current form on a frame by calling Tizen::Ui::Controls::Frame::SetCurrentForm(),
* they will no longer be under the control of %SceneManager. In this case,
* they can get back the control of scene management easily by calling this method.
- * @see Tizen::Ui::Controls::Frame::SetCurrentForm
+ * @see Tizen::Ui::Controls::Frame::SetCurrentForm()
*/
result BringCurrentSceneToTop(void);
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @see AddSceneHistory()
+ * @see AddToSceneHistory()
*/
result ClearSceneHistory(void);
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] rhs An instance of %SceneTransition
- * @remarks The method returns @c false if the specified object is not Scene.
+ * @remarks This method returns @c false if the specified object is not Scene.
*/
virtual bool Equals(const Object& rhs) const;
/**
* @file FUiSystemUtil.h
-* @brief This is the header file for the SystemUtil
+* @brief This is the header file for the %SystemUtil class.
*
-* This header file contains the declarations of the SystemUtil class.
+* This header file contains the declarations of the %SystemUtil class.
*
*/
/**
* @class SystemUtil
-* @brief This is a class for system utililty such as touch, key, and capturing screen. It provides
+* @brief This class is for system utililty such as touch, key, and capturing screen. It provides
* functionalities to simulate user inputs.
* @since 2.0
* @final This class is not intended for extension.
*
-* This class provides methods to generate user's input events such as
+* The %SystemUtil class provides methods to generate user's input events such as
* touch and key events for helping test application and to capture current screen.
*/
class _OSP_EXPORT_ SystemUtil
{
public:
/**
- * Generates a key event
+ * Generates a key event.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/inputmanager
*
* @return An error code
- * @param[in] keyEvent The event type of the key to be generated
+ * @param[in] keyEvent The event type of the key to generate
* @param[in] keyCode The code of the key
- * @exception E_SUCCESS The method was successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED An error occurred in the underlying system.
+ * @exception E_OPERATION_FAILED An error has occurred in the underlying system.
* @exception E_INVALID_ARG The specified @c keyEvent or @c keyCode is not supported.
*/
static result GenerateKeyEvent(KeyEventType keyEvent, KeyCode keyCode);
/**
- * Generates a touch event
+ * Generates a touch event.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/inputmanager
*
* @return An error code
- * @param[in] touchEvent The event type of the touch to be generated
+ * @param[in] touchEvent The event type of the touch to generate
* @param[in] point The point on which the touch occurs
- * @exception E_SUCCESS The method was successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED An error occurred in the underlying system.
+ * @exception E_OPERATION_FAILED An error has occurred in the underlying system.
* @exception E_INVALID_ARG The specified @c touchEvent is not supported.
*/
static result GenerateTouchEvent(TouchEventType touchEvent, const Tizen::Graphics::Point& point);
/**
- * Generates a touch event
+ * Generates a touch event.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/inputmanager
*
* @return An error code
- * @param[in] touchEvent The event type of the touch to be generated
+ * @param[in] touchEvent The event type of the touch to generate
* @param[in] point The point on which the touch occurs
- * @exception E_SUCCESS The method was successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED An error occurred in the underlying system.
+ * @exception E_OPERATION_FAILED An error has occurred in the underlying system.
* @exception E_INVALID_ARG The specified @c touchEvent is not supported.
*/
static result GenerateTouchEvent(TouchEventType touchEvent, const Tizen::Graphics::FloatPoint& point);
/**
- * Captures a screen
+ * Captures a screen.
*
* @since 2.0
*
*
* @return A pointer to the captured screen bitmap, @n
* else @c null if it fails to capture screen
- * @exception E_SUCCESS The method was successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_OPERATION_FAILED An error occurred in the underlying system.
+ * @exception E_OPERATION_FAILED An error has occurred in the underlying system.
* @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The returned bitmap should be deleted by the application after use.
+ * The returned bitmap must be deleted by the application after use.
*/
static Tizen::Graphics::Bitmap* CaptureScreenN(void);
* @class Touch
* @brief <i> [Deprecated] </i> This class supports multi-point touch for %Touch devices.
*
- * @deprecated This class is deprecated because the use of the %Touch is no longer recommended. Instead of using this class, use Tizen::Ui::TouchEventManager class.
+ * @deprecated This class is deprecated because the use of %Touch is no longer recommended. Instead of using this class, use the Tizen::Ui::TouchEventManager class.
* @since 2.0
*
* @final This class is not intended for extension.
/**
* @if OSPDEPREC
- * Gets the touch position.
+ * Gets the touch position. @n
* If there is only a single touch, that is returned. If there are multi-point touches, then the position of the last touch is returned.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
* @since 2.0
*
* @return The coordinates of the touch
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
* @since 2.0
*
* @return The coordinates of the touch
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
* @since 2.0
*
* @return The coordinates of the touch
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
* @since 2.0
*
* @return The coordinates of the touch
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetTouchStatus() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetTouchStatus() method.
* @since 2.0
*
* @param[in] id The ID of the touch
* @deprecated This method is deprecated because the %Touch class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method.
* @since 2.0
*
- * @return List of the TouchInfo
+ * @return A list of the TouchInfo instances
* @see Tizen::Ui::TouchInfo
* @endif
*/
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because the %Touch class is not supported any more.
- * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() and use the Tizen::Ui::TouchEventInfo::GetPointId() method.
+ * Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN() method and use the Tizen::Ui::TouchEventInfo::GetPointId() method.
* @since 2.0
*
* @return The touch point ID
{
public:
/**
- * Gets the instance of the %TouchEventManager.
+ * Gets the instance of %TouchEventManager.
*
* @since 2.0
- * @return A instance of the %TouchEventManager
+ * @return An instance of %TouchEventManager
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks This method provides a global point of access to the TouchEventManager. And the specific error code can be accessed using the
+ * @remarks This method provides a global point of access to the TouchEventManager. The specific error code can be accessed using the
* GetLastResult() method.
*/
static TouchEventManager* GetInstance(void);
* Gets the list of the multi-point touches, each represented by TouchEventInfo.
*
* @since 2.0
- * @return List of the TouchEventInfo
+ * @return A list of TouchEventInfo
* @see Tizen::Ui::TouchEventInfo
*
*/
*
* @return The duration of flick
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
*/
int GetDuration(void) const;
result Construct(void);
/**
- * Gets the control which the gesture detector is attached to.
+ * Gets the control to which the gesture detector is attached. @n
* If an error occurs, this method returns @c null.
*
* @since 2.0
*
- * @return The control which the gesture detector is attached to.
+ * @return The control to which the gesture detector is attached
* @exception E_SUCCESS The method is successful.
*/
Control* GetControl(void) const;
/**
- * Enables or disables delaying touch event on Control.
+ * Enables or disables delaying touch event on Control. @n
* The %TouchGestureDetector receives touch events prior to a UI control to which it is added.
* Depending on a gesture that it tries to recognize, it is decided whether touch events need to be delivered to the UI control.
* If touch events must not be delivered to the UI control while gesture recognition is in progress, call this method with @c false argument.
bool IsDelayTouchEventEnabled(void) const;
/**
- * Enables or disables canceling touch event after a gesture is recognized.
+ * Enables or disables canceling touch event after a gesture is recognized. @n
* If canceling touch event is enabled and a gesture is recognized, touch events which have been queued are not delivered to a UI control and discarded.
* The default value is @c false.
*
result StartOnFailureOf(TouchGestureDetector* pGestureDetector);
/**
- * Called when touch is pressed in the Control which the gesture detector is attached to.
+ * Called when touch is pressed in the Control to which the gesture detector is attached.
*
* @since 2.0
*
virtual void OnTouchPressed(Tizen::Ui::Control& source, const Tizen::Ui::TouchEventInfo& touchInfo);
/**
- * Called when touch is moved in the Control which the gesture detector is attached to.
+ * Called when touch is moved in the Control to which the gesture detector is attached.
*
* @since 2.0
*
virtual void OnTouchMoved(Tizen::Ui::Control& source, const Tizen::Ui::TouchEventInfo& touchInfo);
/**
- * Called when touch is released in the Control which the gesture detector is attached to.
+ * Called when touch is released in the Control to which the gesture detector is attached.
*
* @since 2.0
*
virtual void OnTouchReleased(Tizen::Ui::Control& source, const Tizen::Ui::TouchEventInfo& touchInfo);
/**
- * Called when touch is canceled in the Control which the gesture detector is attached to.
+ * Called when touch is canceled in the Control to which the gesture detector is attached.
*
* @since 2.0
*
protected:
/**
- * Sets the current state of gesture detector.
+ * Sets the current state of gesture detector. @n
* You can call this method only inherit %TouchGestureDetector directly.
*
* @since 2.0
result SetDetectorState(Tizen::Ui::TouchGestureDetectorState state);
/**
- * Gets the current state of gesture detector.
+ * Gets the current state of gesture detector. @n
* If an error occurs, this method returns @c GESTURE_DETECTOR_STATE_READY.
*
* @since 2.0
* @class TouchInfo
* @brief <i> [Deprecated] </i> This class stores the information of a touch event.
*
- * @deprecated This class is deprecated because the use of the %TouchInfo is no longer recommended. Instead of using this class, use Tizen::Ui::TouchEventInfo class.
+ * @deprecated This class is deprecated because the use of %TouchInfo is no longer recommended. Instead of using this class, use the Tizen::Ui::TouchEventInfo class.
* @since 2.0
*
* @final This class is not intended for extension.
* The ID of the Touch instance.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
+ * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
* and use the Tizen::Ui::TouchEventInfo::GetPointId() method.
* @since 2.0
* @endif
* The position of the Touch instance.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
+ * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
* and use the Tizen::Ui::TouchEventInfo::GetCurrentPosition() method.
* @since 2.0
* @endif
* The status of the Touch instance, using only the @c TOUCH_PRESSED and @c TOUCH_RELEASED states.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, get the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
+ * @deprecated This method is deprecated because the %TouchInfo class is not supported any more. Instead, use the Tizen::Ui::TouchEventManager::GetTouchInfoListN()
* and use the Tizen::Ui::TouchEventInfo::GetTouchStatus() method.
* @since 2.0
* @endif
*
* @return The time duration
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
* @see SetDuration()
*/
int GetDuration(void) const;
*
* @return The allowed move bounds
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
* @see SetMoveAllowance()
*
*/
*
* @return The allowed move bounds
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
* @see SetMoveAllowance()
*
*/
*
* @return The finger count for long press gesture
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
* @see GetTouchCount()
*
*/
*
* @return The finger count for panning gesture
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
* @see SetTouchCount()
*
*/
Tizen::Graphics::FloatPoint GetCenterPointF(void) const;
/**
- * Gets the scale factor among touched point
+ * Gets the scale factor among touched points.
*
* @since 2.0
*
* @return The scale factor among touched points
- * @remarks Get scale factor for a pinch gesture in progress
+ * @remarks Gets the scale factor for a pinch gesture in progress.
*/
int GetScale(void) const;
*
* @return The angle between two touch points
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
*/
float GetAngle(void) const;
*
* @return The distance between two touch points
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
*/
int GetDistance(void) const;
*
* @return The distance between two touch points
* @exception E_SUCCESS The method is successful.
- * @remarks If an error occurs, this method returns -1.
+ * @remarks If an error occurs, this method returns @c -1.
*/
float GetDistanceF(void) const;
* @since 2.1
*
* @return An error code
- * @param[in] file name The file name of a font-resource which are located in '/res/font'.
- * Sets an empty string to reset.
+ * @param[in] fileName The file name of a font-resource located in @b '/res/font', @n
+ * else sets an empty string to reset
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_NOT_FOUND The specified font cannot be found or accessed.
* @exception E_UNSUPPORTED_FORMAT The specified font format is not supported.
enum WindowZOrderGroup\r
{\r
WINDOW_Z_ORDER_GROUP_HIGHEST, /**< The highest group for windows such as the call screen */\r
- WINDOW_Z_ORDER_GROUP_HIGH, /**< The high qroup for windows such as the lock screen */\r
+ WINDOW_Z_ORDER_GROUP_HIGH, /**< The high group for windows such as the lock screen */
WINDOW_Z_ORDER_GROUP_NORMAL, /**< The default group of apps */\r
};\r
\r
*\r
* @since 2.0\r
*\r
+ * The %Window class is an abstract base class.
* The %Window is a top-level window such as Controls::Frame, Controls::MessageBox, and Controls::Popup.\r
* The descendants of a %Window can exist outside of their applications's bounds.\r
- * The %Window class is an abstract base class.\r
*\r
*/\r
class _OSP_EXPORT_ Window\r
\r
protected:\r
/**\r
- * Initializes this instance of %Window.\r
+ * Initializes this instance of %Window with the specified parameters.
*\r
* @since 2.0\r
*\r