From 4edbe46cd6eebd78fc08aa9217f910e70ff80562 Mon Sep 17 00:00:00 2001 From: Keuckdo Bang Date: Mon, 22 Apr 2013 13:42:00 +0900 Subject: [PATCH] Apply reviewed header files. Change-Id: I5df382696f622e044c095fb726d8d606ddf94aab --- inc/FUiCtrlForm.h | 171 +++++++++++++++++++++------------------ inc/FUiCtrlFrame.h | 52 ++++++------ inc/FUiCtrlIFrameEventListener.h | 10 +-- 3 files changed, 126 insertions(+), 107 deletions(-) diff --git a/inc/FUiCtrlForm.h b/inc/FUiCtrlForm.h index edba7fc..ea98d60 100644 --- a/inc/FUiCtrlForm.h +++ b/inc/FUiCtrlForm.h @@ -116,14 +116,6 @@ enum FormActionBar * * The following example demonstrates how to use the %Form class. * - * Example: - * - *@image html ui_controls_form.png - *@n - * - * This is a simple UI application that uses a %Form. - * - * * @code // Creates an instance of Form Form* pForm = new Form(); @@ -150,6 +142,9 @@ enum FormActionBar pForm->Invalidate(true) * @endcode * + * This is a simple UI application that uses a %Form. + *@image html ui_controls_form.png + * */ class _OSP_EXPORT_ Form : public Tizen::Ui::Container @@ -171,21 +166,21 @@ public: /** * Initializes this instance of %Form with the specified parameters. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] formStyle The form style @n - * Multiple form styles can be combined using bitwise OR (see Tizen::Ui::Controls::FormStyle). + * Multiple form styles can be combined using bitwise OR. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n - * - FORM_STYLE_HEADER and FORM_STYLE_TITLE are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_SOFTKEY_0 are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_SOFTKEY_1 are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_OPTIONKEY are specified at the same time. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * - ::FORM_STYLE_HEADER and ::FORM_STYLE_TITLE are specified at the same time. + * - ::FORM_STYLE_FOOTER and ::FORM_STYLE_SOFTKEY_0 are specified at the same time. + * - @c FORM_STYLE_FOOTER and ::FORM_STYLE_SOFTKEY_1 are specified at the same time. + * - @c FORM_STYLE_FOOTER and ::FORM_STYLE_OPTIONKEY are specified at the same time. * @exception E_MAX_EXCEEDED The total number of Frames and Forms exceeds the system limitation. * @exception E_SYSTEM A system error has occurred. * @remarks The maximum number of Forms that an application can construct is limited by available memory. - * @see FormStyle + * @see FormStyle */ result Construct(unsigned long formStyle); @@ -215,14 +210,15 @@ public: * @return An error code * @param[in] layout The layout for both the portrait and landscape mode * @param[in] formStyle The form style @n - * Multiple form styles can be combined using bitwise OR (see Tizen::Ui::Controls::FormStyle). + * Multiple form styles can be combined using bitwise OR. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or * the specified layout is already bound to another container. * @exception E_MAX_EXCEEDED The total number of Frames and Forms exceeds the system limitation. * @exception E_SYSTEM A system error has occurred. - * @remarks The maximum number of Forms that an application can construct is limited by available memory. @n - * The children are arranged within the client area bounds of the form area by @c layout. + * @remarks + * - The maximum number of Forms that an application can construct is limited by available memory. + * - The children are arranged within the client area bounds of the form area by @c layout. * @see FormStyle */ result Construct(const Tizen::Ui::Layout& layout, unsigned long formStyle); @@ -236,14 +232,15 @@ public: * @param[in] portraitLayout The layout for the portrait mode * @param[in] landscapeLayout The layout for the landscape mode * @param[in] formStyle The form style @n - * Multiple form styles can be combined using bitwise OR (see Tizen::Ui::Controls::FormStyle). + * Multiple form styles can be combined using bitwise OR. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid, or * the specified layout is already bound to another container. * @exception E_MAX_EXCEEDED The total number of Frames and Forms exceeds the system limitation. * @exception E_SYSTEM A system error has occurred. - * @remarks The maximum number of Forms that an application can construct is limited by available memory. @n - * The children are arranged within the bounds of the form area by @c layout. + * @remarks + * - The maximum number of Forms that an application can construct is limited by available memory. + * - The children are arranged within the bounds of the form area by @c layout. * @see FormStyle */ result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, unsigned long formStyle); @@ -403,7 +400,7 @@ public: * @since 2.0 * * @return The orientation status of the %Form control, @n - * else ORIENTATION_NONE if the %Form control is not the current form of the Frame control + * else @c ORIENTATION_NONE if the %Form control is not the current form of the Frame control */ Tizen::Ui::OrientationStatus GetOrientationStatus(void) const; @@ -591,14 +588,16 @@ public: * @param[in] formStyle The form style to set @n * This parameter can be a combination of Tizen::Ui::Controls::FormStyle. * @exception E_SUCCESS The method is successful @if OSPCOMPAT @b Since: @b 2.0 @endif. - * @exception E_INVALID_ARG A specified input parameter is invalid. @n - * - FORM_STYLE_HEADER and FORM_STYLE_TITLE are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_SOFTKEY_0 are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_SOFTKEY_1 are specified at the same time. @n - * - FORM_STYLE_FOOTER and FORM_STYLE_OPTIONKEY are specified at the same time. @n - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * Note that you must not change the style of %Form control that is constructed with FORM_STYLE_TEXT_TAB or FORM_STYLE_ICON_TAB style. - * A Form which is added to a container except Frame cannot have the style of @c FORM_STYLE_INDICATOR. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * - ::FORM_STYLE_HEADER and ::FORM_STYLE_TITLE are specified at the same time. + * - ::FORM_STYLE_FOOTER and ::FORM_STYLE_SOFTKEY_0 are specified at the same time. + * - @c FORM_STYLE_FOOTER and ::FORM_STYLE_SOFTKEY_1 are specified at the same time. + * - @c FORM_STYLE_FOOTER and ::FORM_STYLE_OPTIONKEY are specified at the same time. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - Note that you must not change the style of %Form control that is constructed with ::FORM_STYLE_TEXT_TAB + * or ::FORM_STYLE_ICON_TAB style. + * - A Form which is added to a container except Frame cannot have the style of ::FORM_STYLE_INDICATOR. */ void SetFormStyle(unsigned long formStyle); @@ -620,16 +619,17 @@ public: /** * Sets the orientation of the %Form control. * - * @since 2.0 + * @since 2.0 * - * @feature %http://tizen.org/setting/screen.auto_rotation for the ORIENTATION_AUTOMATIC_FOUR_DIRECTION or ORIENTATION_AUTOMATIC value of @c orientation + * @feature %http://tizen.org/setting/screen.auto_rotation for the @c ORIENTATION_AUTOMATIC_FOUR_DIRECTION or + * @c ORIENTATION_AUTOMATIC value of @c orientation * @param[in] orientation The orientation of the %Form control - * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1 + * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1 @n * For more information, see Application Filtering. * @remarks - * - The specific error code can be accessed using the GetLastResult() method. - * - Before calling this method, check whether the feature is supported by - * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). + * - The specific error code can be accessed using the GetLastResult() method. + * - Before calling this method, check whether the feature is supported by + * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). */ void SetOrientation(Orientation orientation); @@ -678,7 +678,8 @@ public: * @param[in] pTitleBitmap The title icon to set, @n * else @c null if the title icon is removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation (that is, this control cannot be displayed). + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation + * (that is, this control cannot be displayed). * @exception E_SYSTEM A system error has occurred. * @endif */ @@ -698,10 +699,12 @@ public: * @param[in] title The title to set * @param[in] alignment The horizontal alignment * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation (that is, this control cannot be displayed). + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation + * (that is, this control cannot be displayed). * @exception E_SYSTEM A system error has occurred. - * @remarks If the size of the text exceeds the displayable area, the text slides automatically. @n - * Note that when the title icon is set along with the title text, the title retains the left alignment. + * @remarks + * - If the size of the text exceeds the displayable area, the text slides automatically. + * - Note that when the title icon is set along with the title text, the title retains the left alignment. * @endif */ result SetTitleText(const Tizen::Base::String& title, HorizontalAlignment alignment = ALIGNMENT_CENTER); @@ -733,8 +736,9 @@ public: * * @param[in] softkey The softkey * @param[in] text The text to set - * @remarks If both the icon and text are set for a softkey at the same time, the text takes precedence over the icon. @n - * To display text in multi-lines or to denote the end of line, use '\\n'. + * @remarks + * - If both the icon and text are set for a softkey at the same time, the text takes precedence over the icon. + * - To display text in multi-lines or to denote the end of line, use '\\n'. * @endif */ void SetSoftkeyText(Softkey softkey, const Tizen::Base::String& text); @@ -867,10 +871,10 @@ public: * the specified action bars do not exist. * @exception E_UNSUPPORTED_OPERATION This operation is not supported. * @exception E_SYSTEM A system error has occurred. - * @remarks Modifying the translucency of the action bars causes the client area of the %Form to change. @n - * The translucency of multiple action bars can be modified at the same time by using logical OR for several values of FormActionBar. - * @remarks The method is not supported in 16-bit devices. - * @see FormActionBar + * @remarks + * - Modifying the translucency of the action bars causes the client area of the %Form to change. + * - The translucency of multiple action bars can be modified at the same time by using logical OR for several values of FormActionBar. + * - The method is not supported in 16-bit devices. */ result SetActionBarsTranslucent(unsigned long actionBars, bool translucent); @@ -882,16 +886,17 @@ public: * * @return An error code * @param[in] actionBars The action bars @n - * Multiple action bars can be combined using bitwise OR (see Tizen::Ui::Controls::FormActionBar). + * Multiple action bars can be combined using bitwise OR. * @param[in] visible Set to @c true to make the action bars visible, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or * the specified action bars does not exist. * @exception E_SYSTEM A system error has occurred. - * @remarks Modifying the translucency of action bars causes the client area of the %Form to change. @n - * The visibility of multiple action bars can be modified at the same time by using logical OR for several values of FormActionBar. - * @see FormActionBar + * @remarks + * - Modifying the translucency of action bars causes the client area of the %Form to change. + * - The visibility of multiple action bars can be modified at the same time by using logical OR for several values of FormActionBar. + * @see FormActionBar */ result SetActionBarsVisible(unsigned long actionBars, bool visible); @@ -901,7 +906,7 @@ public: * Due to the hardware accelerated rendering, there are limitations for an overlay region. @n * The hardware capability for an overlay region is checked by using OverlayRegion::GetWidthUnit(), OverlayRegion::GetHeightUnit() and * OverlayRegion::GetMaxCount(). - * If the specified condition is not satisfied, E_INVALID_ARG exception is returned. + * If the specified condition is not satisfied, @c E_INVALID_ARG exception is returned. * * @since 2.0 * @@ -913,11 +918,14 @@ public: * @exception E_MAX_EXCEEDED The number of overlay regions has reached the maximum limit. * @exception E_UNSUPPORTED_OPTION The specified option of the overlay region type is not supported. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay region. @n - * In such cases, GetOverlayRegionN() returns the E_INVALID_ARG exception. To prevent this problem, the application should use the - * OverlayRegion::EvaluateBounds() method to get the validated bounds that can be used as the input bounds of the GetOverlayRegionN() method. - * @remarks Do not use OverlayRegion with OverlayPanel. If used, the E_SYSTEM exception is thrown. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations + * of the overlay region. @n + * In such cases, it returns the @c E_INVALID_ARG exception. To prevent this problem, + * the application should use the OverlayRegion::EvaluateBounds() method to get the validated bounds that + * can be used as the input bounds of this method. + * - Do not use OverlayRegion with OverlayPanel. If used, the @c E_SYSTEM exception is thrown. */ OverlayRegion* GetOverlayRegionN(const Tizen::Graphics::Rectangle& rect, OverlayRegionType regionType); @@ -926,7 +934,7 @@ public: * Due to the hardware accelerated rendering, there are limitations for an overlay region. @n * The hardware capability for an overlay region is checked by using OverlayRegion::GetWidthUnit(), OverlayRegion::GetHeightUnit() and * OverlayRegion::GetMaxCount(). - * If the specified condition is not satisfied, E_INVALID_ARG exception is returned. + * If the specified condition is not satisfied, @c E_INVALID_ARG exception is returned. * * @since 2.1 * @@ -938,11 +946,14 @@ public: * @exception E_MAX_EXCEEDED The number of overlay regions has reached the maximum limit. * @exception E_UNSUPPORTED_OPTION The specified option of the overlay region type is not supported. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * If the application runs on multi-screen resolutions, the specified bounds may not meet the hardware limitations of the overlay region. @n - * In such cases, GetOverlayRegionNF() returns the E_INVALID_ARG exception. To prevent this problem, the application should use the - * OverlayRegion::EvaluateBoundsF() method to get the validated bounds that can be used as the input bounds of the GetOverlayRegionNF() method. - * @remarks Do not use OverlayRegion with OverlayPanel. If used, the E_SYSTEM exception is thrown. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the application runs on multi-screen resolutions, the specified bounds may + * not meet the hardware limitations of the overlay region. @n + * In such cases, it returns the @c E_INVALID_ARG exception. @n + * To prevent this problem, the application should use the OverlayRegion::EvaluateBoundsF() method to + * get the validated bounds that can be used as the input bounds of this method. + * - Do not use OverlayRegion with OverlayPanel. If used, the @c E_SYSTEM exception is thrown. */ OverlayRegion* GetOverlayRegionN(const Tizen::Graphics::FloatRectangle& rect, OverlayRegionType regionType); @@ -956,15 +967,16 @@ public: * 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 Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %Form. @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 @n - * if the size or position of the control is changed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The Frame and %Form instances share a single frame-buffer. @n - * Therefore, the custom drawing on the graphic canvas of the Frame and %Form controls appears on the screen regardless of whether the - * control is currently visible on the screen. + * @remarks + * - The method allocates Tizen::Graphics::Canvas whose bounds are equal to that of the client area of the %Form. + * - 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 control is changed. + * - The specific error code can be accessed using the GetLastResult() method. + * - The Frame and %Form instances share a single frame-buffer. @n + * Therefore, the custom drawing on the graphic canvas of the Frame and %Form controls appears on the + * screen regardless of whether the control is currently visible on the screen. */ Tizen::Graphics::Canvas* GetClientAreaCanvasN(void) const; @@ -1040,16 +1052,17 @@ public: DataBindingContext* GetDataBindingContextN(void) const; /** - * Enables or disables the notification tray to be opened. + * Enables or disables the notification tray to remain open. * * @since 2.1 * * @return An error code - * @param[in] enable Set to @c true to enable the notification tray to be opened, @n + * @param[in] enable Set to @c true to enable the notification tray to remain open, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation. @n - * If the style of %Form isn’t FORM_STYLE_INDICATOR or FORM_STYLE_INDICATOR_AUTO_HIDE, the method returns E_INVALID_OPERATION. + * If the style of %Form is not ::FORM_STYLE_INDICATOR or ::FORM_STYLE_INDICATOR_AUTO_HIDE, + * the method returns @c E_INVALID_OPERATION. * @remarks If this method is not explicitly called, the notification tray is opened. * @see IsNotificationTrayOpenEnabled() */ @@ -1057,15 +1070,16 @@ public: /** - * Checks whether the notification tray is opened or not. + * Checks whether the notification tray is open or not. * * @since 2.1 * - * @return @c true if the notification tray is opened, @n + * @return @c true if the notification tray is open, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of a specified operation. @n - * If the style of %Form isn’t FORM_STYLE_INDICATOR or FORM_STYLE_INDICATOR_AUTO_HIDE, the method returns E_INVALID_OPERATION. + * If the style of %Form is not ::FORM_STYLE_INDICATOR or ::FORM_STYLE_INDICATOR_AUTO_HIDE, + * the method returns @c E_INVALID_OPERATION. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetNotificationTrayOpenEnabled() */ @@ -1121,4 +1135,3 @@ private: } } } // Tizen::Ui::Controls #endif // _FUI_CTRL_FORM_H_ - diff --git a/inc/FUiCtrlFrame.h b/inc/FUiCtrlFrame.h index 063c34d..d10330f 100644 --- a/inc/FUiCtrlFrame.h +++ b/inc/FUiCtrlFrame.h @@ -112,7 +112,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] rect An instance of the Rectangle class @n + * @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n * This instance represents the x and y coordinates of the top-left corner @n * of the created window along with its width and height. @n * @exception E_SUCCESS The method is successful. @@ -121,8 +121,9 @@ public: * is, the method is called on an instance that is constructed). * @exception E_MAX_EXCEEDED The number of Frames and Forms exceeds the system limitation. * @exception E_SYSTEM A system error has occurred. - * @remarks The maximum number of Forms that an application can construct is limited by available memory. - * @remarks The specified position and size are only applied when the show mode is not #FRAME_SHOW_MODE_FULL_SCREEN. + * @remarks + * - The maximum number of Forms that an application can construct is limited by available memory. + * - The specified position and size are only applied when the show mode is not ::FRAME_SHOW_MODE_FULL_SCREEN. */ result Construct(const Tizen::Graphics::Rectangle& rect); @@ -132,7 +133,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] rect An instance of the 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 @n * of the created window along with its width and height. @n * @exception E_SUCCESS The method is successful. @@ -141,8 +142,9 @@ public: * is, the method is called on an instance that is constructed). * @exception E_MAX_EXCEEDED The number of Frames and Forms exceeds the system limitation. * @exception E_SYSTEM A system error has occurred. - * @remarks The maximum number of Forms that an application can construct is limited by available memory. - * @remarks The specified position and size are only applied when the show mode is not #FRAME_SHOW_MODE_FULL_SCREEN. + * @remarks + * - The maximum number of Forms that an application can construct is limited by available memory. + * - The specified position and size are only applied when the show mode is not ::FRAME_SHOW_MODE_FULL_SCREEN. */ result Construct(const Tizen::Graphics::FloatRectangle& rect); @@ -211,7 +213,7 @@ public: * Sets the specified Form control as the current %Form of the %Frame control. * * @brief [Deprecated] - * @deprecated This API is deprecated. + * @deprecated This method is deprecated. * @since 2.0 * * @return An error code @@ -220,28 +222,32 @@ public: * @exception E_INVALID_ARG The specified input parameter is invalid. * The specified @c form is not a child control of the %Frame control. * @exception E_SYSTEM A system error has occurred. - * @remarks If a form is set as the current form, it becomes the topmost form amongst its siblings. @n - * SetCurrentForm() does not call Invalidate() internally, so if the current form needs to be drawn + * @remarks + * - If a form is set as the current form, it becomes the topmost form amongst its siblings. + * - This method does not call Invalidate() internally, so if the current form needs to be drawn * immediately, Invalidate() should be called after SetCurrentForm(). - * Only Frame whose show mode is @c FRAME_SHOW_MODE_FULL_SCREEN can set a Form which has the style of @c FORM_STYLE_INDICATOR as the current form. + * - Only Frame whose show mode is ::FRAME_SHOW_MODE_FULL_SCREEN + * can set a Form which has the style of ::FORM_STYLE_INDICATOR as the current form. */ result SetCurrentForm(const Form& form); /** - * Sets the specified Form control as the current %Form of the %Frame control. + * Sets a specified Form control as the current %Form of the %Frame control. * * @since 2.1 * * @return An error code - * @param[in] pForm The form to be set as the current form of the %Frame control + * @param[in] pForm The form to set as the current form of the %Frame control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * The specified @c form is not a child control of the %Frame control. * @exception E_SYSTEM A system error has occurred. - * @remarks If a form is set as the current form, it becomes the topmost form amongst its siblings. @n - * SetCurrentForm() does not call Invalidate() internally, so if the current form needs to be drawn + * @remarks + * - If a form is set as the current form, it becomes the topmost form amongst its siblings. + * - This method does not call Invalidate() internally, so if the current form needs to be drawn * immediately, Invalidate() should be called after SetCurrentForm(). - * Only Frame whose show mode is @c FRAME_SHOW_MODE_FULL_SCREEN can set a Form which has the style of @c FORM_STYLE_INDICATOR as the current form. + * - Only Frame whose show mode is ::FRAME_SHOW_MODE_FULL_SCREEN can set a Form which has + * the style of ::FORM_STYLE_INDICATOR as the current form. */ result SetCurrentForm(Form* pForm); @@ -266,11 +272,12 @@ public: /** * Sets the orientation mode of a frame. * - * @since 2.0 + * @since 2.0 * - * @feature %http://tizen.org/setting/screen.auto_rotation for the ORIENTATION_AUTOMATIC_FOUR_DIRECTION or ORIENTATION_AUTOMATIC value of @c orientation + * @feature %http://tizen.org/setting/screen.auto_rotation for the @c ORIENTATION_AUTOMATIC_FOUR_DIRECTION or + * @c ORIENTATION_AUTOMATIC value of @c orientation * @param[in] orientation The orientation mode of the %Frame control - * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1 + * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @b Since: @b 2.1 @n * For more information, see Application Filtering. * @remarks * - The specific error code can be accessed using the GetLastResult() method. @@ -293,9 +300,9 @@ public: * @since 2.0 * * @return The orientation status - * @remarks The method returns ORIENTATION_STATUS_NONE if the %Frame control is not drawn. + * @remarks The method returns @c ORIENTATION_STATUS_NONE if the %Frame control is not drawn. * Once it is drawn, the orientation of the %Frame control is set to portrait and the method - * returns ORIENTATION_STATUS_PORTRAIT if the application has not specified its orientation. + * returns @c ORIENTATION_STATUS_PORTRAIT if the application has not specified its orientation. */ Tizen::Ui::OrientationStatus GetOrientationStatus(void) const; @@ -318,7 +325,7 @@ public: * @param[in] mode The mode to show the %Frame control * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The default mode is #FRAME_SHOW_MODE_FULL_SCREEN. + * @remarks The default mode is ::FRAME_SHOW_MODE_FULL_SCREEN. */ result SetShowMode(FrameShowMode mode); @@ -328,7 +335,7 @@ public: * @since 2.0 * * @return The mode to show the %Frame control - * @remarks The default mode is #FRAME_SHOW_MODE_FULL_SCREEN. + * @remarks The default mode is ::FRAME_SHOW_MODE_FULL_SCREEN. */ FrameShowMode GetShowMode(void) const; @@ -398,4 +405,3 @@ private: }}} // Tizen::Ui::Controls #endif // _FUI_CTRL_FRAME_H_ - diff --git a/inc/FUiCtrlIFrameEventListener.h b/inc/FUiCtrlIFrameEventListener.h index 52bb05d..66d1c35 100644 --- a/inc/FUiCtrlIFrameEventListener.h +++ b/inc/FUiCtrlIFrameEventListener.h @@ -59,7 +59,7 @@ public: public: /** * Called when a Frame instance is about to be destroyed. @n - * This method is called just before the system destroys the %Frame instance of an application during the application termination sequence. + * The %OnFrameTerminating() method is called just before the system destroys the %Frame instance of an application during the application termination sequence. * * @since 2.0 * @@ -70,7 +70,7 @@ public: /** * Called when a Frame instance is about to be activated. @n - * This method is called just after the system activates the %Frame instance of an application. + * The %OnFrameActivated() method is called just after the system activates the %Frame instance of an application. * * @since 2.0 * @@ -80,7 +80,7 @@ public: /** * Called when a Frame instance is about to be deactivated. @n - * This method is called just after the system deactivates the %Frame instance of an application. + * The %OnFrameDeactivated() method is called just after the system deactivates the %Frame instance of an application. * * @since 2.0 * @@ -90,7 +90,7 @@ public: /** * Called after a Frame instance is minimized. @n - * This method is called just after the system minimizes the %Frame instance of an application. + * The %OnFrameMinimized() method is called just after the system minimizes the %Frame instance of an application. * * @since 2.1 * @@ -100,7 +100,7 @@ public: /** * Called after a Frame instance is restored. @n - * This method is called just after the system restores the %Frame instance of an application. + * The %OnFrameRestored() method is called just after the system restores the %Frame instance of an application. * * @since 2.1 * -- 2.7.4