X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFAppIAppFrame.h;h=14c5248d69da1f094322cbe936a2083299145685;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=042705601441a828047eb773ad793a6d8bd87205;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FAppIAppFrame.h b/inc/FAppIAppFrame.h index 0427056..14c5248 100644 --- a/inc/FAppIAppFrame.h +++ b/inc/FAppIAppFrame.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -16,8 +15,8 @@ // /** - * @file FAppIAppFrame.h - * @brief This is the header file for the %IAppFrame interface. + * @file FAppIAppFrame.h + * @brief This is the header file for the %IAppFrame interface. * * This header file contains the declarations of the %IAppFrame interface. */ @@ -40,13 +39,14 @@ namespace Tizen { namespace App * * @since 2.0 * - * The %IAppFrame interface provides methods for the application frame. A frame is the outermost boundary of the application UI. + * The %IAppFrame interface provides methods for the application frame. + * A frame is the outermost boundary of the application UI. */ class IAppFrame { 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 @@ -58,7 +58,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Graphics::Canvas class + * @return A pointer to the Tizen::Graphics::Canvas instance */ virtual Tizen::Graphics::Canvas* GetCanvasN(void) const = 0; @@ -67,8 +67,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IKeyEventListener instance to add + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to add * @exception E_SUCCESS The method is successful. */ virtual result AddKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0; @@ -78,8 +78,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IKeyEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result RemoveKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0; @@ -89,9 +89,9 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add + * @exception E_SUCCESS The method is successful. */ virtual result AddTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0; @@ -100,8 +100,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add + * @return An error code + * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add * @exception E_SUCCESS The method is successful. */ virtual result RemoveTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0; @@ -111,8 +111,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result AddWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0; @@ -122,8 +122,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result RemoveWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0; @@ -133,11 +133,11 @@ public: * * @since 2.0 * - * @return A pointer to Tizen::Ui::Controls::Frame if successful, @n - * else @c null - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance is in an invalid state. - * @exception E_UNSUPPORTED_OPERATION This method cannot be supported. + * @return A pointer to the Tizen::Ui::Controls::Frame instance, @n + * else @c null if it fails + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE This instance is in an invalid state. + * @exception E_UNSUPPORTED_OPERATION This method is not supported. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Ui::Controls::Frame* GetFrame(void) = 0;