*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
*/
void AddAnimationEventListener(Tizen::Ui::IAnimationEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
*/
void RemoveAnimationEventListener(Tizen::Ui::IAnimationEventListener& listener);
*
* @since 2.0
*
- * @param[in] frame The bitmap to be displayed
+ * @param[in] frame The bitmap to display
* @param[in] duration The duration in milliseconds for which the bitmap is displayed
*/
AnimationFrame(const Tizen::Graphics::Bitmap& frame, long duration);
*
* @since 2.0
*
- * @param[in] frame The bitmap to be displayed
+ * @param[in] frame The bitmap to display
*/
void SetFrame(const Tizen::Graphics::Bitmap& frame);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveColorChangeEventListener()
*/
void AddColorChangeEventListener(Tizen::Ui::IColorChangeEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddColorChangeEventListener()
*/
void RemoveColorChangeEventListener(Tizen::Ui::IColorChangeEventListener& listener);
{
CONTEXT_MENU_STYLE_LIST,/**< The style of the vertical list of image + text */
CONTEXT_MENU_STYLE_GRID,/**< The style of the grid of buttons */
- CONTEXT_MENU_STYLE_ICON /**<@if OSPDEPREC @deprecated This enumeration field is deprecated because this style can be implemented using the CONTEXT_MENU_STYLE_GRID style @endif */
+ CONTEXT_MENU_STYLE_ICON /**<@if OSPDEPREC @deprecated This enum value is deprecated because this style can be implemented using the CONTEXT_MENU_STYLE_GRID style @endif */
} ;
/**
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID.
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID.
*/
result AddItem(const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID. @n
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
* When a user navigates the user interface using the directional keys, the selected UI control is highlighted and the control takes the
* focus.
*/
* @since 2.0
*
* @return An error code
- * @param[in] text The string of the item to be appended
+ * @param[in] text The string of the item to append
* @param[in] actionId The specified action ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @since 2.0
*
* @return An error code
- * @param[in] text The string of the item to be appended
+ * @param[in] text The string of the item to append
* @param[in] actionId The specified action ID for this item
* @param[in] normalBitmap The normal bitmap of the item
* @param[in] pPressedBitmap The pressed bitmap of the item
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The total number of items has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_LIST.
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
*/
result AddItem(const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID. @n
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
* The %ContextMenu control can have a maximum of 3 icons.
*/
result InsertItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID. @n
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
* @remarks When a user navigates the user interface using the directional keys, the selected UI control is highlighted and the control takes the focus.
*/
result InsertItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, const Tizen::Graphics::Bitmap* pHighlightedBitmap, int actionId);
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_LIST.
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
*/
result InsertItemAt(int index, const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID.
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID.
*/
result SetItemAt(int index, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap, int actionId);
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_GRID. @n
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_GRID. @n
* @remarks When a user navigates the user interface using the directional keys, @n
* the selected UI control is highlighted and the control takes the focus.
*/
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index less than @c 0 or greater than the number of items in %ContextMenu.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method can only be used when the style of the context menu is CONTEXT_MENU_STYLE_LIST.
+ * @remarks This method can only be used when the style of the context menu is @c CONTEXT_MENU_STYLE_LIST.
*/
result SetItemAt(int index, const Tizen::Base::String& text, int actionId, const Tizen::Graphics::Bitmap& normalBitmap, const Tizen::Graphics::Bitmap* pPressedBitmap = null, const Tizen::Graphics::Bitmap* pHighlightedBitmap = null);
*
* @return An error code
* @param[in] status The item status
- * @param[in] color The item text color to be set
+ * @param[in] color The item text color to set
* @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.
* @since 2.0
*
* @return An error code
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @exception E_SYSTEM A system error has occurred.
* @param[in] status The menu item status
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The item color for CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
+ * The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The item color for the CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
+ * The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
* @see SetItemColor()
*/
Tizen::Graphics::Color GetItemColor(ContextMenuItemStatus status) const;
*
* @return An error code
* @param[in] status The menu item status
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The item color for CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
+ * The item color for @c CONTEXT_MENU_ITEM_STATUS_NORMAL is not supported.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The item color for the CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
+ * @remarks The item color for the @c CONTEXT_MENU_ITEM_STATUS_NORMAL status is always the same as the color of the %ContextMenu control.
* @see GetItemColor()
*/
result SetItemColor(ContextMenuItemStatus status, const Tizen::Graphics::Color& color);
* @deprecated This class is deprecated. Instead of using this class, use ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddCustomItemEventListener(Tizen::Ui::ICustomItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveCustomItemEventListener(Tizen::Ui::ICustomItemEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] item The custom list item to be added
+ * @param[in] item The custom list item to add
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] index The index at which to insert the item
- * @param[in] item The custom list item to be inserted
+ * @param[in] item The custom list item to insert
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
*
* @return An error code
* @param[in] index The index at which to set the contents of the item
- * @param[in] item The custom list item to be set
+ * @param[in] item The custom list item to set
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the item to be deleted
+ * @param[in] index The index of the item to delete
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c index is less than @c 0 or greater than or equal to the item count.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the item whose status is to be set
+ * @param[in] index The index of the item whose status is to set
* @param[in] enable Set to @c true to enable, @n
* else @c false
* @exception E_SUCCESS The method is successful.
*
* @return @c true if the item is enabled, @n
* else @c false
- * @param[in] index The index of the item to be checked
+ * @param[in] index The index of the item to check
* @endif
*/
bool IsItemEnabled(int index) const;
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the item to be set
+ * @param[in] index The index of the item to set
* @param[in] check The check status
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @deprecated This class is deprecated. Instead of using this class, use ListView class.
* @since 2.0
*
- * @param[in] text The text message to be displayed
+ * @param[in] text The text message to display
* @endif
*/
void SetTextOfEmptyList(const Tizen::Base::String& text);
* @deprecated This class is deprecated. Instead of using this class, use ListView class.
* @since 2.0
*
- * @param[in] color The color of the text to be displayed
+ * @param[in] color The color of the text to display
* @endif
*/
void SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
*
* @return An error code
* @param[in] elementId The ID of the element
- * @param[in] text The text string to be added
+ * @param[in] text The text string to add
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks To display text in multi-lines or to denote the end of line use '\\n'.
/**
* @file FUiCtrlCustomListTypes.h
- * @brief This is the header file for the CustomListStyle enumeration.
+ * @brief This is the header file for the %CustomListStyle enumeration.
*
- * The CustomListStyle enumeration defines the styles for the CustomList control.
+ * This header file contains the declarations of the %CustomListStyle enumeration.
+ * This enum defines the styles for the CustomList control.
*/
#ifndef _FUI_CTRL_CUSTOM_LIST_TYPES_H_
#define _FUI_CTRL_CUSTOM_LIST_TYPES_H_
*
* Defines the styles of CustomList.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. Instead of using this enumeration, use ListAnnexStyle enumeration for CustomItem or SimpleItem class. @n
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This enum is deprecated. Instead of using this enum, use the ListAnnexStyle enumeration for the CustomItem or SimpleItem class.
* @since 2.0
* @endif
*/
#include <FUiWindow.h>
#include <FUiIDateChangeEventListener.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
__pDatePicker = new DatePicker();
__pDatePicker->Construct();
- // Adds an instace of IDateChangeEventListener
+ // Adds an instance of IDateChangeEventListener
__pDatePicker->AddDateChangeEventListener(*this);
// Shows the date picker after it's owner form is shown.
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see IDateChangeEventListener::OnDateChanged()
* @see IDateChangeEventListener::OnDateChangeCanceled()
* @see RemoveDateChangeEventListener()
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see IDateChangeEventListener::OnDateChanged()
* @see IDateChangeEventListener::OnDateChangeCanceled()
* @see AddDateChangeEventListener()
*
* @since 2.0
*
- * @param[in] date The date to be set
+ * @param[in] date The date to set
*/
void SetDate(const Tizen::Base::DateTime& date);
#include <FUiWindow.h>
#include <FUiIDateTimeChangeEventListener.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
__pDateTimePicker = new DateTimePicker();
__pDateTimePicker->Construct();
- // Adds an instace of IDateTimeChangeEventListener
+ // Adds an instance of IDateTimeChangeEventListener
__pDateTimePicker->AddDateTimeChangeEventListener(*this);
// Shows the date time picker after it's owner form is shown.
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see IDateTimeChangeEventListener::OnDateTimeChanged()
* @see IDateTimeChangeEventListener::OnDateTimeChangeCanceled()
* @see RemoveDateTimeChangeEventListener()
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see IDateTimeChangeEventListener::OnDateTimeChanged()
* @see IDateTimeChangeEventListener::OnDateTimeChangeCanceled()
* @see AddDateTimeChangeEventListener()
*
* @since 2.0
*
- * @param[in] dateTime The date and time to be set
+ * @param[in] dateTime The date and time to set
*/
void SetDateTime(const Tizen::Base::DateTime& dateTime);
* @since 2.0
*
* @return An error code
- * @param[in] hour The hour value to be set
+ * @param[in] hour The hour value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c hour value is invalid.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] minute The minute value to be set
+ * @param[in] minute The minute value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c minute value is invalid.
* @exception E_SYSTEM A system error has occurred.
/**
* Sets the valid year range. @n
- * The range should be set between @c 1 and @c 9999.
+ * The range should be set between @c 1 and @c 9999.
*
* @since 2.0
*
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.@n
* The added listener will be notified when the links are selected by the user.
* @see RemoveUiLinkEventListener()
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
* @see AddUiLinkEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveKeypadEventListener()
*/
void AddKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddKeypadEventListener()
*/
void RemoveKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks Programmatically modifying the text block does not cause the text block selection event to fire.
* @see RemoveTextBlockEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextBlockEventListener()
*/
void RemoveTextBlockEventListener(Tizen::Ui::ITextBlockEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see RemoveTextEventListener()
*/
void AddTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddTextEventListener()
*/
void RemoveTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @remarks To listen to scroll panel events, the parent of the %EditArea control must be an instance of ScrollPanel. @n
* When OnOverlayControlCreated() or OnOvelayControlClosed() is called, the application resets the bounds of the controls placed
* within the %ScrollPanel. %ScrollPanel is automatically redrawn after this method is called.
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddScrollPanelEventListener()
*/
void RemoveScrollPanelEventListener(Tizen::Ui::IScrollPanelEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveActionEventListener()
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddActionEventListener()
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @remarks The application can recognize when the language is changed from the keypad by adding Tizen::Ui::ILanguageEventListener.
* @see RemoveLanguageEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddLanguageEventListener()
*/
void RemoveLanguageEventListener(Tizen::Ui::ILanguageEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] categories The categories to be set @n
+ * @param[in] categories The categories to set @n
* Multiple input categories can be combined using bitwise OR (see Tizen::Ui::Controls::EditInputModeCategory).
- * @param[in] enable The category value to be set
+ * @param[in] enable The category value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input mode category is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @n
* @since 2.0
*
* @return An error code
- * @param[in] position The cursor position that is to be set
+ * @param[in] position The cursor position to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c position is less than @c 0 or greater than the maximum length.
* @exception E_SYSTEM A system error has occurred.
*
* @since 2.0
*
- * @param[in] text The text that needs to be displayed by the %EditArea control.
+ * @param[in] text The text to display by the %EditArea control
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The length of the specified @c text exceeds the system limitation or the limit length.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be inserted
+ * @param[in] text The text to insert
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks Use @htmlonly '\n' @endhtmlonly to denote the end of the line.@n
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
+ * @param[in] text The text to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks Use @htmlonly '\n' @endhtmlonly to denote the end of the line.@n
* @since 2.0
*
* @return An error code
- * @param[in] character The character to be appended
+ * @param[in] character The character to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method modifies the text buffer that is managed by the %EditArea control. To display the
*
* @return An error code
* @param[in] position The position to insert the text
- * @param[in] text The text to be inserted
- * @param[in] textImage The alternate bitmap to be drawn
+ * @param[in] text The text to insert
+ * @param[in] textImage The alternate bitmap to draw
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c position is outside the valid range. @n
* Either the specified @c position is greater than the number of existing text in the %EditArea or less than @c 0.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
- * @param[in] textImage The alternate bitmap to be drawn
+ * @param[in] text The text to append
+ * @param[in] textImage The alternate bitmap to draw
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The length of the specified @c text exceeds the maximum length of the text that can be displayed by %EditArea.
* @remarks The method modifies the text buffer that is managed by the %EditArea control. @n
/**
* Checks whether a portion of the text is blocked.
*
- * @since 2.0
+ * @since 2.0
*
* @return @c true if the text is blocked, @n
* else @c false
* @since 2.0
*
* @return An error code
- * @param[in] languageCode The language to be set
+ * @param[in] languageCode The language to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The application can set the language of the current keypad that is associated with the current %EditArea. @n
#include <FUiIDateChangeEventListener.h>
#include <FUiIOrientationEventListener.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
__pEditDate->Construct(Point(100, 100));
__pEditDate->AddDateChangeEventListener(*this);
- // Adds an instace of IDateChangeEventListener
+ // Adds an instance of IDateChangeEventListener
AddControl(*__pEditDate);
return r;
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see IDateChangeEventListener::OnDateChanged()
* @see IDateChangeEventListener::OnDateChangeCanceled()
* @see RemoveDateChangeEventListener()
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see IDateChangeEventListener::OnDateChanged()
* @see IDateChangeEventListener::OnDateChangeCanceled()
* @see AddDateChangeEventListener()
*
* @since 2.0
*
- * @param[in] date The date to be set
+ * @param[in] date The date to set
*/
void SetDate(const Tizen::Base::DateTime& date);
* @since 2.0
*
* @return An error code
- * @param[in] year The year to be set
+ * @param[in] year The year to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The given year value is invalid.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] month The month to be set
+ * @param[in] month The month to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The given month value is invalid.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] day The day to be set
+ * @param[in] day The day to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The given day value is invalid.
* @exception E_SYSTEM A system error has occurred.
*
* @since 2.0
*
- * The %EditField class displays a single-line text editor.
+ * The %EditField class displays a single-line text editor.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_editfield_editarea.htm">EditArea and EditField</a>.
*
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY. @n
* The added listener is notified when the links are selected by the user.
* @see RemoveUiLinkEventListener()
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
* @see AddUiLinkEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveKeypadEventListener()
*/
void AddKeypadEventListener(IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddKeypadEventListener()
*/
void RemoveKeypadEventListener(IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks Programmatically modifying the text block does not cause the text block selection event to fire.
* @see RemoveTextBlockEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextBlockEventListener()
*/
void RemoveTextBlockEventListener(Tizen::Ui::ITextBlockEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
*/
void AddTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
*/
void RemoveTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @remarks To listen to the scroll panel events, the parent of EditArea must be an instance of ScrollPanel. @n
* When OnOverlayControlCreated() or OnOvelayControlClosed() is called, the application resets the bounds of the controls placed
* within the ScrollPanel control. ScrollPanel is automatically drawn again after this method is called.
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
*/
void RemoveScrollPanelEventListener(Tizen::Ui::IScrollPanelEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @remarks The application can recognize when the language is changed from the keypad by adding Tizen::Ui::ILanguageEventListener.
* @see RemoveLanguageEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddLanguageEventListener()
*/
void RemoveLanguageEventListener(Tizen::Ui::ILanguageEventListener& listener);
/**
* Gets the remaining length of the %EditField control.
*
- * @since 2.0
+ * @since 2.0
*
* @return The remaining length of the %EditField control, @n
* else @c -1 if an error occurs
/**
* Checks whether the lowercase mode is enabled.
*
- * @since 2.0
+ * @since 2.0
*
* @return @c true if the lowercase mode is enabled, @n
* else @c false
* @since 2.0
*
* @return An error code
- * @param[in] categories The categories to be set @n
+ * @param[in] categories The categories to set @n
* Multiple input categories can be combined using bitwise OR operator (see Tizen::Ui::Controls::EditInputModeCategory).
* @param[in] enable The category value to set
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param[in] position The cursor position that is to be set
+ * @param[in] position The cursor position to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c position is less than @c 0 or greater than the maximum length.
* @exception E_SYSTEM A system error has occurred.
*
* @since 2.0
*
- * @param[in] text The text to be displayed by the %EditField control
+ * @param[in] text The text to display by the %EditField control
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The length of the specified @c text exceeds the system limitation or the limit length.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be inserted
+ * @param[in] text The text to insert
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks Use @htmlonly '\n' @endhtmlonly to denote the end of the line.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
+ * @param[in] text The text to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks Use @htmlonly '\n' @endhtmlonly to denote the end of the line.
* @since 2.0
*
* @return An error code
- * @param[in] character The character to be appended
+ * @param[in] character The character to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method modifies the text buffer that is managed by the %EditField control. To display the
* @since 2.0
*
* @return An error code
- * @param[in] title The title to be set
+ * @param[in] title The title to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
* @since 2.0
*
* @return An error code
- * @param[in] languageCode The language to be set
+ * @param[in] languageCode The language to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The application can set the language of the current keypad that is associated with the current %EditField. @n
#include <FUiITimeChangeEventListener.h>
#include <FUiIOrientationEventListener.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see ITimeChangeEventListener::OnTimeChanged()
* @see ITimeChangeEventListener::OnTimeChangeCanceled()
* @see RemoveTimeChangeEventListener()
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddTimeChangeEventListener()
*/
void RemoveTimeChangeEventListener(Tizen::Ui::ITimeChangeEventListener& listener);
*
* @since 2.0
*
- * @param[in] hour The hour value to be set
+ * @param[in] hour The hour value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified hour value is invalid.
* @exception E_SYSTEM A system error has occurred.
*
* @since 2.0
*
- * @param[in] minute The minute value to be set
+ * @param[in] minute The minute value to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified minute value is invalid.
* @exception E_SYSTEM A system error has occurred.
*
* @since 2.0
*
- * @param[in] time The time to be set
+ * @param[in] time The time to set
*/
void SetTime(const Tizen::Base::DateTime& time);
__pExpandableEdit->Construct(Rectangle(25, 100, GetClientAreaBounds().width - 50, 150),
EXPANDABLE_EDIT_AREA_STYLE_NORMAL, EXPANDABLE_EDIT_AREA_TITLE_STYLE_NONE, 5);
- // Adds an instace of IKeypadEventListenerevent and an instance of IExpandableEditAreaEventListener
+ // Adds an instance of IKeypadEventListenerevent and an instance of IExpandableEditAreaEventListener
__pExpandableEdit->AddKeypadEventListener(*this);
__pExpandableEdit->AddExpandableEditAreaEventListener(*this);
* @param[in] maxExpandableLines The maximum number of lines to which the control can be expanded.
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
- * The token style %ExpandabledEditArea does not support EXPANDABLE_EDIT_AREA_TITLE_STYLE_TOP.
+ * The token style %ExpandabledEditArea does not support @c EXPANDABLE_EDIT_AREA_TITLE_STYLE_TOP.
* @exception E_MAX_EXCEEDED The number of lines has exceeded the maximum limit.
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the specified @c maxLines is either negative or @c 0.
* @param[in] maxExpandableLines The maximum number of lines to which the control can be expanded.
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
- * The token style %ExpandabledEditArea does not support EXPANDABLE_EDIT_AREA_TITLE_STYLE_TOP.
+ * The token style %ExpandabledEditArea does not support @c EXPANDABLE_EDIT_AREA_TITLE_STYLE_TOP.
* @exception E_MAX_EXCEEDED The number of lines has exceeded the maximum limit.
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the specified @c maxLines is either negative or @c 0.
* @since 2.0
*
* @return An error code
- * @param[in] character The character to be appended
+ * @param[in] character The character to append
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. @n
* The number of characters has exceeded the maximum limit.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
+ * @param[in] text The text to append
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit @n
* The number of characters has exceeded the maximum limit.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended @n
- * It will be displayed by the @c textImage
- * @param[in] textImage The alternate bitmap to be displayed
+ * @param[in] text The text to append @n
+ * It will be displayed by the @c textImage.
+ * @param[in] textImage The alternate bitmap to display
* @exception E_SUCCESS The method is successful.
* @exception E_MAX_EXCEEDED The length of the specified @c text exceeds the maximum length of the text that can be displayed by % ExpanableEditArea.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
*
* @return An error code
* @param[in] index The position to insert the character
- * @param[in] character The character to be inserted
+ * @param[in] character The character to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* Either the specified @c index is greater than the number of elements or less than @c 0.
*
* @return An error code
* @param[in] index The position to insert the text
- * @param[in] text The text to be inserted
+ * @param[in] text The text to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* Either the specified @c index is greater than the number of elements or less than @c 0.
*
* @return An error code
* @param[in] position The position to insert the text
- * @param[in] text The text to be inserted @n
- * It will be displayed by the @c textImage
- * @param[in] textImage The alternate bitmap to be displayed
+ * @param[in] text The text to insert @n
+ * It will be displayed by the @c textImage.
+ * @param[in] textImage The alternate bitmap to display
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c position is outside the valid range. @n
* Either the specified @c position is greater than the number of existing text in the % ExpanableEditArea or less than @c 0.
*
* @since 2.0
*
- * @param[in] text The text to be set
+ * @param[in] text The text to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid, @n
* or the length of the specified @c text exceeds system limitations.
* @since 2.0
*
* @return An error code
- * @param[in] title The title to be set
+ * @param[in] title The title to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
* @endif
* @return An error code
* @param[in] marginType The margin type
- * @param[in] margin The margin to be set
+ * @param[in] margin The margin to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The specified @c margin cannot be negative integer.
* @page CompSetMarginPage Compatibility for SetMargin()
* @section CompSetMarginPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# The SetMargin() method sets the margin value for ExpandableEditArea with only EXPANDABLE_EDIT_AREA_STYLE_NORMAL in API version 2.0. @n
+ * -# The SetMargin() method sets the margin value for ExpandableEditArea with only @c EXPANDABLE_EDIT_AREA_STYLE_NORMAL in API version 2.0. @n
*
* @section CompSetMarginPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @endif
* @return An error code
* @param[in] marginType The margin type
- * @param[in] margin The margin to be set
+ * @param[in] margin The margin to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The specified @c margin cannot be negative integer.
* @page CompSetMarginPage Compatibility for SetMargin()
* @section CompSetMarginPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# The SetMargin() method sets the margin value for ExpandableEditArea with only EXPANDABLE_EDIT_AREA_STYLE_NORMAL in API version 2.0. @n
+ * -# The SetMargin() method sets the margin value for ExpandableEditArea with only @c EXPANDABLE_EDIT_AREA_STYLE_NORMAL in API version 2.0. @n
*
* @section CompSetMarginPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @since 2.0
*
* @return An error code
- * @param[in] position The cursor position to be set
+ * @param[in] position The cursor position to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c position is less than @c 0 or greater than the maximum length.
* @exception E_SYSTEM A system error has occurred.
* @param[in] keypadStyle The keypad style
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The specified @c keypadStyle is KEYPAD_STYLE_PASSWORD.
+ * The specified @c keypadStyle is @c KEYPAD_STYLE_PASSWORD.
* @exception E_SYSTEM A system error has occurred.
* @remarks Depending on the value of the keypad style, the layout of the keypad will change accordingly.
* @see GetKeypadStyle()
* @param[in] pFilter The filter
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The %ExpandableEditArea control checks with the registered filter to decide whether the user-entered text should be replaced.
*/
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An error code
- * @param[in] token The token to be appended
+ * @param[in] token The token to append
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The length of the specified @c token is @c 0.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] index The position to insert the token
- * @param[in] token The token to be added
+ * @param[in] token The token to add
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The length of the specified @c token is @c 0.
* @exception E_SYSTEM A system error has occurred.
* @param[in] index The position to get the token
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_OUT_OF_RANGE The specified index parameter is outside the bounds of the data structure. @n
* Either the index is greater than the number of elements or less than @c 0.
* @exception E_SYSTEM A system error has occurred.
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* else @c -1 if no token is selected or if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the token to be removed
+ * @param[in] index The index of the token to remove
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n
* Either the index is greater than the number of elements or less than @c 0.
* @exception E_SYSTEM A system error has occurred.
* else @c false to unselect
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n
* Either the index is greater than the number of elements or less than @c 0.
* @exception E_SYSTEM A system error has occurred.
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
*/
result SetTokenEditModeEnabled(bool enable);
* @since 2.0
*
* @return An error code
- * @param[in] limitLength The limit text length to be set
+ * @param[in] limitLength The limit text length to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid, @n
* or the specified limit length is @c 0 or negative.
* @param[in] status The status
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetTokenColor
* else RGBA (0,0,0,0) if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetTokenTextColor()
* else RGBA (0,0,0,0) if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetSelectedTokenTextColor()
* @param[in] color The token text color
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @see GetSelectedTokenTextColor()
*/
* @param[in] color The token color
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @see GetTokenColor()
*/
* @param[in] color The token text color
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the style is not EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @see GetTokenTextColor()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveExpandableEditAreaEventListener()
*/
void AddExpandableEditAreaEventListener(IExpandableEditAreaEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveKeypadEventListener()
*/
void AddKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks Programmatically modifying the text block does not cause the text block selection event to fire.
* @see RemoveTextBlockEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see RemoveTextEventListener()
*/
void AddTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddActionEventListener()
*/
void RemoveExpandableEditAreaEventListener(IExpandableEditAreaEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddKeypadEventListener()
*/
void RemoveKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextBlockEventListener()
*/
void RemoveTextBlockEventListener(Tizen::Ui::ITextBlockEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddTextEventListener()
*/
void RemoveTextEventListener(Tizen::Ui::ITextEventListener& listener);
virtual result OnTerminating(void);
// IExpandableItemEventListener
- virtual void OnItemStateChanged(const Control& source, int mainIndex, int subIndex, int itemId, Tizen::Ui::ItemStatus status);
- virtual void OnItemStateChanged(const Control& source, int mainIndex, int subIndex, int itemId, int elementId, Tizen::Ui::ItemStatus status);
+ virtual void OnItemStateChanged(const Control& source, int mainIndex, int subIndex, int itemId, Tizen::Ui::ItemStatus status);
+ virtual void OnItemStateChanged(const Control& source, int mainIndex, int subIndex, int itemId, int elementId, Tizen::Ui::ItemStatus status);
* @deprecated This class is deprecated. Instead of using this class, use GroupedTableView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddExpandableItemEventListener(Tizen::Ui::IExpandableItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use GroupedTableView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveExpandableItemEventListener(Tizen::Ui::IExpandableItemEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] item The CustomListItem to be added
+ * @param[in] item The CustomListItem to add
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] mainIndex The index at which to insert the item
- * @param[in] item The CustomListItem to be inserted
+ * @param[in] item The CustomListItem instance to insert
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c index is less than @c 0 or greater than the item count.
*
* @return An error code
* @param[in] mainIndex The index at which to set the contents of the item
- * @param[in] item The CustomListItem to be set
+ * @param[in] item The CustomListItem instance to set
* @param[in] itemId The item ID for the item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c index is less than @c 0 or greater than the item count.
* @since 2.0
*
* @return An error code
- * @param[in] mainIndex The index of the item to be deleted
+ * @param[in] mainIndex The index of the item to delete
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c index is less than @c 0 or greater than the item count.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] mainIndex The index of the main item to which the sub-item is added
- * @param[in] item The CustomListItem instance to be added
+ * @param[in] item The CustomListItem instance to add
* @param[in] itemId The item ID for the sub-item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified index is less than @c 0, or greater than the item count.
* @return An error code
* @param[in] mainIndex The index of the main item to which the sub-item is added
* @param[in] subIndex The index of the sub-item at which to insert the item
- * @param[in] item The CustomListItem instance to be inserted
+ * @param[in] item The CustomListItem instance to insert
* @param[in] itemId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified index is less than @c 0, or greater than the item count.
* @return An error code
* @param[in] mainIndex The main index of the sub-item at which to set the contents of the item
* @param[in] subIndex The sub-index of the sub-item at which to set the contents of the item
- * @param[in] item The CustomListItem instance to be set
+ * @param[in] item The CustomListItem instance to set
* @param[in] itemId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified index is less than @c 0, or greater than the item count.
*
* @return An error code
* @param[in] mainIndex The index of the main item which the sub-item belongs to
- * @param[in] subIndex The index of the sub-item to be deleted in the main item
+ * @param[in] subIndex The index of the sub-item to delete in the main item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified index is less than @c 0, or greater than the item count.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] mainIndex The index of the main item, for which the status is to be set
+ * @param[in] mainIndex The index of the main item, for which the status is set
* @param[in] enable Set to @c true to enable the main item, @n
* else @c false
* @exception E_SUCCESS The method is successful.
*
* @return @c true if the main item is enabled, @n
* else @c false
- * @param[in] mainIndex The index of the main item to be checked
+ * @param[in] mainIndex The index of the main item to check
* @endif
*/
bool IsItemEnabled(int mainIndex) const;
* @deprecated This class is deprecated. Instead of using this class, use GroupedTableView class.
* @since 2.0
*
- * @param[in] text The text message to be displayed
+ * @param[in] text The text message to display
* @endif
*/
void SetTextOfEmptyList(const Tizen::Base::String& text);
* @deprecated This class is deprecated. Instead of using this class, use GroupedTableView class.
* @since 2.0
*
- * @param[in] color The color of the text to be displayed
+ * @param[in] color The color of the text to display
* @endif
*/
void SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
/**
* @file FUiCtrlICustomElement.h
- * @brief This is the header file for the %ICustomElement class.
+ * @brief This is the header file for the %ICustomElement interface.
*
* This header file contains the declarations of %ICustomElement and its helper classes.
*/
* Defines the value of status of the CustomList item.
*
* @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
*/
/**
* @interface IFormBackEventListener
- * @brief This interface implements the listener for Form related events.
+ * @brief This interface implements the listener for Form-related events.
*
* @since 2.0
*
// Operation
public:
/**
- * Called when the current %Form control needs to be closed to revert back to the previous %Form control.
+ * Called when the current Form control needs to be closed to revert back to the previous %Form control.
*
* @since 2.0
*
// See the License for the specific language governing permissions and
// limitations under the License.
//
-
/**
* @file FUiCtrlIFrameEventListener.h
* @brief This is the header file for the %IFrameEventListener interface.
* @return @c true if the item is deallocated by this method, @n
* else @c false
* @param[in] index The index of the item
- * @param[in] pItem The pointer to GalleryItem that is to be deleted
+ * @param[in] pItem The pointer to GalleryItem to delete
* @see CreateItem()
* @remarks An application that uses the Gallery control must implement this method. Using this method, an application can deallocate the item. If an
* application deallocates the item, this method returns @c true. This notifies the Gallery control to not release the item.
* @return @c true if the item is deallocated by this method, @n
* else @c false
* @param[in] groupIndex The index of the group
- * @param[in] pItem The pointer to GroupItem that is to be deleted
+ * @param[in] pItem The pointer to GroupItem to delete
* @param[in] itemWidth The width of the item
* @remarks An application that uses the %GroupedListView control must implement this method. @n
* Using this method, an application can deallocate the item. @n
* else @c false
* @param[in] groupIndex The index of the group
* @param[in] itemIndex The index of the item
- * @param[in] pItem The pointer to ListItemBase that is to be deleted
+ * @param[in] pItem The pointer to ListItemBase to delete
* @param[in] itemWidth The width of the item
* @remarks An application that uses the GroupedListView control must implement this method. @n
* Using this method, an application can deallocate the item. @n
* @brief This is the header file for the %IGroupedListViewItemProviderF interface.
*
* This header file contains the declarations of the %IGroupedListViewItemProviderF interface. @n
- * If an event is generated, a method of this class is called. @n
- * Therefore, if an application performs jobs related to the item events, it uses the methods of this class.
+ * If an event is generated, a method of this interface is called. @n
+ * Therefore, if an application performs jobs related to the item events, it uses the methods of this interface.
*
*/
#ifndef _FUI_CTRL_IGROUPED_LIST_VIEW_ITEM_PROVIDERF_H_
* @since 2.1
*
* The %IGroupedListViewItemProviderF interface is the interface for handling GroupedListView items.
- * The class that handles list items implements this interface, and the instance created using the GroupedListView's Construct()
- * method.
+ * The class that handles list items implements this interface, and the instance created using the GroupedListView::Construct() method.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_listviews.htm">ListViews</a>.
*/
* @return @c true if the item is deallocated by this method, @n
* else @c false
* @param[in] groupIndex The index of the group
- * @param[in] pItem The pointer to GroupItem that is to be deleted
+ * @param[in] pItem The pointer to GroupItem to delete
* @param[in] itemWidth The width of the item
* @remarks An application that uses the %GroupedListView control must implement this method. @n
* Using this method, an application can deallocate the item. @n
* else @c false
* @param[in] groupIndex The index of the group
* @param[in] itemIndex The index of the item
- * @param[in] pItem The pointer to ListItemBase that is to be deleted
+ * @param[in] pItem The pointer to ListItemBase to delete
* @param[in] itemWidth The width of the item
* @remarks An application that uses the GroupedListView control must implement this method. @n
* Using this method, an application can deallocate the item. @n
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index
* @param[in] pContextItem The context item which is opened or closed
- * @param[in] activated @c true if a context item is opened,@n
- * @c false, otherwise
+ * @param[in] activated @c true if a context item is opened, @n
+ * else @c false
*/
virtual void OnGroupedTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::GroupedTableView& tableView, int groupIndex, int itemIndex, Tizen::Ui::Controls::TableViewContextItem* pContextItem, bool activated) = 0;
* @return @c true if the group item is deallocated by this method,
* else @c false
* @param[in] groupIndex The index of the group
- * @param[in] pItem The pointer to TableViewGroupItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewGroupItem to delete
* @remarks An application that uses the GroupedTableView control must implement this method.
* Using this method, an application can deallocate the item.
* If an application deallocates the item, this method must return @c true. This notifies the %GroupedTableView control not to release the
* @since 2.0
*
* @param[in] groupIndex The group index
- * @param[in] pItem The pointer to TableViewGroupItem that is to be updated
+ * @param[in] pItem The pointer to TableViewGroupItem to update
* @remarks An application that uses the GroupedTableView control must implement this method.
* This method is called when the modification of an group item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
* else @c false
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the GroupedTableView control must implement this method.
* Using this method, an application can deallocate the item.
* If the application deallocates the item, this method must return @c true. This notifies the %GroupedTableView control not to release the
*
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the GroupedTableView control must implement this method.
- * This method is calle when the modification of an item is requested.
+ * This method is called when the modification of an item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
*/
virtual void UpdateItem(int groupIndex, int itemIndex, TableViewItem* pItem) = 0;
* @return @c true if the group item is deallocated by this method,
* else @c false
* @param[in] groupIndex The index of the group
- * @param[in] pItem The pointer to TableViewGroupItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewGroupItem to delete
* @remarks An application that uses the GroupedTableView control must implement this method.
* Using this method, an application can deallocate the item.
* If an application deallocates the item, this method must return @c true. This notifies the %GroupedTableView control not to release the
* @since 2.1
*
* @param[in] groupIndex The group index
- * @param[in] pItem The pointer to TableViewGroupItem that is to be updated
+ * @param[in] pItem The pointer to TableViewGroupItem to update
* @remarks An application that uses the GroupedTableView control must implement this method.
* This method is called when the modification of an group item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
* else @c false
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the GroupedTableView control must implement this method.
* Using this method, an application can deallocate the item.
* If the application deallocates the item, this method must return @c true. This notifies the %GroupedTableView control not to release the
*
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the GroupedTableView control must implement this method.
- * This method is calle when the modification of an item is requested.
+ * This method is called when the modification of an item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
*/
virtual void UpdateItem(int groupIndex, int itemIndex, TableViewItem* pItem) = 0;
}}} // Tizen::Ui::Controls
-#endif // _FUI_CTRL_IGROUPED_TABLE_VIEW_ITEM_PROVIDER_F_H_
+#endif // _FUI_CTRL_IGROUPED_TABLE_VIEW_ITEM_PROVIDER_F_H_
\ No newline at end of file
* else @c false
*
* @param[in] index The index of the item
- * @param[in] pItem The pointer to the item to be deleted
+ * @param[in] pItem The pointer to the item to delete
*
* @remark Applications which use IconListView must implement this method. In this method, the applications have the chance of deallocating the
* item. If the application deallocates the item, this method must return @c true, notifying the %IconListView not to free the item.
* @return @c true, if the item is deallocated by this method, @n
* else @c false
* @param[in] index The index of the item
- * @param[in] pItem The pointer to the item to be deleted
+ * @param[in] pItem The pointer to the item to delete
* @param[in] itemWidth The width of the item
* @remarks Applications which use ListView must implement this method. @n
* In this method, the applications have the chance of deallocating the item. @n
* @brief This is the header file for the %IListViewItemProviderF interface.
*
* This header file contains the declarations of the %IListViewItemProviderF interface. @n
- * If the event is generated, a method of this interface is called. @n
+ * If an 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.
*
*/
* @return @c true, if the item is deallocated by this method, @n
* else @c false
* @param[in] index The index of the item
- * @param[in] pItem The pointer to the item to be deleted
+ * @param[in] pItem The pointer to the item to delete
* @param[in] itemWidth The width of the item
* @remarks Applications which use ListView must implement this method. @n
* In this method, the applications have the chance of deallocating the item. @n
//
/**
- * @file FUiICtrlProgressPopupEventListener.h
+ * @file FUiCtrlIProgressPopupEventListener.h
* @brief This is the header file for the %IProgressPopupEventListener interface.
*
* This header file contains the declarations of the %IProgressPopupEventListener interface. @n
* implements this interface, and the instance created with that class is registered with a UI control, using the control's
* AddProgressPopupEventListener() method. When the ProgressPopup event occurs, the OnProgressPopupCanceled() method of that instance is invoked.
*
- * For more information on the class features, see in individual control topics under <a href="../com.osp.cppappprogramming.help/html/guide/ui/controls.htm">UI Controls</a>.
+ * For more information on the class features, see in individual control topics under <a href="../org.tizen.native.appprogramming/html/guide/ui/controls.htm">UI Controls</a>.
*/
class _OSP_EXPORT_ IProgressPopupEventListener
: virtual public Tizen::Base::Runtime::IEventListener
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
* @param[in] pContextItem The context item which is opened or closed
- * @param[in] activated @c true if a context item is opened,@n
- * @c false, otherwise
+ * @param[in] activated @c true if a context item is opened, @n
+ * else @c false
*/
virtual void OnSectionTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::SectionTableView& tableView, int sectionIndex, int itemIndex, Tizen::Ui::Controls::TableViewContextItem* pContextItem, bool activated) = 0;
* else @c false
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the SectionTableView control must implement this method.
* Using this method, an application can deallocate the item.
* If the application deallocates the item, this method must return true. This notifies the %SectionTableView control not to release the
*
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the SectionTableView control must implement this method.
- * This method is calle when the modification of an item is requested.
+ * This method is called when the modification of an item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
*/
virtual void UpdateItem(int sectionIndex, int itemIndex, TableViewItem* pItem) = 0;
*
* @since 2.0
*
- * @return @c true, if the section has an header @n
- * @c false, otherwise
+ * @return @c true if the section has an header, @n
+ * else @c false
* @param[in] sectionIndex The index of the section
* @remarks An application that uses the SectionTableView control must implement this method.
*/
*
* This header file contains the declarations of the %ISectionTableViewItemProviderF interface.
* If the event is generated, a method of this interface is called.
-* So, if applications do jobs related to item events, use the methods of this interface.
+* So, when applications do jobs related to item events, use the methods of this interface.
*
*/
#ifndef _FUI_CTRL_ISECTION_TABLE_VIEW_ITEM_PROVIDER_F_H_
virtual ~ISectionTableViewItemProviderF(void) {}
/**
- * Gets the total number of groups.
+ * Gets the total number of groups in the SectionTableView control.
*
* @since 2.1
*
virtual int GetSectionCount(void) = 0;
/**
- * Gets the total number of items in the specified group.
+ * Gets the total number of items in a specified group.
*
* @since 2.1
*
- * @return The total number of items in the specified group
+ * @return The total number of items in a specified group
* @param[in] sectionIndex The index of the section
* @remarks This method must be implemented so that it returns the total number of items for the specified section in the %SectionTableView control.
*/
* else @c false
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the SectionTableView control must implement this method.
* Using this method, an application can deallocate the item.
- * If the application deallocates the item, this method must return true. This notifies the %SectionTableView control not to release the
+ * If the application deallocates the item, this method must return @c true. This notifies the %SectionTableView control not to release the
* item. Otherwise, the item is deallocated by the %SectionTableView control.
* @see CreateItem()
*/
*
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the SectionTableView control must implement this method.
- * This method is calle when the modification of an item is requested.
- * The application can change @c pItem in this method, but should not keep @c pItem for later use.
+ * This method is called when the modification of an item is requested.
+ * The application can change @c pItem using this method, so the user should consider this when using @c pItem in future.
*/
virtual void UpdateItem(int sectionIndex, int itemIndex, TableViewItem* pItem) = 0;
*
* @since 2.1
*
- * @return The section header text of specified section
+ * @return The section header text of a specified section
* @param[in] sectionIndex The index of the group
* @remarks An application that uses the SectionTableView control must implement this method. @n
- * The header text will be aligned left
+ * The header text will be left aligned.
*/
virtual Tizen::Base::String GetSectionHeader(int sectionIndex) = 0;
/**
- * Returns whether the group has the section header or not.
+ * Checks whether the group has the section header or not.
*
* @since 2.1
*
- * @return @c true, if the section has an header @n
- * @c false, otherwise
+ * @return @c true if the section has a header, @n
+ * else @c false
* @param[in] sectionIndex The index of the section
* @remarks An application that uses the SectionTableView control must implement this method.
*/
* @return The footer text of specified section
* @param[in] sectionIndex The index of the section
* @remarks An application that uses the SectionTableView control must implement this method. @n
- * The footer text will be aligned right.
+ * The footer text will be right aligned.
*/
virtual Tizen::Base::String GetSectionFooter(int sectionIndex) = 0;
/**
- * Returns whether the section has the footer or not.
+ * Checks whether the section has the footer or not.
*
* @since 2.1
*
- * @return @c true, if the section has the footer @n
- * @c false,
+ * @return @c true, if the section has a footer @n
+ * @c else false
* @param[in] sectionIndex The index of the section
* @remarks An application that uses the SectionTableView control must implement this method.
*/
* @brief This is the header file for the %ISplitPanelEventListenerF interface.
*
* This header file contains the declarations of the %ISplitPanelEventListenerF interface. @n
- * If a change event is generated, a method of this class is called. @n
- * So, if the applications perform tasks related to change events, use the methods of this class.
+ * If a change event is generated, a method of this interface is called. @n
+ * So, if the applications perform tasks related to change events, use the methods of this interface.
*
*/
#ifndef _FUI_CTRL_ISPLIT_PANEL_EVENT_LISTENER_F_H_
/**
* @interface ISplitPanelEventListenerF
- * @brief This interface implements the listener for all splitpanel events.
+ * @brief This interface implements the listener for all split panel events.
*
* @since 2.1
*
- * The %ISplitPanelEventListenerF interface is the listener interface for receiving splitpanel events.
- * The class that processes a splitpanel event implements this interface, and the instance created with that class is registered with
- * a UI control, using the control's AddSplitPanelEventListener() method. When the splitpanel event occurs, a method of that instance is invoked.
+ * The %ISplitPanelEventListenerF interface is the listener interface for receiving split panel events.
+ * The class that processes a split panel event implements this interface, and the instance created with that class is registered with
+ * a UI control, using the SplitPanel::AddSplitPanelEventListener() method. When the split panel 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/implementing_splitpanel.htm">SplitPanel</a>.
*/
/**
*
- * Called when the divider moves.
+ * Called when a divider moves.
*
* @since 2.1
*
virtual void OnDividerPositionChanged(Tizen::Ui::Controls::SplitPanel& source, float position) = 0;
/**
- * Called when the divider is double pressed.
+ * Called when a divider is double pressed.
*
* @since 2.1
*
* @param[in] source The source of the event
- * @remark This method is invoked when an divider is double pressed.
+ * @remarks This method is invoked when a divider is double pressed.
*/
virtual void OnDividerDoublePressed(Tizen::Ui::Controls::SplitPanel& source) = 0;
* @param[in] tableView The source of the event
* @param[in] itemIndex The item index
* @param[in] pContextItem The context item which is opened or closed
- * @param[in] activated @c true if a context item is opened,@n
- * @c false, otherwise
+ * @param[in] activated @c true if a context item is opened, @n
+ * else @c false
*/
virtual void OnTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::TableView& tableView, int itemIndex, Tizen::Ui::Controls::TableViewContextItem* pContextItem, bool activated) = 0;
* @since 2.0
*
* @param[in] tableView The source of the event
- * @param[in] itemIndexFrom The start item index of the item
+ * @param[in] itemIndexFrom The start item index of the item
* @param[in] itemIndexTo The final item index of the item
*/
virtual void OnTableViewItemReordered(Tizen::Ui::Controls::TableView& tableView, int itemIndexFrom, int itemIndexTo) = 0;
* @return @c true if the item is deallocated by this method, @n
* else @c false
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the TableView control must implement this method.
* Using this method, an application can deallocate the item.
* If the application deallocates the item, this method must return @c true. This notifies the %TableView not to release the
* @since 2.0
*
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the TableView control must implement this method.
* This method is called when the modification of an item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
* @return @c true if the item is deallocated by this method, @n
* else @c false
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be deleted
+ * @param[in] pItem The pointer to TableViewItem to delete
* @remarks An application that uses the TableView control must implement this method.
* Using this method, an application can deallocate the item.
* If the application deallocates the item, this method must return @c true. This notifies the %TableView not to release the
* @since 2.1
*
* @param[in] itemIndex The item index
- * @param[in] pItem The pointer to TableViewItem that is to be updated
+ * @param[in] pItem The pointer to TableViewItem to update
* @remarks An application that uses the TableView control must implement this method.
* This method is called when the modification of an item is requested.
* The application can change @c pItem in this method, but should not keep @c pItem for later use.
* @deprecated This class is deprecated. Instead of using this class, use the IconListView class.
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @endif
*/
void AddItemEventListener(Tizen::Ui::IItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the IconListView class.
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @endif
*/
void RemoveItemEventListener(Tizen::Ui::IItemEventListener& listener);
*
* @return An error code
* @param[in] index The item text
- * @param[in] pText The text item to be added
+ * @param[in] pText The text item to add
* @param[in] pNormalBitmap The default bitmap image
* @param[in] pFocusedBitmap The displayed bitmap image when an item is selected
* @param[in] itemId The item ID
//
/**
* @file FUiCtrlIconListTypes.h
- * @brief This is the header file for the %IconList enumerations.
+ * @brief This is the header file for the enumerations of the IconList class.
*
- * This header file contains the declarations of the %IconList enumerations.
+ * This header file contains the declarations of the enumerations of the IconList class.
*
* These enumerations define the various properties of the %IconList control.
*/
* @if OSPDEPREC
* @enum IconListStyle
*
- * Defines the styles of %IconList.
+ * Defines the styles of IconList.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. Instead of using this enumeration, use the IconListViewStyle enumeration.
+ * @deprecated This enum is deprecated. Instead of using this enum, use the IconListViewStyle enumeration.
* @since 2.0
* @endif
*/
* Defines the check-box position.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. Instead of using this enumeration, use the IconListViewCheckBoxPosition enumeration.
+ * @deprecated This enum is deprecated. Instead of using this enum, use the IconListViewCheckBoxPosition enumeration.
* @since 2.0
* @endif
*/
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
*/
void AddIconListViewItemEventListener(IIconListViewItemEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
*/
void RemoveIconListViewItemEventListener(IIconListViewItemEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see IScrollEventListener::OnScrollEndReached()
* @see RemoveScrollEventListener()
*/
*
* @since 2.1
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see IScrollEventListenerF::OnScrollEndReached()
* @see RemoveScrollEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see IScrollEventListener::OnScrollEndReached()
* @see RemoveScrollEventListener()
*/
*
* @since 2.1
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see IScrollEventListenerF::OnScrollEndReached()
* @see RemoveScrollEventListener()
*/
* @since 2.0
*/
IconListView& operator =(const IconListView& rhs);
+
}; // IconListView
}}} // Tizen::Ui::Controls
#include <FUiITextEventListener.h>
#include <FUiWindow.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
*/
void AddTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
*/
void RemoveTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] text The text to be set
+ * @param[in] text The text to set
*/
void SetText(Tizen::Base::String text);
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddItemEventListener(Tizen::Ui::IItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveItemEventListener(Tizen::Ui::IItemEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the item is to be inserted
+ * @param[in] index The index at which the item is inserted
* @param[in] pText1 A pointer to the first string
* @param[in] pText2 A pointer to the second string
* @param[in] pBitmap1 A pointer to the first normal bitmap
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the contents of the item is to be set
+ * @param[in] index The index at which the contents of the item is set
* @param[in] pText1 A pointer to the first string
* @param[in] pText2 A pointer to the second string
* @param[in] pBitmap1 A pointer to the first normal bitmap
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the item is to be deleted
+ * @param[in] index The index at which the item is deleted
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than or equal to the item count.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the list item for which status is to be set
+ * @param[in] index The index of the list item for which status is set
* @param[in] enable Set to @c true to enable the item, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] text The text message to be displayed
+ * @param[in] text The text message to display
* @endif
*/
void SetTextOfEmptyList(const Tizen::Base::String& text);
* Defines the list style.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. Instead of using this enumeration, use ListAnnexStyle enumeration for CustomItem or SimpleItem class. @n
+ * @deprecated This enum is deprecated. Instead of using this enum, use ListAnnexStyle enumeration for CustomItem or SimpleItem class. @n
* @since 2.0
* @endif
*/
* Defines the list item format.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. There is no need to use this enumeration. @n
+ * @deprecated This enum is deprecated. There is no need to use this enum.
* @since 2.0
* @endif
*/
* Defines the option of text slide.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. There is no need to use this enumeration. @n
+ * @deprecated This enum is deprecated. There is no need to use this enum.
* @since 2.0
* @endif
*/
* Defines the number of digits or characters of the fast scroll index.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enumeration is deprecated. There is no need to use this enumeration. @n
+ * @deprecated This enum is deprecated. There is no need to use this enum.
* @since 2.0
* @endif
*/
*
* @return An error code
* @param[in] index The item index
- * @param[in] type The item to be added, removed, or modified
+ * @param[in] type The item to add, remove, or modify
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
* @since 2.0
*
* @return An error code
- * @param[in] title The title string to be set
- * @param[in] text The text string to be set
+ * @param[in] title The title string to set
+ * @param[in] text The text string to set
* @param[in] style The style of the %MessageBox control
* @param[in] timeout The duration of the timeout in milliseconds
* @exception E_SUCCESS The method is successful.
*
* @since 2.0
*
- * @param[in] color The color to be set
+ * @param[in] color The color to set
*/
void SetColor(const Tizen::Graphics::Color& color);
*
* @since 2.0
*
- * @return The color to be set
+ * @return The color to set
*/
Tizen::Graphics::Color GetColor(void) const;
*
* @since 2.0
*
- * @param[in] color The title text color to be set
+ * @param[in] color The title text color to set
*/
void SetTitleTextColor(const Tizen::Graphics::Color& color);
*
* @since 2.0
*
- * @param[in] color The text color to be set
+ * @param[in] color The text color to set
*/
void SetTextColor(const Tizen::Graphics::Color& color);
* @deprecated This class is deprecated because the use of the %OptionMenu control is no longer recommended.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @deprecated This class is deprecated because the use of the %OptionMenu control is no longer recommended.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] text The item to be appended
+ * @param[in] text The item to append
* @param[in] actionId The action ID
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM This method has failed.
*
* @return An error code
* @param[in] mainIndex The main index
- * @param[in] text The item to be set
+ * @param[in] text The item to set
* @param[in] actionId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than @c 12.
*
* @return An error code
* @param[in] mainIndex The main index
- * @param[in] text The string of the item to be set
+ * @param[in] text The string of the item to set
* @param[in] actionId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than @c 12.
*
* @return An error code
* @param[in] mainIndex The index of the main item
- * @param[in] text The string of item to be appended
+ * @param[in] text The string of item to append
* @param[in] actionId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than @c 12.
* @return An error code
* @param[in] mainIndex The index of the main item
* @param[in] subIndex The index of the sub-item
- * @param[in] text The string of the item to be set
+ * @param[in] text The string of the item to set
* @param[in] actionId The action ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than @c 12.
* @return An error code
* @param[in] mainIndex The index of the main item
* @param[in] subIndex The index of the sub-item
- * @param[in] text The string of the item to be set
+ * @param[in] text The string of the item to set
* @param[in] actionId The action ID
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is less than @c 0 or greater than @c 12.
* @since 2.0
*
* @return An error code
- * @param[in] title The title to be set
+ * @param[in] title The title to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
* @since 2.0
*
* @return An error code
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
* @since 2.0
*
* @return An error code
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method ignores the alpha value of the @c color parameter and sets the alpha value to @c 255.
* @return An error code
* @param[in] cancelButton Set to @c true if the %ProgressPopup window has a cancel button, @n
* else @c false
- * @param[in] transparent Set to @c true if the %ProgressPopup window is transparent, @n
+ * @param[in] translucent Set to @c true if the %ProgressPopup window is translucent, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred. @n
* Use SetTitleText() and SetText() to show the title area and the body text.
* @remarks If @c transparent is set to true, a progress icon is only shown and a cancel button is not shown. @n
* Also, the texts set by SetTitleText() and SetText() are not shown.
- * @remarks If @c cancelButton is set to true and ProgressPopup is closed by pressing a Cancel Button,
- * out parameter of DoModal(), modalResult, is -1.
+ * @remarks If the specified @c cancelButton is set to true and ProgressPopup is closed by pressing a Cancel Button,
+ * out parameter of DoModal(), modalResult, is @c -1.
*/
result Construct(bool cancelButton, bool transparent);
*
* @since 2.0
* @return An error code
- * @param[in] text The text to be set
+ * @param[in] text The text to set
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks If the %ProgressPopup window is constructed as transparent, the text is not shown.
*
* @since 2.0
* @return An error code
- * @param[in] listener The event listener to be added. Listener should be allocated at heap, not stack.
+ * @param[in] listener The event listener to add @n Listener should be allocated at heap, not stack.
* @exception E_SUCCESS This method was successful.
* @exception E_OBJ_ALREADY_EXIST The listener was already exist.
*/
*
* @since 2.0
* @return An error code
- * @param[in] listener The event listener to be removed. @n
+ * @param[in] listener The event listener to remove @n
* Listener should be referring to previously allocated instance which is passed as an argument to AddProgressPopupEventListener.
* @exception E_SUCCESS This method was successful.
* @exception E_OBJ_NOT_FOUND The listener was not found.
/**
* @enum ScrollEndEvent
*
- * Defines constants which represent the type of scroll end event.
+ * Defines constants that represent the type of scroll end event.
*
* @since 2.0
*/
/**
* @file FUiCtrlScrollPanelTypes.h
- * @brief This is the header file for the ScrollPanel enumeration.
+ * @brief This is the header file for the enumerations of the ScrollPanel class.
*
- * The ScrollPanel enumeration defines the data types for the ScrollPanel.
+ * This header file defines the data types for the ScrollPanel class.
*/
#ifndef _FUI_CTRL_SCROLL_PANEL_TYPES_H_
#define _FUI_CTRL_SCROLL_PANEL_TYPES_H_
/**
* @enum ScrollInputMode
*
-* Defines the scroll interaction mode
+* Defines the scroll interaction mode.
*
* @since 2.0
*/
enum ScrollInputMode
{
- SCROLL_INPUT_MODE_ALLOW_ANY_DIRECTION = 0, /**< Scroll interaction is available to any direction. */
- SCROLL_INPUT_MODE_RESTRICT_TO_INITIAL_DIRECTION /**< Scroll interaction is restricted to first direction. */
+ SCROLL_INPUT_MODE_ALLOW_ANY_DIRECTION = 0, /**< Content can be scrolled in any direction */
+ SCROLL_INPUT_MODE_RESTRICT_TO_INITIAL_DIRECTION /**< Content can be scrolled only in the first direction */
};
}}} // Tizen::Ui::Controls
* For more information, see @ref CompSetContentPage "here"
* @endif
* @return An error code
- * @param[in] pContent The control that is to be displayed in the content area of the search bar
+ * @param[in] pContent The control to display in the content area of the search bar
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The following controls cannot be set as the content: @n
*
* @return An error code
* @param[in] status The button status
- * @param[in] color The button color to be set
+ * @param[in] color The button color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @see GetButtonColor()
* @since 2.0
*
* @return An error code
- * @param[in] character The character to be added
+ * @param[in] character The character to add
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method modifies the text buffer that is managed by the %SearchBar control. @n
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
+ * @param[in] text The text to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks To denote the end of a line use '\\n'. @n
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be displayed
+ * @param[in] text The text to display
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks To denote the end of a line use '\\n'. @n
*
* @return An error code
* @param[in] index The position to insert the character
- * @param[in] character The character to be inserted
+ * @param[in] character The character to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* The specified @c index is greater than the number of elements or less than @c 0.
*
* @return An error code
* @param[in] index The position at which to insert
- * @param[in] text The text to be inserted
+ * @param[in] text The text to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* The specified @c index is greater than the number of elements or less than @c 0.
* @since 2.0
*
* @return An error code
- * @param[in] limitLength The limit text length to be set
+ * @param[in] limitLength The limit text length to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid, or @n
* the specified limit length cannot be @c 0 or negative.
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveActionEventListener()
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddActionEventListener()
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks The added listener is notified when: @n
* @li The user presses a key on the software keypad.
* @li The user selects a word in the candidate list.
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextEventListener()
*/
void RemoveTextEventListener(Tizen::Ui::ITextEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks The added listener is notified when: @n
* @li The user presses a key on the software keypad.
* @li The user selects a word in the candidate list.
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see RemoveTextEventListener()
*/
void RemoveSearchBarEventListener(ISearchBarEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks Programmatically, modification of the text selection does not cause the text block selection event to fire.
* @see RemoveTextBlockEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextBlockEventListener()
*/
void RemoveTextBlockEventListener(Tizen::Ui::ITextBlockEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveKeypadEventListener()
*/
void AddKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddKeypadEventListener()
*/
void RemoveKeypadEventListener(Tizen::Ui::IKeypadEventListener& listener);
/**
* Updates the specified item. @n
- * For instance, TABLE_VIEW_REFRESH_TYPE_ITEM_ADD is used when a new item needs to be added and TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE is used when an item is deleted from the
- * table view. Moreover, TABLE_VIEW_REFRESH_TYPE_ITEM_MODIFY is used when the content of an existing item has changed and it needs to be updated.
- * Note that calling this method with TABLE_VIEW_REFRESH_TYPE_ITEM_MODIFY invokes item provider's UpdateItem() for the given index in sequence.
+ * For instance, @c TABLE_VIEW_REFRESH_TYPE_ITEM_ADD is used when a new item needs to be added and @c TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE is used when an item is deleted from the
+ * table view. Moreover, @c TABLE_VIEW_REFRESH_TYPE_ITEM_MODIFY is used when the content of an existing item has changed and it needs to be updated.
+ * Note that calling this method with @c TABLE_VIEW_REFRESH_TYPE_ITEM_MODIFY invokes item provider's UpdateItem() for the given index in sequence.
*
* @since 2.0
*
* @return An error code
* @param[in] sectionIndex The section index
* @param[in] itemIndex The item index
- * @param[in] type The item to be added, removed, or modified
+ * @param[in] type The item to add, remove, or modify
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
* @remarks If the specified item. itemIndex is -1, then the method is applied to the section item with the given index.
- * Note that if TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE option is used to a section item, all the items in the section (including the section item itself) are
- * removed from the table view. @n
- * This method does not work during the ITableViewItemProvider call-back procedure.
+ * Note that if @c TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE option is used to a section item, all the items in the section (including the section item itself) are
+ * removed from the table view. @n
+ * This method does not work during the ITableViewItemProvider call-back procedure.
*/
result RefreshItem(int sectionIndex, int itemIndex, TableViewRefreshType type);
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c pixel is out of range.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
- * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
+ * @remarks If you call %ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
* Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
* This method does not work during the ITableViewItemProvider call-back procedure.
*/
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c pixel is out of range.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
- * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
+ * @remarks If you call %ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
* Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
* This method does not work during the ITableViewItemProvider call-back procedure.
*/
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddSlidableGroupedListEventListener(Tizen::Ui::ISlidableGroupedListEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveSlidableGroupedListEventListener(Tizen::Ui::ISlidableGroupedListEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveFastScrollEventListener(Tizen::Ui::IFastScrollEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveGroupedItemEventListener(Tizen::Ui::IGroupedItemEventListener& listener);
*
* @return An error code
* @param[in] groupIndex The group index
- * @param[in] text The string of the group to be appended
+ * @param[in] text The string of the group to append
* @param[in] pBackgroundBitmap The bitmap of the group
* @param[in] groupId The group ID
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param[in] groupIndex The group index of the item to be checked
- * @param[in] itemIndex The index of the item to be checked
+ * @param[in] groupIndex The group index of the item to check
+ * @param[in] itemIndex The index of the item to check
* @param[in] check Set to @c true to check the item, @n
* else @c false to uncheck it
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param[in] groupIndex The group index of the item to be checked
- * @param[in] itemIndex The index of the item to be checked
+ * @param[in] groupIndex The group index of the item to check
+ * @param[in] itemIndex The index of the item to check
* @param[in] enable Set to @c true to enable the item, @n
* else @c false to disable it
* @exception E_SUCCESS The method is successful.
* @since 2.0
*
* @return An error code
- * @param[in] height The height of the item to be deleted
+ * @param[in] height The height of the item to delete
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The removed list items are deleted from the memory.
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] color The color of the text to be displayed
+ * @param[in] color The color of the text to display
* @endif
*/
void SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddFastScrollEventListener(Tizen::Ui::IFastScrollEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] text The string of the group to be appended
+ * @param[in] text The string of the group to append
* @param[in] pBackgroundBitmap The background bitmap of the group
* @param[in] itemCount The number of items of the group
* @param[in] groupHeight The total height of the items of the group
* @deprecated This class is deprecated. Instead of using this class, use the %GroupedListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddGroupedItemEventListener(Tizen::Ui::IGroupedItemEventListener& listener);
*
* @return An error code
* @param[in] groupIndex The group index
- * @param[in] text The string of the group to be appended
+ * @param[in] text The string of the group to append
* @param[in] pBackgroundBitmap The background bitmap of the group
* @param[in] itemCount The count of all the items in the group
* @param[in] groupHeight The total height of all the items in the group
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddSlidableListEventListener(Tizen::Ui::ISlidableListEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveSlidableListEventListener(Tizen::Ui::ISlidableListEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddCustomItemEventListener(Tizen::Ui::ICustomItemEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] item The CustomListItem to be added
+ * @param[in] item The CustomListItem to add
* @param[in] itemId The item ID
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] index The item index at which to insert the item
- * @param[in] item The CustomListItem to be inserted
+ * @param[in] item The CustomListItem instance to insert
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c index is less than @c 0 or greater than the item count.
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveCustomItemEventListener(Tizen::Ui::ICustomItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use the ListView class.
* @since 2.0
*
- * @param[in] color The color of the text to be displayed
+ * @param[in] color The color of the text to display
* @endif
*/
void SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
* @since 2.0
*
* @return An error code
- * @param[in] item The %CustomListItem to be loaded
+ * @param[in] item The CustomListItem instance to load
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @since 2.0
*
* @return An error code
- * @param[in] item The CustomListItem to be loaded
+ * @param[in] item The CustomListItem instance to load
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*
* @return An error code
* @param[in] index The item index
- * @param[in] item The CustomListItem to be set
+ * @param[in] item The CustomListItem instance to set
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c index is less than @c 0 or greater than or equal to the item count.
* @since 2.0
*
* @return An error code
- * @param[in] index The item index to be deleted
- * @param[in] itemHeight The height of the item to be deleted
+ * @param[in] index The item index to delete
+ * @param[in] itemHeight The height of the item to delete
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The removed list item is deleted from the memory.
* @since 2.0
*
* @return An error code
- * @param[in] itemHeight The height of the item to be deleted
+ * @param[in] itemHeight The height of the item to delete
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The removed list items are deleted from the memory.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The background style of BACKGROUND_STYLE_NONE does not work with group styles except GROUP_STYLE_NONE.
+ * The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except @c GROUP_STYLE_NONE.
* @exception E_OUT_OF_RANGE The specified values are less than @c -99 or greater than @c 999.
* @exception E_SYSTEM A system error has occurred.
* @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if used earlier. @n
- * If the given size is less than the minimum, it returns E_INVALID_ARG.
+ * If the given size is less than the minimum, it returns @c E_INVALID_ARG.
* @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, BackgroundStyle backgroundStyle = BACKGROUND_STYLE_DEFAULT, bool showTitle = false, int minValue = 0, int maxValue = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The background style of BACKGROUND_STYLE_NONE does not work with group styles except GROUP_STYLE_NONE.
+ * The background style of @c BACKGROUND_STYLE_NONE does not work with group styles except @c GROUP_STYLE_NONE.
* @exception E_OUT_OF_RANGE The specified values are less than @c -99 or greater than @c 999.
* @exception E_SYSTEM A system error has occurred.
* @remarks A control is fully usable only after it has been added to a container. Therefore, some methods may fail if used earlier. @n
- * If the given size is less than the minimum, it returns E_INVALID_ARG.
+ * If the given size is less than the minimum, it returns @c E_INVALID_ARG.
* @remarks The size of the control must be within the range defined by the minimum size and the maximum size.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, BackgroundStyle backgroundStyle = BACKGROUND_STYLE_DEFAULT, bool showTitle = false, int minValue = 0, int maxValue = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
*/
void AddAdjustmentEventListener(Tizen::Ui::IAdjustmentEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
*/
void RemoveAdjustmentEventListener(Tizen::Ui::IAdjustmentEventListener& listener);
*
* @since 2.0
*
- * @param[in] position The position of the icon (ICON_POSITION_LEFT/ICON_POSITION_RIGHT)
+ * @param[in] position The position of the icon (@c ICON_POSITION_LEFT/@c ICON_POSITION_RIGHT)
* @param[in] icon The bitmap image of the icon
* @remarks If the size of the bitmap is greater than the default size, the bitmap image is scaled down.
*/
* @since 2.0
*
* @return An error code
- * @param[in] title The title to be set
+ * @param[in] title The title to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
*
* @since 2.0
*
- * @param[in] color The title text color to be set
+ * @param[in] color The title text color to set
*/
void SetTitleTextColor(const Tizen::Graphics::Color& color);
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
*/
void AddSliderEventListener(ISliderEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
*/
void RemoveSliderEventListener(ISliderEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method ignores the alpha value of the @c color parameter and sets the alpha value to @c 255.
* @since 2.0
*
* @return An error code
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The operation is not supported if the background style of the %Slider control is BACKGROUND_STYLE_NONE.
+ * The operation is not supported if the background style of the %Slider control is @c BACKGROUND_STYLE_NONE.
* @exception E_SYSTEM A system error has occurred.
* @remarks If a device supports only the 16-bit color space, this method considers the color as opaque by ignoring the alpha value of @c color.
*/
* @since 2.0
*
* @return The color , @n
- * else RGBA(0, 0, 0, 0) if an instance is invalid or the background style is BACKGROUND_STYLE_NONE
+ * else RGBA(0, 0, 0, 0) if an instance is invalid or the background style is @c BACKGROUND_STYLE_NONE
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The background style is not proper.
* @remarks The specific error code can be accessed using the GetLastResult() method.
/**
* @file FUiCtrlSliderTypes.h
- * @brief This is the header file for the SliderStyle enumerations.
+ * @brief This is the header file for the enumerations of the Slider class.
*
- * This header files contains the declarations of the SliderStyle enumeration.
+ * This header files contains the declarations of the enumerations of the Slider class.
*
*/
#ifndef _FUI_CTRL_SLIDER_TYPES_H_
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The event listener already exists.
*/
*
* @since 2.1
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The event listener already exists.
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The event listener is not found.
*/
*
* @since 2.1
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The event listener is not found.
*/
* @since 2.0
*
* @return An error code
- * @param[in] pControl The control to be set.
+ * @param[in] pControl The control to set
* @param[in] paneOrder The order of pane. SPLIT_PANEL_PANE_FIRST is displayed on the left side @n
* and SPLIT_PANEL_PANE_SECOND is displayed on the right side of the %SplitPanel when its direction is SPLIT_PANEL_DIVIDER_DIRECTION_VERTICAL.
* @exception E_SUCCESS The method is successful.
/**
* @file FUiCtrlSplitPanelTypes.h
- * @brief This is the header file for the %SplitPanel enumerations.
+ * @brief This is the header file for the enumerations of the SplitPanel class.
*
- * This header file contains the declarations of the %SplitPanel enumerations.
+ * This header file contains the declarations of the enumerations of the SplitPanel class.
*
*/
#ifndef _FUI_CTRL_SPLIT_PANEL_TYPES_H_
/**
* @enum SplitPanelDividerStyle
*
- * Defines the divider style of the %SplitPanel control.
+ * Defines the divider style of the SplitPanel control.
*
* @since 2.0
*/
/**
* @enum SplitPanelDividerDirection
*
- * Defines the divider direction of the %SplitPanel control.
+ * Defines the divider direction of the SplitPanel control.
*
* @since 2.0
*/
/**
* @enum SplitPanelPaneOrder
*
- * Defines the pane order of the %SplitPanel control.
+ * Defines the pane order of the SplitPanel control.
*
* @since 2.0
*/
enum SplitPanelPaneOrder
{
- SPLIT_PANEL_PANE_ORDER_FIRST,
- SPLIT_PANEL_PANE_ORDER_SECOND
+ SPLIT_PANEL_PANE_ORDER_FIRST, /**< The panel located on the left side or upper side */
+ SPLIT_PANEL_PANE_ORDER_SECOND /**< The panel located on the right side or down side */
};
}}} // Tizen::Ui::Controls
* @deprecated This class is deprecated because the use of the %Tab control is no longer recommended.
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @endif
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @deprecated This class is deprecated because the use of the %Tab control is no longer recommended.
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @endif
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @deprecated This class is deprecated because the use of the %Tab control is no longer recommended.
* @since 2.0
*
- * @param[in] textColor The color to be set
+ * @param[in] textColor The color to set
* @endif
*/
void SetTextColor(const Tizen::Graphics::Color& textColor);
* @deprecated This class is deprecated because the use of the %Tab control is no longer recommended.
* @since 2.0
*
- * @param[in] textColor The color to be set
+ * @param[in] textColor The color to set
* @endif
*/
void SetSelectedTextColor(const Tizen::Graphics::Color& textColor);
* @deprecated This class is deprecated because the use of the %Tab control is no longer recommended.
* @since 2.0
*
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @remarks When a user navigates the user interface using the directional keys, the focused UI control is highlighted.
* @endif
*/
virtual void OnActionPerformed(const Tizen::Ui::Control& source, int actionId);
private:
- static const int ID_TABBAR_ITEM1 = 100;
- static const int ID_TABBAR_ITEM2 = 101;
- static const int ID_TABBAR_ITEM3 = 102;
+ static const int ID_TABBAR_ITEM1 = 100;
+ static const int ID_TABBAR_ITEM2 = 101;
+ static const int ID_TABBAR_ITEM3 = 102;
Tizen::Ui::Controls::TabBar *__pTabBar;
};
* @since 2.0
*
* @return An error code
- * @param[in] item The item to be added
+ * @param[in] item The item to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid. @n
* The specified @c item is not constructed.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the item to be inserted
- * @param[in] item The item to be inserted
+ * @param[in] index The index of the item to insert
+ * @param[in] item The item to insert
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The specified @c item is not constructed.
*
* @return An error code
* @param[in] index The index at which to set the specified item
- * @param[in] item The item to be set
+ * @param[in] item The item to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid. @n
* The specified @c item is not constructed.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the item to be selected
+ * @param[in] index The index of the item to select
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is not within the range of the data structure. @n
* The specified @c index is either greater than or equal to the number of items or is less than @c 0.
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be set
+ * @param[in] text The text to set
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state.
* @remarks If the size of the text exceeds the displayable area, the font size of the text is decreased automatically.
* @since 2.0
*
* @return An error code
- * @param[in] itemIndex The item index to be checked
+ * @param[in] itemIndex The item index to check
* @param[in] check Set to @c true to select the item, @n
* else @c false
* @exception E_SUCCESS The method is successful.
*
* @return An error code
* @param[in] itemIndex The item index
- * @param[in] type The item to be added, removed, or modified
+ * @param[in] type The item to add, remove, or modify
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
* @since 2.0
*
* @return An error code
- * @param[in] pControl The child control to be selected individually.
+ * @param[in] pControl The child control to select individually
* @param[in] enable Set to @c true to enable the individual selection of a control, else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @since 2.0
*
* @return An error code
- * @param[in] text The text string to be added
- * @param[in] pBitmap The bitmap image to be displayed
+ * @param[in] text The text string to add
+ * @param[in] pBitmap The bitmap image to display
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
*/
* @since 2.0
*
* @return An error code
- * @param[in] text The text string to be added
- * @param[in] pBitmap The bitmap image to be displayed
+ * @param[in] text The text string to add
+ * @param[in] pBitmap The bitmap image to display
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @see RemoveUiLinkEventListener()
*/
void AddUiLinkEventListener(Tizen::Ui::IUiLinkEventListener& listener);
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddUiLinkEventListener()
*/
void RemoveUiLinkEventListener(Tizen::Ui::IUiLinkEventListener& listener);
* @since 2.0
*
* @return An error code
- * @param[in] character The character to be added
+ * @param[in] character The character to add
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The method modifies the text buffer that is managed by the %TextBox control. @n
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be appended
+ * @param[in] text The text to append
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks To denote the end of a line use '\\n'. @n
*
* @return An error code
* @param[in] index The position at which to insert the character
- * @param[in] character The character to be inserted
+ * @param[in] character The character to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* The specified @c index is greater than the number of elements or less than @c 0.
*
* @return An error code
* @param[in] index The position at which to insert the text
- * @param[in] text The text to be inserted
+ * @param[in] text The text to insert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
* The specified @c index is greater than the number of elements or less than @c 0.
* @since 2.0
*
* @return An error code
- * @param[in] text The text to be displayed
+ * @param[in] text The text to display
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks To denote the end of a line use '\\n'. @n
*
* @return An error code
* @param[in] status The state of the %TextBox control
- * @param[in] color The color to be set
+ * @param[in] color The color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @see GetColor()
*
* @return An error code
* @param[in] type The text color type
- * @param[in] color The text color to be set
+ * @param[in] color The text color to set
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @see GetTextColor()
*
* @since 2.0
*
- * @param[in] listener The event listener to be added
+ * @param[in] listener The event listener to add
* @remarks Programmatically modifying the text selection does not cause the text block selection event to fire.
* @see RemoveTextBlockEventListener()
*/
*
* @since 2.0
*
- * @param[in] listener The event listener to be removed
+ * @param[in] listener The event listener to remove
* @see AddTextBlockEventListener()
*/
void RemoveTextBlockEventListener(Tizen::Ui::ITextBlockEventListener& listener);
#include <FUiWindow.h>
#include <FUiITimeChangeEventListener.h>
-namespace Tizen { namespace Ui { namespace Controls
+namespace Tizen { namespace Ui { namespace Controls
{
/**
{
result r = E_SUCCESS;
- // Createa an instance of Button
+ // Creates an instance of Button
Button* pButton = new Button();
pButton->Construct(Rectangle(50, 50, 300, 200), L"Show TimePicker");
pButton->SetActionId(ID_BUTTON);
pButton->AddActionEventListener(*this);
- // Adda a Button to the Form
+ // Adds a Button to the Form
AddControl(*pButton);
- // Creates an instanceo of TimePicker
+ // Creates an instance of TimePicker
__pTimePicker = new TimePicker();
__pTimePicker->Construct();
- // Adds an instanceo of ITimeChangeEventListener
+ // Adds an instance of ITimeChangeEventListener
__pTimePicker->AddTimeChangeEventListener(*this);
// Show TimePicker after it's owner Form is shown.
*
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @see ITimeChangeEventListener::OnTimeChanged()
* @see ITimeChangeEventListener::OnTimeChangeCanceled()
* @see RemoveTimeChangeEventListener()
*
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @see AddTimeChangeEventListener()
*/
void RemoveTimeChangeEventListener(Tizen::Ui::ITimeChangeEventListener& listener);
*
* @since 2.0
*
- * @param[in] time The time to be set
+ * @param[in] time The time to set
*/
void SetTime(const Tizen::Base::DateTime& time);
projects / platform / framework / native / uifw.git / commitdiff