X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppUiApp.h;h=757c4630c7d859ddb80c8aa44d568299e5bf9bf7;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=bd5c709b3410a25533b6aa1e782ec1534c7c557a;hpb=dc5e066e475854f8e354071f7ab4b786e880e9b9;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FAppUiApp.h b/inc/FAppUiApp.h
index bd5c709..757c463 100644
--- a/inc/FAppUiApp.h
+++ b/inc/FAppUiApp.h
@@ -43,10 +43,10 @@ typedef UiApp* (*UiAppInstanceFactory)(void);
*
* @since 2.0
*
- * The %UiApp class is the base class of a %Tizen native UI application.
+ * The %UiApp class is the base class of a %Tizen native UI application.@n
* A %Tizen native UI application must inherit from the %UiApp class. This class provides the basic features necessary to define the
* %Tizen native UI application.
- * @n
+ *
* For more information on the class features, see App Guide and Native Application Model.
*
*/
@@ -62,24 +62,24 @@ public:
virtual ~UiApp(void);
/**
- * Gets the first frame in the frame list of the UI application.
+ * Gets the first frame to the frame list of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the IAppFrame interface of the frame, @n
- * else @c null if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE The frame has not been properly initialized.
- * @exception E_OBJ_NOT_FOUND The frame is not found.
+ * @return A pointer to the IAppFrame instance of the frame, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE The frame has not been initialized properly.
+ * @exception E_OBJ_NOT_FOUND The frame has not been found.
*/
IAppFrame* GetAppFrame(void) const;
/**
- * Adds the frame to the end of the list that is maintained by the UI application.
+ * Adds a frame to the end of the list that is maintained by the UI application.
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame that is added to the UI application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
@@ -96,7 +96,7 @@ public:
*
* @since 2.0
*
- * @return An error code
+ * @return An error code
* @param[in] frame The frame to remove
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
@@ -108,10 +108,10 @@ public:
/**
* Gets the list of the frames of the UI application.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to Tizen::Base::Collection::IList that contains Tizen::Ui::Frame instances, @n
- * else @c null if it fails
+ * @return A pointer to the Tizen::Base::Collection::IList that contains the Tizen::Ui::Frame instances, @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE The application is in an invalid state.
* @remarks The specific error code can be accessed using the GetLastResult() method.
@@ -121,10 +121,10 @@ public:
/**
* Gets the frame with the specified @c name.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame having the specified @c name, @n
- * else @c null if it fails
+ * @return A pointer to the frame that contains the specified @c name, @n
+ * else @c null if it fails
* @param[in] name The name of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found.
@@ -133,12 +133,12 @@ public:
Tizen::Ui::Controls::Frame* GetFrame(const Tizen::Base::String& name) const;
/**
- * Gets the frame at the specified @c index of the list.
+ * Gets the frame at the specified @c index in the list.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the frame at the specified @c index, @n
- * else @c null if it fails
+ * @return A pointer to the frame at the specified @c index, @n
+ * else @c null if it fails
* @param[in] index The index of the frame
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the frame list.
@@ -152,23 +152,23 @@ public:
* @since 2.0
*
* @return The UI state of the UI application
- * @remarks Note that UiApp::OnBackground() is invoked when the UI state of a UI application changes
- * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND or App::APP_UI_STATE_BACKGROUND.
+ * @remarks Note that the UiApp::OnBackground() method is invoked when the UI state of the UI application changes
+ * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND, or App::APP_UI_STATE_BACKGROUND.
*/
AppUiState GetAppUiState(void) const;
/**
- * Called when a UI application moves to the foreground. @n
+ * Called when the UI application moves to the foreground. @n
* User interaction is enabled when the UI application moves to the foreground. @n
* A UI application moves to the foreground when:
*
- * - A UI application is selected from the Task Switcher.
- * - A UI application icon in the Launcher application is pressed when it is running in the background.
- * - A UI application is to be launched while it is running in the background.
- * - A system pop-up, such as an incoming call, notification (for example, SMS), or a low battery warning
- * pop-up disappears.
+ * - The UI application is selected from the Task Switcher.
+ * - The UI application icon in the Launcher application is pressed when it is running in the background.
+ * - The UI application is to be launched while it is running in the background.
+ * - A system pop-up, such as an incoming call, a notification (for example, an SMS), or a low battery warning
+ * pop-up disappears.
*
- * When this method is invoked, the following actions are recommended:
+ * When the %OnForeground() method is invoked, the following actions are recommended:
*
* - Resume the graphic processing, such as 3D or animation, as the UI application now has the focus.
* - Resume the operations that stopped when the UI application is last moved to the background.
@@ -185,10 +185,10 @@ public:
* A UI application moves to the background when:
*
* - A system pop-up, such as an incoming call or a low battery warning pop-up is displayed.
- * - A device is locked.
+ * - The device is locked.
* - The Home key is pressed.
*
- * Whenever this method is invoked, the following actions are recommended:
+ * When the %OnBackground() method is invoked, the following actions are recommended:
*
* - Stop the graphic processing, such as 3D or animation, as they will not be displayed.
* - Release unnecessary resources.
@@ -196,17 +196,16 @@ public:
*
* @since 2.0
*
- * @remarks When notification (for example, SMS) pops up, this method is not called.
- * When a system pop-up is displayed, a UI application becomes partially hidden
- * (App::APP_UI_STATE_PARTIAL_BACKGROUND).
- * If a UI application is partially hidden, it is recommended to hold the activated
- * tasks or resources instead of stopping or releasing them.
+ * @remarks
+ * - When a notification (for example, an SMS) pops up, this method is not called.
+ * - When a system pop-up is displayed, the UI application becomes partially hidden (App::APP_UI_STATE_PARTIAL_BACKGROUND).
+ * - If the UI application is partially hidden, it is recommended to hold the activated tasks or resources instead of stopping or releasing them.
* @see GetAppUiState()
*/
virtual void OnBackground(void);
/**
- * Gets the %UiApp instance's pointer.
+ * Gets a pointer to the %UiApp instance.
*
* @since 2.0
*
@@ -217,17 +216,17 @@ public:
/**
* Executes an application implemented by inheriting this class.
- * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE.
+ * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE.
*
- * @since 2.0
+ * @since 2.0
*
- * @return An error code
- * @param[in] pUiAppFactory The factory method that creates this UiApp's instance
- * @param[in] pArguments The launch arguments for %App
+ * @return An error code
+ * @param[in] pUiAppFactory The factory method that creates this UiApp instance
+ * @param[in] pArguments The launch arguments for the application
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INIT_FAILED The initialization failure during OnAppInitializing().
+ * @exception E_INIT_FAILED A failure occurred while initializing using the OnAppInitializing() method.
* @exception E_SYSTEM A system error has occurred.
*/
static result Execute(UiAppInstanceFactory pUiAppFactory, const Tizen::Base::Collection::IList* pArguments);