From b94927d314a0ea347511a40fd9b00688a169a87a Mon Sep 17 00:00:00 2001 From: Myung Jin Kim Date: Tue, 11 Jun 2013 14:57:52 +0900 Subject: [PATCH] cherry-pick 5d06c37723d882f1d321055c79dd4f37d64c9601 320b954e90fb6f687a4fed9ae9def21ea02b2d48 (fix doxygen and apply HW MenuButton) Change-Id: I449466b14eb4aaa7068d907de8d92ad35d1c2239 --- inc/FUiControls.h | 1 - inc/FUiCtrlFooter.h | 69 ++++++++++----------- inc/FUiCtrlHeader.h | 2 - inc/FUiCtrlIFormControlEventListener.h | 110 --------------------------------- src/ui/controls/FUiCtrl_FooterImpl.cpp | 8 +++ 5 files changed, 39 insertions(+), 151 deletions(-) delete mode 100644 inc/FUiCtrlIFormControlEventListener.h diff --git a/inc/FUiControls.h b/inc/FUiControls.h index 91d1c28..6177e28 100644 --- a/inc/FUiControls.h +++ b/inc/FUiControls.h @@ -75,7 +75,6 @@ #include #include #include -#include #include #include #include diff --git a/inc/FUiCtrlFooter.h b/inc/FUiCtrlFooter.h index 1f41e3f..75e1bcc 100644 --- a/inc/FUiCtrlFooter.h +++ b/inc/FUiCtrlFooter.h @@ -407,9 +407,9 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks If the back button item is not set, the method will return @c E_SUCCESS. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM This exception exists only for historical reason. + * @remarks This method always returns E_SUCCESS. */ result RemoveBackButton(void); @@ -519,7 +519,6 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n * The back button item is not set. - * @exception E_SYSTEM A system error has occurred. */ result SetBackButtonEnabled(bool enable); @@ -577,8 +576,6 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * There are more than 2 footer items. * @exception E_UNSUPPORTED_OPERATION This operation is not supported. @n * The operation is not supported when the style of the %Footer control is ::FOOTER_STYLE_TAB. @n * This device does not support the software back button. @@ -807,76 +804,72 @@ public: /** - * Checks whether the menu button item is set. + * Checks whether the Menu button item is set. * - * @since 2.2 + * @since 2.2 * - * @return @c true if the menu button item is set, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @return @c true if the Menu button item is set, @n + * else @c false */ bool IsMenuButtonSet(void) const; /** - * Gets the state of the menu button. + * Gets the state of the Menu button. * * @since 2.2 * - * @return The state of the menu button, @n - * else @c BUTTON_ITEM_STATUS_NORMAL if an error occurs. + * @return The state of the Menu button, @n + * else @c BUTTON_ITEM_STATUS_NORMAL if an error occurs. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The menu button is not set. + * The Menu button is not set. * @remarks The specific error code can be accessed using the GetLastResult() method. */ ButtonItemStatus GetMenuButtonStatus(void) const; /** - * Removes the menu button item. + * Removes the Menu button item. * - * @since 2.2 + * @since 2.2 * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks If the menu button item is not set, the method will return @c E_SUCCESS. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM This exception exists only for historical reason. + * @remarks This method always returns E_SUCCESS. */ result RemoveMenuButton(void); /** - * Enables or disables the menu button. + * Enables or disables the Menu button. * - * @since 2.2 + * @since 2.2 * * @return An error code - * @param[in] enable Set to @c true to enable the menu button, @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. @n - * The menu button item is not set. - * @exception E_SYSTEM A system error has occurred. + * @param[in] enable Set to @c true to enable the Menu button, @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. @n + * The Menu button item is not set. */ result SetMenuButtonEnabled(bool enable); /** - * Sets the menu button. + * Sets the Menu button. * * @since 2.2 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * There are more than 3 footer items. - * @exception E_UNSUPPORTED_OPERATION This operation is not supported. @n - * The operation is not supported when the style of the %Footer control is ::FOOTER_STYLE_TAB. @n - * @exception E_SYSTEM A system error has occurred. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_OPERATION This exception is returned when there are more than 3 footer items. + * @exception E_UNSUPPORTED_OPERATION This operation is not supported. @n + * The operation is not supported when the style of the %Footer control is ::FOOTER_STYLE_TAB. @n + * @exception E_SYSTEM A System error has occurred. * @remarks - * - If the left button is already set, then the button is replaced with the menu button. + * - If the left button is already set, then the button is replaced with the Menu button. */ result SetMenuButton(void); diff --git a/inc/FUiCtrlHeader.h b/inc/FUiCtrlHeader.h index 0a744e7..d458fa2 100644 --- a/inc/FUiCtrlHeader.h +++ b/inc/FUiCtrlHeader.h @@ -915,8 +915,6 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * There are more than 2 header items. * @exception E_UNSUPPORTED_OPERATION The operation is supported when the style of the %Header control is ::HEADER_STYLE_BUTTON. @n * This device does not support the software back button. * @remarks When the back button is pressed, OnFormBackRequested() of IFormBackEventListener is called. @n diff --git a/inc/FUiCtrlIFormControlEventListener.h b/inc/FUiCtrlIFormControlEventListener.h deleted file mode 100644 index 164f27b..0000000 --- a/inc/FUiCtrlIFormControlEventListener.h +++ /dev/null @@ -1,110 +0,0 @@ -// -// Open Service Platform -// Copyright (c) 2012-2013 Samsung Electronics Co., Ltd. -// -// 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://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, -// 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. -// -/** - * @file FUiCtrlIFormControlventListener.h - * @brief This is the header file for the %IFormControlventListener interface. - * - * This header file contains the declarations of the %IFormControlventListener interface. - */ -#ifndef _FUI_CTRL_IFORM_CONTROL_EVENT_LISTENER_H_ -#define _FUI_CTRL_IFORM_CONTROL_EVENT_LISTENER_H_ - -// includes -#include - -// namespace declaration -namespace Tizen { namespace Ui { namespace Controls -{ - -class Form; - -/** - * @interface IFormControlEventListener - * @brief This interface implements the listener for Form-related events. - * - * @since 2.0 - * - * The %IFormControlEventListener interface is the listener interface for receiving Form-related events. - * - * For more information on the class features, see Form. - */ -class IFormControlEventListener - : virtual public Tizen::Base::Runtime::IEventListener -{ -// Lifecycle -public: - /** - * This is the destructor for this class. - * - * @since 2.0 - */ - virtual ~IFormControlEventListener(void) {} - -// Operation -public: - /** - * Called when the current Form control needs to be closed to revert back to the previous %Form control. - * - * @since 2.1 - * - * @param[in] source The source of the event - * @remarks This event is fired when the user clicks on the software 'back' button on the Footer control, or the hardware back button on the - * device. - */ - virtual void OnFormBackButtonRequested(Tizen::Ui::Controls::Form& source) = 0; - - virtual void OnFormOptionButtonRequested(Tizen::Ui::Controls::Form& source) = 0; - -// Reserves -protected: - // - //This method is for internal use only. Using this method can cause behavioral, security-related, - //and consistency-related issues in the application. - // - // This method is reserved and may change its name at any time without - // prior notice. - // - // @since 2.0 - // - virtual void IFormControlEventListener_Reserved1(void) { } - - // - //This method is for internal use only. Using this method can cause behavioral, security-related, - //and consistency-related issues in the application. - // - // This method is reserved and may change its name at any time without - // prior notice. - // - // @since 2.0 - // - virtual void IFormControlEventListener_Reserved2(void) { } - - // - //This method is for internal use only. Using this method can cause behavioral, security-related, - //and consistency-related issues in the application. - // - // This method is reserved and may change its name at any time without - // prior notice. - // - // @since 2.0 - // - virtual void IFormControlEventListener_Reserved3(void) { } -}; // IFormControlEventListener - -}}} // Tizen::Ui::Controls - -#endif // _FUI_CTRL_IFORM_CONTROL_EVENT_LISTENER_H_ diff --git a/src/ui/controls/FUiCtrl_FooterImpl.cpp b/src/ui/controls/FUiCtrl_FooterImpl.cpp index 1808ce3..44ae85d 100644 --- a/src/ui/controls/FUiCtrl_FooterImpl.cpp +++ b/src/ui/controls/FUiCtrl_FooterImpl.cpp @@ -2097,6 +2097,14 @@ protected: } } + if ((FOOTER_STYLE_TAB != fstyle) && (pControl->GetElement(L"showMenuButton", elementString))) + { + if (elementString.Equals(L"true", false)) + { + pFooter->SetMenuButton(); + } + } + int itemCnt = pControl->GetItemCount(); ButtonItemStyle buttonItemStyle = BUTTON_ITEM_STYLE_TEXT; ButtonPosition buttonPosition = BUTTON_POSITION_LEFT; -- 2.7.4