*
* The %EditArea class displays a multi-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>.
+ * 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>.
*
* The following example demonstrates how to use the %EditArea class.
*
// Lifecycle
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
EditArea(void);
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required.@n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* The specified @c limitLength is less than or equal to @c 0. @n
* The @c rect.width or the @c rect.height is less than 0.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Some methods of the control will only work as expected when it becomes 'displayable'.
- * For more information, see Control::IsDisplayable() @n
- * The orientation of the full-screen style keypad is determined by the current device orientation.
+ * @remarks
+ * - Some methods of the control will only work as expected when it becomes 'displayable'.
+ * For more information, see Control::IsDisplayable().
+ * - The orientation of the full-screen style keypad is determined by the current device orientation.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, int limitLength = 1000);
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
* the width and height of the control.
* @param[in] inputStyle Determines whether the fullscreen keypad or overlay keypad is displayed
* The specified @c limitLength is less than or equal to @c 0. @n
* The @c rect.width or the @c rect.height is less than 0.
* @exception E_SYSTEM A system error has occurred.
- * @remarks Some methods of the control will only work as expected when it becomes 'displayable'.
- * For more information, see Control::IsDisplayable() @n
- * The orientation of the full-screen style keypad is determined by the current device orientation.
+ * @remarks
+ * - Some methods of the control will only work as expected when it becomes 'displayable'.
+ * For more information, see Control::IsDisplayable().
+ * - The orientation of the full-screen style keypad is determined by the current device orientation.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, int limitLength = 1000);
*
* @return An error code
* @param[in] autoLinks The auto-link mask @n
- * Multiple link types can be combined using bitwise OR (see Tizen::Base::Utility::LinkType). @n
- *
For more information, see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>.
+ * Multiple link types can be combined using bitwise OR. @n For more information,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>.
* @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 input style is not INPUT_STYLE_OVERLAY.
+ * The operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks When @c autoLinks is set to zero, the auto-link detection is disabled.
* @see Tizen::Base::Utility::LinkType
* @return The auto-link mask
* @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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAutoLinkMask()
*/
unsigned long GetAutoLinkMask(void) const;
* @since 2.0
*
* @param[in] listener The event listener to add
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.@n
+ * @remarks This method is supported when the input style is ::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 remove
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported when the input style is ::INPUT_STYLE_OVERLAY.
* @see AddUiLinkEventListener()
*/
void RemoveUiLinkEventListener(Tizen::Ui::IUiLinkEventListener& listener);
* @return The line spacing, @n
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetLineSpacing()
*/
int GetLineSpacing(void) const;
* @return The line spacing, @n
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetLineSpacing()
*/
float GetLineSpacingF(void) const;
* @param[in] marginType The margin type
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetMargin()
*/
int GetMargin(EditMarginType marginType) const;
* @param[in] marginType The margin type
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetMargin()
*/
float GetMarginF(EditMarginType marginType) const;
* @return The keypad action
* @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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Ui::KeypadAction GetKeypadAction(void) const;
* @param[in] keypadAction The keypad action
* @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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks Depending on the value of @c keypadAction specified, the enter key label of the keypad will change accordingly.
*/
* 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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
*/
result SetOverlayKeypadCommandButtonVisible(bool visible);
* 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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
bool IsOverlayCommandButtonVisible(void) const;
* @return An error code
* @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
- * This operation is not supported if the input style is not INPUT_STYLE_OVERLAY.
+ * This operation is not supported if the input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @see ShowKeypad()
*/
* @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure. @n
* The index is greater than the number of elements or less than @c 0.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult()() method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetText()
*/
Tizen::Base::String GetText(int start, int end) const;
* @since 2.0
*
* @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
+ * @remarks
+ * - To listen to scroll panel events, the parent of the %EditArea control must be an instance of ScrollPanel.
+ * - 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.
* @see RemoveScrollPanelEventListener()
*/
*
* @return An error code
* @param[in] categories The categories to set @n
- * Multiple input categories can be combined using bitwise OR (see Tizen::Ui::Controls::EditInputModeCategory).
+ * Multiple input categories can be combined using bitwise OR.
* @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
* The specified @c categories cannot be supported with the current keypad style.
* @exception E_SYSTEM A system error has occurred.
+ * @see EditInputModeCategory
* @endif
*/
result SetInputModeCategory(unsigned long categories, bool enable);
* @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.
* @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
- * To display the changes, the control must be drawn again. The text to be inserted will be displayed by @c textImage.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %EditArea control.
+ * - To display the changes, the control must be drawn again. The text to be inserted will be displayed by @c textImage.
*/
result InsertTextAt(int position, const Tizen::Base::String& text, const Tizen::Graphics::Bitmap& textImage);
* @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
- * To display the changes, the control must be drawn again. The text to be appended will be displayed by @c textImage.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %EditArea control.
+ * - To display the changes, the control must be drawn again. The text to be appended will be displayed by @c textImage.
*/
result AppendText(const Tizen::Base::String& text, const Tizen::Graphics::Bitmap& textImage);
* @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.
- * @remarks This method is supported only when the input style is INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported only when the input style is ::INPUT_STYLE_OVERLAY.
*/
result ShowKeypad(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Cut(), Paste(), Remove()
+ * @see Cut()
+ * @see Paste()
+ * @see Remove()
*/
result Copy(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Remove(), Paste()
+ * @see Copy()
+ * @see Remove()
+ * @see Paste()
*/
result Cut(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Cut(), Remove()
+ * @see Copy()
+ * @see Cut()
+ * @see Remove()
*/
result Paste(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Cut(), Paste()
+ * @see Copy()
+ * @see Cut()
+ * @see Paste()
*/
result Remove(void);
* @return @c true if the text has been clipped, @n
* else @c false
* @remarks 'Clipped' means that the text has been copied to the clipboard.
- * @see Copy(), Cut(), Paste(), Remove()
+ * @see Copy()
+ * @see Cut()
+ * @see Paste()
+ * @see Remove()
*/
bool IsClipped(void) const;
* @param[in] actionId The action ID
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported when the input style is ::INPUT_STYLE_OVERLAY.
*/
result SetOverlayKeypadCommandButton(CommandButtonPosition position, const Tizen::Base::String& text, int actionId);
*
* @return The text of the specified command button
* @param[in] position The position of the command button
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported when the input style is ::INPUT_STYLE_OVERLAY.
*/
Tizen::Base::String GetOverlayKeypadCommandButtonText(CommandButtonPosition position) const;
*
* @return The action ID of the specified command button
* @param[in] position The position of the command button
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported when the input style is ::INPUT_STYLE_OVERLAY.
*/
int GetOverlayKeypadCommandButtonActionId(CommandButtonPosition position) const;
* @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
- * This method only works if the language to set is supported by the current preloaded keypad.
+ * @remarks
+ * - The application can set the language of the current keypad that is associated with the current %EditArea.
+ * - This method only works if the language to set is supported by the current preloaded keypad.
*/
result SetCurrentLanguage(Tizen::Locales::LanguageCode languageCode);
*
* @since 2.1
*
- * @param[in] pFilter The filter
- * @remarks The %EditArea control checks with the registered filter to decide whether the user-entered text should be replaced.
+ * @param[in] pFilter The filter to set
+ * @remarks The %EditArea control checks with the registered filter to decide whether the user-entered text should be replaced or not.
*/
void SetEditTextFilter(IEditTextFilter* pFilter);
*
* @since 2.1
*
- * @param[in] command The opaque command
- * @remarks This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
- * This method may not work, depending on the active Input Method.
+ * @param[in] command The opaque command to send
+ * @remarks
+ * - This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
+ * - This method may not work, depending on the active Input Method.
*/
void SendOpaqueCommand (const Tizen::Base::String& command);
*
* 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>.
+ * 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>.
*
* The following example demonstrates how to use the %EditField class.
*
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
EditField(void);
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required.@n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
* The title is not supported by small style %EditField.
* @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 the control has been used
+ * @remarks
+ * - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control has been used
* earlier. The %EditField style of SMALL property cannot be used together with group styles. @n
- * If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
- * @remarks Following are the input styles used for creating the different orientations of a keypad: @n
- * - INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
- * - INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
+ * - If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
+ * - Following are the input styles used for creating the different orientations of a keypad: @n
+ * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
+ * @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, EditFieldStyle style = EDIT_FIELD_STYLE_NORMAL, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, bool showTitle = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
* the width and height of the control.
* @param[in] style The style of the %EditField control
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
* The title is not supported by small style %EditField.
* @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 the control has been used
- * earlier. The %EditField style of SMALL property cannot be used together with group styles. @n
- * If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
- * @remarks Following are the input styles used for creating the different orientations of a keypad: @n
- * - INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
- * - INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
+ * @remarks
+ * - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control has been used
+ * earlier. The %EditField style of SMALL property cannot be used together with group styles.
+ * - If the specified size is less than the minimum size, %EditField is constructed with the minimum size.
+ * - Following are the input styles used for creating the different orientations of a keypad: @n
+ * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value. @n
+ * @c INPUT_STYLE_OVERLAY: The orientation is the same as that of a parent form.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, EditFieldStyle style = EDIT_FIELD_STYLE_NORMAL, InputStyle inputStyle = INPUT_STYLE_FULLSCREEN, bool showTitle = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
* Title is not supported in small style %EditField.
* @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 the control is used earlier.
- * The %EditField style of SMALL property cannot be used together with group styles. @n
- * If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
- * @remarks Following are the input styles used for creating different orientations of a keypad: @n
- * - INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
- * - INPUT_STYLE_OVERLAY: The orientation is similar to the parent Form.
+ * @remarks
+ * - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
+ * The %EditField style of SMALL property cannot be used together with group styles.
+ * - If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
+ * - Following are the input styles used for creating different orientations of a keypad: @n
+ * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
+ * @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, EditFieldStyle style, InputStyle inputStyle, EditFieldTitleStyle titleStyle, bool enableClear = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* @exception E_UNSUPPORTED_OPTION The specified option is not supported. @n
* Title is not supported in small style %EditField.
* @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 the control is used earlier.
+ * @remarks
+ * - A control is fully usable only after it has been added to a container. Therefore, some methods may fail if the control is used earlier.
* The %EditField style of SMALL property cannot be used together with group styles. @n
- * If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
- * @remarks Following are the input styles used for creating different orientations of a keypad: @n
- * - INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
- * - INPUT_STYLE_OVERLAY: The orientation is similar to the parent Form.
+ * - If the specified size is less than the minimum size, EditFied() is constructed with the minimum size.
+ * - Following are the input styles used for creating different orientations of a keypad: @n
+ * @c INPUT_STYLE_FULLSCREEN: The orientation is decided by the G-sensor value.@n
+ * @c INPUT_STYLE_OVERLAY: The orientation is similar to the parent form.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, EditFieldStyle style, InputStyle inputStyle, EditFieldTitleStyle titleStyle, bool enableClear = false, int limitLength = 100, GroupStyle groupStyle = GROUP_STYLE_NONE);
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * In the view mode, the auto-detected links are displayed as linked text.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - In the view mode, the auto-detected links are displayed as linked text.
* @see SetViewModeEnabled()
*/
bool IsViewModeEnabled(void) const;
* For more information, see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>.
* @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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks When @c autoLinks is set to @c 0, the auto-link detection is disabled.
* @see Tizen::Base::Utility::LinkType
* @return The auto-link mask
* @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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAutoLinkMask()
* @since 2.0
*
* @param[in] listener The event listener to add
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY. @n
+ * @remarks This method is supported when the input style is ::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 remove
- * @remarks This method is supported when the input style is @c INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported when the input style is ::INPUT_STYLE_OVERLAY.
* @see AddUiLinkEventListener()
*/
void RemoveUiLinkEventListener(Tizen::Ui::IUiLinkEventListener& listener);
* @return The keypad action
* @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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetKeypadAction()
* @param[in] keypadAction The keypad action
* @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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks Based on the specified value of @c keypadAction, the enter key label of the keypad changes accordingly.
* @see GetKeypadAction()
* 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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
*/
result SetOverlayKeypadCommandButtonVisible(bool visible);
* 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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @return An error code
* @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 input style is not @c INPUT_STYLE_OVERLAY.
+ * The input style is not ::INPUT_STYLE_OVERLAY.
* @exception E_SYSTEM A system error has occurred.
* @see ShowKeypad()
*/
* @since 2.0
*
* @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.
+ * @remarks
+ * - To listen to the scroll panel events, the parent of EditArea must be an instance of ScrollPanel.
+ * - When IScrollPanelEventListener::OnOverlayControlCreated() or IScrollPanelEventListener::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.
* @see RemoveScrollPanelEventListener()
*/
void AddScrollPanelEventListener(Tizen::Ui::IScrollPanelEventListener& listener);
* @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.
- * @remarks This method is supported only when the input style is INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported only when the input style is ::INPUT_STYLE_OVERLAY.
*/
result ShowKeypad(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Cut(), Paste(), Remove()
+ * @see Cut()
+ * @see Paste()
+ * @see Remove()
*/
result Copy(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Remove(), Paste()
+ * @see Copy()
+ * @see Remove()
+ * @see Paste()
*/
result Cut(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Cut(), Remove()
+ * @see Copy()
+ * @see Cut()
+ * @see Remove()
*/
result Paste(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @see Copy(), Cut(), Paste()
+ * @see Copy()
+ * @see Cut()
+ * @see Paste()
*/
result Remove(void);
* @return @c true if the text is clipped, @n
* else @c false
* @remarks 'clipped' means that the text is copied to the clipboard.
- * @see Copy(), Cut(), Paste(), Remove()
+ * @see Copy()
+ * @see Cut()
+ * @see Paste()
+ * @see Remove()
*/
bool IsClipped(void) const;
* @param[in] actionId The action ID
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method is supported only when the input style is INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported only when the input style is ::INPUT_STYLE_OVERLAY.
*/
result SetOverlayKeypadCommandButton(CommandButtonPosition position, const Tizen::Base::String& text, int actionId);
*
* @return The text of the specified command button
* @param[in] position The position of the command button
- * @remarks This method is supported only when the input style is INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported only when the input style is ::INPUT_STYLE_OVERLAY.
*/
Tizen::Base::String GetOverlayKeypadCommandButtonText(CommandButtonPosition position) const;
*
* @return The action ID of the specified command button
* @param[in] position The position of the command button
- * @remarks This method is supported only when the input style is INPUT_STYLE_OVERLAY.
+ * @remarks This method is supported only when the input style is ::INPUT_STYLE_OVERLAY.
*/
int GetOverlayKeypadCommandButtonActionId(CommandButtonPosition position) const;
* @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
- * This method only works if the language to set is supported by the current preloaded keypad.
+ * @remarks
+ * - The application can set the language of the current keypad that is associated with the current %EditField.
+ * - This method only works if the language to set is supported by the current preloaded keypad.
*/
result SetCurrentLanguage(Tizen::Locales::LanguageCode languageCode);
*
* @since 2.1
*
- * @param[in] pFilter The filter
- * @remarks The %EditField control checks with the registered filter to decide whether the user-entered text should be replaced.
+ * @param[in] pFilter The filter to set
+ * @remarks The %EditField control checks with the registered filter to decide whether the user-entered text should be replaced or not.
*/
void SetEditTextFilter(IEditTextFilter* pFilter);
*
* @since 2.1
*
- * @param[in] command The opaque command
- * @remarks This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
- * This method may not work, depending on the active Input Method.
+ * @param[in] command The opaque command to send
+ * @remarks
+ * - This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
+ * - This method may not work, depending on the active Input Method.
*/
void SendOpaqueCommand (const Tizen::Base::String& command);
Tizen::Ui::Controls::ExpandableEditArea* __pExpandableEdit;
};
+* @endcode
+*
+* @code
// Sample code for ExpandableEditAreaSample.cpp
#include <FGraphics.h>
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
ExpandableEditArea(void);
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required.@n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the expandable edit area along with
* the width and height.
* @param[in] style The style of the expandable edit area
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit. @n
* The number of characters has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %ExpandableEditArea control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result AppendCharacter(const Tizen::Base::Character& character);
* @exception E_MAX_EXCEEDED The number of items has exceeded the maximum limit @n
* The number of characters has exceeded the maximum limit.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %ExpandableEditArea control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result AppendText(const Tizen::Base::String& text);
* @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
- * The operation is not supported if the style is EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
- * @remarks The method modifies the text buffer that is managed by the %ExpanableEditArea control. @n
- * To display the changes, the control must be drawn again. The text to be appended will be displayed by the @c textImage.
+ * The operation is not supported if the style is ::EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpanableEditArea control.
+ * - To display the changes, the control must be drawn again. The text to be appended will be displayed by the @c textImage.
*/
result AppendText(const Tizen::Base::String& text, const Tizen::Graphics::Bitmap& textImage);
* @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.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %ExpandableEditArea control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result DeleteCharacterAt(int index);
* Either the specified @c index is greater than the number of elements or less than @c 0.
* @exception E_MAX_EXCEEDED The length of the specified @c text exceeds system limitations.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %ExpandableEditArea control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result InsertCharacterAt(int index, const Tizen::Base::Character& character);
* Either the specified @c position is greater than the number of existing text in the % ExpanableEditArea or less than @c 0.
* @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
- * The operation is not supported if the style is EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
- * @remarks The method modifies the text buffer that is managed by the %ExpanableEditArea control. @n
- * To display the changes, the control must be drawn again. The text to be inserted will be displayed by the @c textImage.
+ * The operation is not supported if the style is ::EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpanableEditArea control.
+ * - To display the changes, the control must be drawn again. The text to be inserted will be displayed by the @c textImage.
*/
result InsertTextAt(int position, const Tizen::Base::String& text, const Tizen::Graphics::Bitmap& textImage);
* @exception E_INVALID_ARG The specified input parameter is invalid, @n
* or the length of the specified @c text exceeds system limitations.
* @exception E_SYSTEM A system error has occurred.
- * @remarks To denote the end of a line use '\\n'.
- * The method modifies the text buffer that is managed by the %ExpandableEditArea control.
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - To denote the end of a line use '\\n'.
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result SetText(const Tizen::Base::String& text);
* @return An error code
* @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 %ExpandableEditArea control.
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
*/
result Clear(void);
* @return An error code
* @param[in] title The title to set
* @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the @n
- * execution of the specified operation. This operation @n
+ * @exception E_UNSUPPORTED_OPERATION The current state of the instance prohibits the
+ * execution of the specified operation. @n This operation
* is not supported if the title is not set.
* @exception E_SYSTEM A system error has occurred.
*/
* @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 @c 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
* @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 @c 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
* @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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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.
*/
* @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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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.
* @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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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.
*/
* @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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
*/
result SetTokenEditModeEnabled(bool enable);
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The default limit length is @c 2048.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The default limit length is @c 2048.
* @see SetLimitLength()
*/
int GetLimitLength(void) const;
* @exception E_INVALID_ARG The specified input parameter is invalid, @n
* or the specified limit length is @c 0 or negative.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %ExpandableEditArea control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %ExpandableEditArea control.
+ * - To display the changes, the control must be drawn again.
* @see GetLimitLength()
*/
result SetLimitLength(int limitLength);
* @param[in] type The text type
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified type is not supported, or @n
- * the specified @c type is EDIT_TEXT_COLOR_LINK.
+ * the specified @c type is @c EDIT_TEXT_COLOR_LINK.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetTextColor()
* @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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::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 @c EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
+ * The operation is not supported if the style is not ::EXPANDABLE_EDIT_AREA_STYLE_TOKEN.
* @exception E_SYSTEM A system error has occurred.
* @see GetTokenTextColor()
*/
* @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 %ExpandableEditArea. @n
- * This method only works if the language to set is supported by the current preloaded keypad.
+ * @remarks
+ * - The application can set the language of the current keypad that is associated with the current %ExpandableEditArea.
+ * - This method only works if the language to set is supported by the current preloaded keypad.
*/
result SetCurrentLanguage(Tizen::Locales::LanguageCode languageCode);
*
* @since 2.1
*
- * @param[in] pFilter The filter
- * @remarks The %ExpandableEditArea control checks with the registered filter to decide whether the user-entered text should be replaced.
+ * @param[in] pFilter The filter to set
+ * @remarks The %ExpandableEditArea control checks with the registered filter to decide whether the user-entered text should be replaced or not.
*/
void SetEditTextFilter(IEditTextFilter* pFilter);
*
* @since 2.1
*
- * @param[in] command The opaque command
+ * @param[in] command The opaque command to send
* @remarks This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
* This method may not work, depending on the active Input Method.
*/
*
* The %IEditTextFilter interface is the listener interface for handling texts, for example, from EditFields.
* The class that processes a text event implements this interface, and the instance created with that class is registered with a
- * UI control, using the control's SetEditTextFilter() method.
+ * UI control, using the control(EditArea, EditField, ExpandableEditArea, Keypad, SearchBar)'s SetEditTextFilter() method.
*
*/
{
public:
/**
- * This polymorphic destructor should be overridden if required.
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called
* when the destructor of this interface is called.
*
*
* @since 2.0
*
- * The %IExpandableEditAreaEventListener interface is the listener interface for receiving %ExpandableEditArea events. @n
+ * The %IExpandableEditAreaEventListener interface is the listener interface for receiving %ExpandableEditArea events.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_exp_editarea.htm">ExpandableEditArea</a>.
+ * For more information on the class features,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_exp_editarea.htm">ExpandableEditArea</a>.
*
*/
class _OSP_EXPORT_ IExpandableEditAreaEventListener
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the specified @c limitLength is less than or equal to @c 0.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the keypad style is set to password, the input mode category is ignored.
- * @remarks The orientation mode of the keypad is decided based on the G-sensor value.
- * @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
- * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
- * @see SetOwner()
+ * @remarks
+ * - If the keypad style is set to password, the input mode category is ignored.
+ * - The orientation mode of the keypad is decided based on the G-sensor value.
+ * - The default owner will be the current Form (or Frame). It is possible that this control may not be visible
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(KeypadStyle keypadStyle, int limitLength);
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the specified @c limitLength is less than or equal to @c 0.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If the keypad style is set to password, the input mode category is ignored.
- * @remarks The orientation mode of the keypad is decided based on the G-sensor value.
+ * @remarks
+ * - If the keypad style is set to password, the input mode category is ignored.
+ * - The orientation mode of the keypad is decided based on the G-sensor value.
* @endif
*/
result Construct(KeypadStyle keypadStyle, KeypadInputModeCategory category, int limitLength = 100);
* @since 2.1
*
* @param[in] command The opaque command
- * @remarks This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
- * This method may not work, depending on the active Input Method.
+ * @remarks
+ * - This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
+ * - This method may not work, depending on the active Input Method.
*/
void SendOpaqueCommand (const Tizen::Base::String& command);
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
SearchBar(void);
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required.@n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the action ID of the specified item must be a positive integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks It is recommended that %SearchBar should be placed at the top-left corner of Form's client area.
- * @remarks By default, a "Cancel" button is displayed if @c searchBarButton is set to @c true. When the user presses the cancel button,
- * the %SearchBar control returns to SEARCH_BAR_MODE_NORMAL automatically.
+ * @remarks
+ * - It is recommended that %SearchBar should be placed at the top-left corner of Form's client area.
+ * - By default, a "Cancel" button is displayed if @c searchBarButton is set to @c true. When the user presses the cancel button,
+ * the %SearchBar control returns to ::SEARCH_BAR_MODE_NORMAL automatically.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, bool searchBarButton = true, KeypadAction keypadAction = KEYPAD_ACTION_SEARCH);
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
* the width and height of the control.
* @param[in] searchBarButton Set to @c true to display the search bar button, @n
* @exception E_INVALID_ARG A specified input parameter is invalid, or @n
* the action ID of the specified item must be a positive integer.
* @exception E_SYSTEM A system error has occurred.
- * @remarks It is recommended that %SearchBar should be placed at the top-left corner of Form's client area.
- * @remarks By default, a "Cancel" button is displayed if @c searchBarButton is set to @c true. When the user presses the cancel button,
- * the %SearchBar control returns to SEARCH_BAR_MODE_NORMAL automatically.
+ * @remarks
+ * - It is recommended that %SearchBar should be placed at the top-left corner of Form's client area.
+ * - By default, a "Cancel" button is displayed if @c searchBarButton is set to @c true. When the user presses the cancel button,
+ * the %SearchBar control returns to ::SEARCH_BAR_MODE_NORMAL automatically.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, bool searchBarButton = true, KeypadAction keypadAction = KEYPAD_ACTION_SEARCH);
*
* @since 2.0
*
- * @return The control that is displayed in the content area of %SearchBar in the SEARCH_BAR_MODE_INPUT mode, @n
+ * @return The control that is displayed in the content area of %SearchBar in the ::SEARCH_BAR_MODE_INPUT mode, @n
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * By default, the method returns @c -1 if no user defined search bar button is set.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - By default, the method returns @c -1 if no user defined search bar button is set.
*/
int GetButtonActionId(void) const;
* @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
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result AppendCharacter(const Tizen::Base::Character& character);
* @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
- * The method modifies the text buffer that is managed by the %SearchBar control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - To denote the end of a line use '\\n'.
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result AppendText(const Tizen::Base::String& text);
* @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
- * The method modifies the text buffer that is managed by the %SearchBar control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - To denote the end of a line use '\\n'.
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result SetText(const Tizen::Base::String& text);
* The specified @c index is greater than the number of elements or less than @c 0.
* @exception E_MAX_EXCEEDED The length of the specified @c text exceeds the system limitation.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %SearchBar control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result InsertCharacterAt(int index, const Tizen::Base::Character& character);
* The specified @c index is greater than the number of elements or less than @c 0.
* @exception E_MAX_EXCEEDED The length of the specified @c text exceeds the system limitation.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %SearchBar control.
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result InsertTextAt(int index, const Tizen::Base::String& text);
* @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.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The method modifies the text buffer that is managed by the %SearchBar control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result DeleteCharacterAt(int index);
* @return An error code
* @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
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %SearchBar control.
+ * - To display the changes, the control must be drawn again.
*/
result Clear(void);
* else @c -1 if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The default limit length is @c 500.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The default limit length is @c 500.
* @see SetLimitLength()
*/
int GetLimitLength(void) const;
* @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 %SearchBar. @n
- * This method only works if the language to set is supported by the current preloaded keypad.
+ * @remarks
+ * - The application can set the language of the current keypad that is associated with the current %SearchBar.
+ * - This method only works if the language to set is supported by the current preloaded keypad.
*/
result SetCurrentLanguage(Tizen::Locales::LanguageCode languageCode);
* @since 2.1
*
* @param[in] command The opaque command
- * @remarks This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
- * This method may not work, depending on the active Input Method.
+ * @remarks
+ * - This method can be used to provide domain-specific features that are only known between certain input methods and their clients.
+ * - This method may not work, depending on the active Input Method.
*/
void SendOpaqueCommand (const Tizen::Base::String& command);
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_textbox.htm">TextBox</a>.
*
+ * The following example demonstrates how to use the %TextBox class.
+ *
* @code
// Sample code for TextBoxSample.h
#include <FUi.h>
// Lifecycle
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the %Construct() method must be called right after calling this constructor.
*
* @since 2.0
*
TextBox(void);
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required.@n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
* the width and height of the control.
* @param[in] border The border style
*
* @return An error code
* @param[in] autoLinks The auto-link mask @n
- * Multiple link types can be combined using the bitwise OR operator (see Tizen::Base::Utility::LinkType). @n
- *
For more information, see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>.
+ * Multiple link types can be combined using the bitwise OR operator (see Tizen::Base::Utility::LinkType). @n For more information,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/ui/auto_link_detection.htm">AutoLink Detection</a>.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks When @c autoLinks is set to @c 0, the auto-link detection is disabled.
* @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
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * - The method modifies the text buffer that is managed by the %TextBox control.
+ * -To display the changes, the control must be drawn again.
*/
result AppendCharacter(const Tizen::Base::Character& character);
* @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
- * The method modifies the text buffer that is managed by the %TextBox control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * -To denote the end of a line use '\\n'.
+ * -The method modifies the text buffer that is managed by the %TextBox control.
+ * -To display the changes, the control must be drawn again.
*/
result AppendText(const Tizen::Base::String& text);
* @return An error code
* @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
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * -The method modifies the text buffer that is managed by the %TextBox control.
+ * -To display the changes, the control must be drawn again.
*/
result Clear(void);
* @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
- * The method modifies the text buffer that is managed by the %TextBox control. @n
- * To display the changes, the control must be drawn again.
+ * @remarks
+ * -To denote the end of a line use '\\n'.
+ * -The method modifies the text buffer that is managed by the %TextBox control.
+ * -To display the changes, the control must be drawn again.
*/
result SetText(const Tizen::Base::String& text);
/**
* @file FUiIInputConnectionEventListener.h
- * @brief This is the header file for the %IInputConnectionEventListener class.
+ * @brief This is the header file for the %IInputConnectionEventListener interface.
*
- * This header file contains the declarations of the %IInputConnectionEventListener class.
+ * This header file contains the declarations of the %IInputConnectionEventListener interface.
*
*
*/
class InputConnection;
/**
- * @class IInputConnectionEventListener
- * @brief This is the header file for the %IInputConnectionEventListener class.
- * This header file contains the declarations of the %IInputConnectionEventListener class.
- * It's possible to not work the callback depending on the current InputMethod.
+ * @interface IInputConnectionEventListener
+ * @brief This interface defines methods for processing between the InputConnection and the input method.
+ *
* @since 2.0
*
- * The %IInputConnectionEventListener interface defines methods for processing between the InputConnection and the input method.
+ * The %IInputConnectionEventListener interface defines methods for processing between the InputConnection and the input method. It is possible to not work the callback depending on the current InputMethod.
*/
class _OSP_EXPORT_ IInputConnectionEventListener
: virtual public Tizen::Base::Runtime::IEventListener
virtual ~IInputConnectionEventListener(void) {}
/**
- * Notifies when the show state of the InputPanel is changed.
+ * Called when the show state of the InputPanel is changed.
*
* @since 2.0
+ *
* @param[in] source The source of the event
* @param[in] showState The state
*/
virtual void OnInputConnectionPanelShowStateChanged(Tizen::Ui::InputConnection& source, Tizen::Ui::InputPanelShowState showState) = 0;
/**
- * Notifies when the language of the InputPanel is changed.
+ * Called when the language of the InputPanel is changed.
*
* @since 2.0
+ *
* @param[in] source The source of the event
* @param[in] language The language code
*/
virtual void OnInputConnectionPanelLanguageChanged(Tizen::Ui::InputConnection& source, Tizen::Locales::LanguageCode language) = 0;
/**
- * Notifies when the size of the InputPanel is changed.
+ * Called when the size of the InputPanel is changed.
*
* @since 2.0
+ *
* @param[in] source The source of the event
* @param[in] bounds The size
*/
virtual void OnInputConnectionPanelBoundsChanged(Tizen::Ui::InputConnection& source, const Tizen::Graphics::Rectangle& bounds) = 0;
/**
- * Notifies when the show state of the Text-Prediction is changed.
+ * Called when the show state of the Text-Prediction is changed.
*
* @since 2.0
+ *
* @param[in] source The source of the event
* @param[in] isShown The state
*/
virtual void OnInputConnectionTextPredictionShowStateChanged(Tizen::Ui::InputConnection& source, bool isShown) = 0;
/**
- * Notifies when the size of the Text-Prediction is changed.
+ * Called when the size of the Text-Prediction is changed.
*
* @since 2.0
+ *
* @param[in] source The source of the event
* @param[in] bounds The size
*/
virtual void OnInputConnectionTextPredictionBoundsChanged(Tizen::Ui::InputConnection& source, const Tizen::Graphics::Rectangle& bounds) = 0;
/**
- * Notifies when the key of the InputPanel is selected.
+ * Called when the key of the InputPanel is selected.
*
* @since 2.0
+ *
* @param[in] source The source of the event
- * @param[in] committedText The committed text.
+ * @param[in] committedText The committed text
*/
virtual void OnInputConnectionTextCommitted(Tizen::Ui::InputConnection& source, const Tizen::Base::String& committedText) = 0;
/**
- * Notifies when the key of the InputPanel is selected during the composing.
+ * Called when the key of the InputPanel is selected during the composing.
*
* @since 2.0
+ *
* @param[in] source The source of the event
- * @param[in] composingText The composing text.
- * @param[in] cursorPosition the current cursor position.
+ * @param[in] composingText The composing text
+ * @param[in] cursorPosition The current cursor position
*/
virtual void OnInputConnectionComposingTextChanged(Tizen::Ui::InputConnection& source, const Tizen::Base::String& composingText, int cursorPosition) = 0;
/**
* @file FUiIInputConnectionEventListenerF.h
- * @brief This is the header file for the %IInputConnectionEventListenerF class.
+ * @brief This is the header file for the %IInputConnectionEventListenerF interface.
*
- * This header file contains the declarations of the %IInputConnectionEventListenerF class.
+ * This header file contains the declarations of the %IInputConnectionEventListenerF interface.
*
*
*/
class InputConnection;
/**
- * @class IInputConnectionEventListenerF
- * @brief This is the header file for the %IInputConnectionEventListenerF class.
- * This header file contains the declarations of the %IInputConnectionEventListenerF class.
- * It's possible to not work the callback depending on the current InputMethod.
+ * @interface IInputConnectionEventListenerF
+ * @brief This interface defines methods for processing between the InputConnection and the input method.
+ *
* @since 2.1
*
- * The %IInputConnectionEventListener interface defines methods for processing between the InputConnection and the input method.
+ * The %IInputConnectionEventListener interface defines methods for processing between the InputConnection and the input method. It is possible to not work the callback depending on the current InputMethod.
*/
class _OSP_EXPORT_ IInputConnectionEventListenerF
: virtual public Tizen::Base::Runtime::IEventListener
virtual ~IInputConnectionEventListenerF(void) {}
/**
- * Notifies when the show state of the InputPanel is changed.
+ * Called when the show state of the InputPanel is changed.
*
* @since 2.1
+ *
* @param[in] source The source of the event
* @param[in] showState The state
*/
virtual void OnInputConnectionPanelShowStateChanged(Tizen::Ui::InputConnection& source, Tizen::Ui::InputPanelShowState showState) = 0;
/**
- * Notifies when the language of the InputPanel is changed.
+ * Called when the language of the InputPanel is changed.
*
* @since 2.1
+ *
* @param[in] source The source of the event
* @param[in] language The language code
*/
virtual void OnInputConnectionPanelLanguageChanged(Tizen::Ui::InputConnection& source, Tizen::Locales::LanguageCode language) = 0;
/**
- * Notifies when the size of the InputPanel is changed.
+ * Called when the size of the InputPanel is changed.
*
* @since 2.1
+ *
* @param[in] source The source of the event
* @param[in] bounds The size
*/
virtual void OnInputConnectionPanelBoundsChanged(Tizen::Ui::InputConnection& source, const Tizen::Graphics::FloatRectangle& bounds) = 0;
/**
- * Notifies when the show state of the Text-Prediction is changed.
+ * Called when the show state of the Text-Prediction is changed.
*
* @since 2.1
+ *
* @param[in] source The source of the event
* @param[in] isShown The state
*/
virtual void OnInputConnectionTextPredictionShowStateChanged(Tizen::Ui::InputConnection& source, bool isShown) = 0;
/**
- * Notifies when the size of the Text-Prediction is changed.
+ * Called when the size of the Text-Prediction is changed.
*
* @since 2.1
+ *
* @param[in] source The source of the event
* @param[in] bounds The size
*/
virtual void OnInputConnectionTextPredictionBoundsChanged(Tizen::Ui::InputConnection& source, const Tizen::Graphics::FloatRectangle& bounds) = 0;
/**
- * Notifies when the key of the InputPanel is selected.
+ * Called when the key of the InputPanel is selected.
*
* @since 2.1
+ *
* @param[in] source The source of the event
- * @param[in] committedText The committed text.
+ * @param[in] committedText The committed text
*/
virtual void OnInputConnectionTextCommitted(Tizen::Ui::InputConnection& source, const Tizen::Base::String& committedText) = 0;
/**
- * Notifies when the key of the InputPanel is selected during the composing.
+ * Called when the key of the InputPanel is selected during the composing.
*
* @since 2.1
+ *
* @param[in] source The source of the event
- * @param[in] composingText The composing text.
- * @param[in] cursorPosition the current cursor position.
+ * @param[in] composingText The composing text
+ * @param[in] cursorPosition The current cursor position
*/
virtual void OnInputConnectionComposingTextChanged(Tizen::Ui::InputConnection& source, const Tizen::Base::String& composingText, int cursorPosition) = 0;
/**
* @file FUiIInputConnectionProvider.h
- * @brief This is the header file for the %IInputConnectionProvider class.
+ * @brief This is the header file for the %IInputConnectionProvider interface.
*
- * This header file contains the declarations of the %IInputConnectionProvider class.
+ * This header file contains the declarations of the %IInputConnectionProvider interface.
*
*
*/
class InputConnection;
/**
- * @class IInputConnectionProvider
- * @brief This is the header file for the %IInputConnectionProvider class.
- * This header file contains the declarations of the %IInputConnectionProvider class.
- * It's possible to not work the callback depending on the current active Input Method.
+ * @interface IInputConnectionProvider
+ * @brief This interface defines methods for processing between the InputConnection and the input method.
+ *
* @since 2.0
*
- * The %IInputConnectionProvider interface defines methods for processing between the InputConnection and the input method.
+ * The %IInputConnectionProvider interface defines methods for processing between the InputConnection and the input method. It is possible to not work the callback depending on the current active Input Method.
*/
class _OSP_EXPORT_ IInputConnectionProvider
{
*
* @since 2.0
* @param[in] source The source of the event
- * @param[in] offset The position to delete before the current cursor position.
+ * @param[in] offset The position to delete before the current cursor position
* @param[in] charCount The number of characters to delete
*/
virtual void DeleteSurroundingText(Tizen::Ui::InputConnection& source, int offset, int charCount) = 0;
projects / platform / framework / native / uifw.git / commitdiff