Change-Id: Ie8148c10332e08fb57ad6dfc52f35f04968b6141
Signed-off-by: DongJinJeon <dongjin2193.jeon@samsung.com>
* 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.
*
* 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="../org.tizen.native.appprogramming/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
{
public:
/**
*/
class _OSP_EXPORT_ IProgressPopupEventListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
/**
- * 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.
* user wants to continue a potentially dangerous action. It can also display information, question, alarm, and lock messages, or
* the user selections.
*
* user wants to continue a potentially dangerous action. It can also display information, question, alarm, and lock messages, or
* the user selections.
*
-* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_popup_messagebox.htm">Popup and MessageBox</a>.
+* For more information on the class features,
+* see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_popup_messagebox.htm">Popup and MessageBox</a>.
*
* The following example demonstrates how to use the %MessageBox class.
*
*
* The following example demonstrates how to use the %MessageBox class.
*
- * 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 MessageBox::Construct() method must be called right after calling this constructor.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_INVALID_ARG The specified @c text is too long.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_INVALID_ARG The specified @c text is too long.
- * @remarks To create a %MessageBox control, call ShowAndWait() after the Construct() method is called. @n
- * The message box text cannot contain over @c 399 characters. @n
- * To display the text in multi-lines or to denote the end of line use '\\n'.
- * @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
+ * - To create a %MessageBox control, call ShowAndWait() after the Construct() method is called.
+ * - The message box text cannot contain over @c 399 characters.
+ * - To display the text in multi-lines or to denote the end of line use '\\n'.
+ * - 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.
* @see ShowAndWait()
*/
result Construct(const Tizen::Base::String& title, const Tizen::Base::String& text, MessageBoxStyle style, unsigned long timeout = 0);
* @see ShowAndWait()
*/
result Construct(const Tizen::Base::String& title, const Tizen::Base::String& text, MessageBoxStyle style, unsigned long timeout = 0);
* The %Popup class displays messages to alert the user of important changes, to request confirmation for a significant task, or to
* serve as a warning. It is an implementation of the Window class.
*
* The %Popup class displays messages to alert the user of important changes, to request confirmation for a significant task, or to
* serve as a warning. It is an implementation of the Window class.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_popup_messagebox.htm">Popup and MessageBox</a>.
+ * For more information on the class features,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_popup_messagebox.htm">Popup and MessageBox</a>.
*
* @see Tizen::Ui::Window
*
*
* @see Tizen::Ui::Window
*
- * 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.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(bool hasTitle, const Tizen::Graphics::Dimension& dim);
*/
result Construct(bool hasTitle, const Tizen::Graphics::Dimension& dim);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
/**
* Initializes this instance of %Popup and child controls with the specified resource ID @n
*/
result Construct(bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
/**
* Initializes this instance of %Popup and child controls with the specified resource ID @n
* This method first attempts to find the resource file in the folder that corresponds to the current screen resolution. @n
* This method first attempts to find the resource file in the folder that corresponds to the current screen resolution. @n
- * If it fails to find the resource file, it searches in other folders in the following order when CoordinateSystem is Logical in the application manifest file @n
+ * If it fails to find the resource file, it searches in other folders in the following order when CoordinateSystem is Logical in the application manifest file
* the density folder that corresponds to the current screen size category "res/screen-size-normal/" folder.
*
* @since 2.0
* the density folder that corresponds to the current screen size category "res/screen-size-normal/" folder.
*
* @since 2.0
* @exception E_INVALID_FORMAT The specified XML format is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* @exception E_INVALID_FORMAT The specified XML format is invalid.
* @exception E_OPERATION_FAILED The operation has failed.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Base::String& resourceId);
*/
result Construct(const Tizen::Base::String& resourceId);
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
*/
result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
*/
result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @remarks The default owner will be the current Form (or Frame). It is possible that this control may not be visible
* the specified layout is already bound to another container.
* @exception E_SYSTEM A system error has occurred.
* @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()
+ * due to this ownership relationship. @n In this case, use the SetOwner() method to change the ownership to the top-most window.
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
*/
result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
* This value is the 'modalResult' parameter of the EndModal() method
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The %Popup is not visible. The visible state of the %Popup should be set @c true.
* This value is the 'modalResult' parameter of the EndModal() method
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The %Popup is not visible. The visible state of the %Popup should be set @c true.
- * @remarks Do not call this method from Tizen::App::App::OnAppInitializing(). @n
- * To show a %Popup properly from Tizen::Ui::Controls::Form::OnInitializing(), theForm must
- * have been successfully drawn before the DoModal() method.
+ * @remarks
+ * - Do not call this method from Tizen::App::App::OnAppInitializing().
+ * - To show a %Popup properly from Tizen::Ui::Controls::Form::OnInitializing(), theForm must
+ * have been successfully drawn before the DoModal() method.
*/
result DoModal(int& modalResult);
*/
result DoModal(int& modalResult);
* @since 2.0
* @return An error code
* @param[in] modalResult The result value of the modal window. @n
* @since 2.0
* @return An error code
* @param[in] modalResult The result value of the modal window. @n
- * The value which needs to be returned as the output parameter of DoModal() method should be passed as the input argument
+ * The value which needs to be returned as the output parameter of DoModal() method
+ * should be passed as the input argument
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The method is not supported because this popup isn't running as a modal window.
*/
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The method is not supported because this popup isn't running as a modal window.
*/
- * @return The bounds of the client area in a Rectangle instance
+ * @return The bounds of the client area in a Tizen::Graphics::Rectangle instance
*/
Tizen::Graphics::Rectangle GetClientAreaBounds(void) const;
*/
Tizen::Graphics::Rectangle GetClientAreaBounds(void) const;
- * @return The bounds of the client area in a FloatRectangle instance
+ * @return The bounds of the client area in a Tizen::Graphics::FloatRectangle instance
*/
Tizen::Graphics::FloatRectangle GetClientAreaBoundsF(void) const;
*/
Tizen::Graphics::FloatRectangle GetClientAreaBoundsF(void) const;
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_RESOURCE_UNAVAILABLE The required resource is currently unavailable.
* else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_RESOURCE_UNAVAILABLE The required resource is currently unavailable.
- * @remarks The method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %Popup control. @n
- * It is the responsibility of the developers to deallocate the canvas after use.
- * @remarks The canvas is valid only if the properties of the parent control of the canvas remain unchanged. @n
- * Therefore, delete the previously allocated canvas and create a new canvas using the GetClientAreaCanvasN() method if the size or position of the
+ * @remarks
+ * - The method allocates a Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %Popup control.
+ * - It is the responsibility of the developers to deallocate the canvas after use.
+ * - The canvas is valid only if the properties of the parent control of the canvas remain unchanged. @n
+ * Therefore, delete the previously allocated canvas and create a new canvas using this method if the size or position of the
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Canvas* GetClientAreaCanvasN(void) const;
*/
Tizen::Graphics::Canvas* GetClientAreaCanvasN(void) const;
* The %ProgressPopup class displays processing animation to show processing status.
* It can contain a title, body text and cancel button.
*
* The %ProgressPopup class displays processing animation to show processing status.
* It can contain a title, body text and cancel button.
*
- * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_progresspopup.htm">ProgressPopup</a>.
+ * For more information on the class features,
+ * see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_progresspopup.htm">ProgressPopup</a>.
*
* @see Tizen::Ui::Window
*
*
* @see Tizen::Ui::Window
*
- * 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 ProgressPopup::Construct() method must be called right after calling this constructor.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred. @n
This error occurs when the internal resource is not loaded.
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred. @n
This error occurs when the internal resource is not loaded.
- * @remarks To show a %ProgressPopup window, call Show() or DoModal() after calling the Construct() method. @n
- * By default, the title area and the body text are not shown. @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 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.
+ * @remarks
+ * - To show a %ProgressPopup window, call Show() or DoModal() after calling this method.
+ * - By default, the title area and the body text are not shown. @n
+ * Use SetTitleText() and SetText() to show the title area and the body text.
+ * - 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.
+ * - 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);
*/
result Construct(bool cancelButton, bool transparent);
* @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.
* @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.
+ * @see RemoveProgressPopupEventListener()
*/
result AddProgressPopupEventListener(Tizen::Ui::IProgressPopupEventListener& listener);
*/
result AddProgressPopupEventListener(Tizen::Ui::IProgressPopupEventListener& listener);
* @since 2.0
* @return An error code
* @param[in] listener The event listener to remove @n
* @since 2.0
* @return An error code
* @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.
+ * The 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.
*/
* @exception E_SUCCESS This method was successful.
* @exception E_OBJ_NOT_FOUND The listener was not found.
*/