Merge "fix klocwork issue" into tizen_2.2

[platform/framework/native/uifw.git] / inc / FUiCtrlProgressPopup.h

diff --git a/inc/FUiCtrlProgressPopup.h b/inc/FUiCtrlProgressPopup.h
index ab0b81a..482823a 100644 (file)
--- a/inc/FUiCtrlProgressPopup.h
+++ b/inc/FUiCtrlProgressPopup.h
@@ -2,14 +2,14 @@
 // Open Service Platform
 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
 //
-// Licensed under the Flora License, Version 1.0 (the License);
+// Licensed under the Apache License, Version 2.0 (the License);
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://floralicense.org/license/
+//     http://www.apache.org/licenses/LICENSE-2.0/
 //
 // Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
+// distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
@@ -46,7 +46,8 @@ namespace Tizen { namespace Ui { namespace Controls
  * 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
  *
@@ -59,6 +60,7 @@ namespace Tizen { namespace Ui { namespace Controls
 class ProgressPopupSample
        : public Tizen::Ui::Controls::Form
        , public Tizen::Ui::IProgressPopupEventListener
+       , public Tizen::Ui::IActionEventListener
 {
 public:
        ProgressPopupSample(void);
@@ -118,9 +120,10 @@ ProgressPopupSample::OnInitializing(void)
 
        // Creates an instance of Button to open the ProgressPopup.
        Button* pButtonProgressPopup = new Button();
-       pButtonProgressPopup->Construct(Rectangle(10, 10, 250, 60), L"Open ProgressPopup");
+       pButtonProgressPopup->Construct(Rectangle(50, 50, 350, 100), L"Open ProgressPopup");
        pButtonProgressPopup->SetActionId(ID_BUTTON_PROGRESSPOPUP);
        pButtonProgressPopup->AddActionEventListener(*this);
+       AddControl(pButtonProgressPopup);
 
        return r;
 }
@@ -170,7 +173,8 @@ class _OSP_EXPORT_ ProgressPopup
 {
 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 ProgressPopup::Construct() method must be called right after calling this constructor.
         *
         * @since 2.0
         */
@@ -195,13 +199,14 @@ public:
         * @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);
 
@@ -236,6 +241,7 @@ public:
         * @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);
 
@@ -246,7 +252,8 @@ public:
         * @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.
         */