X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Ftext-controls%2Ftext-selection-popup.h;h=4080c90ed8f0a53c5da4fd6edcff9ed76928d0bc;hp=4eec4c136b9fdf83dc5d57cedec9a43fd4ccc385;hb=2e5be8f7ca6638f435d03d1ee639bbec0b04a5a9;hpb=88e08dd541d5441bd0b6661e392621c1d6ba4d6a diff --git a/dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h b/dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h index 4eec4c1..4080c90 100644 --- a/dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h +++ b/dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__ -#define __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__ +#ifndef DALI_TOOLKIT_TEXT_SELECTION_POPUP_H +#define DALI_TOOLKIT_TEXT_SELECTION_POPUP_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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. @@ -23,10 +23,8 @@ namespace Dali { - namespace Toolkit { - class TextSelectionPopupCallbackInterface; namespace Internal DALI_INTERNAL @@ -44,19 +42,18 @@ class TextSelectionPopup; * * */ -class DALI_IMPORT_API TextSelectionPopup : public Control +class DALI_TOOLKIT_API TextSelectionPopup : public Control { public: - enum Buttons { - CUT = 1u << 0, - COPY = 1u << 1, - PASTE = 1u << 2, - SELECT = 1u << 3, + CUT = 1u << 0, + COPY = 1u << 1, + PASTE = 1u << 2, + SELECT = 1u << 3, SELECT_ALL = 1u << 4, - CLIPBOARD = 1u << 5, - NONE = 1u << 6, + CLIPBOARD = 1u << 5, + NONE = 1u << 6, }; /** @@ -65,7 +62,7 @@ public: enum PropertyRange { PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices }; /** @@ -75,23 +72,120 @@ public: { enum { - POPUP_MAX_SIZE = PROPERTY_START_INDEX, ///< name "popup-max-size", maximum size the Popup can be, type VECTOR2 - POPUP_MIN_SIZE, ///< name "popup-min-size", minimum size the Popup can be, type VECTOR2 - OPTION_MAX_SIZE, ///< name "option-max-size", maximum size an option can be, type VECTOR2 - OPTION_MIN_SIZE, ///< name "option-min-size", minimum size an option can be, type VECTOR2 - OPTION_DIVIDER_SIZE, ///< name "option-divider-size", size of the divider between options type VECTOR2 - POPUP_CLIPBOARD_BUTTON_ICON_IMAGE, ///< name "popup-clipboard-button-image", The image to use as the popup clipboard icon, type STRING - POPUP_CUT_BUTTON_ICON_IMAGE, ///< name "popup-cut-button-image", The image to use as the popup cut icon, type STRING - POPUP_COPY_BUTTON_ICON_IMAGE, ///< name "popup-copy-button-image", The image to use as the popup copy icon, type STRING - POPUP_PASTE_BUTTON_ICON_IMAGE, ///< name "popup-paste-button-image", The image to use as the popup paste icon, type STRING - POPUP_SELECT_BUTTON_ICON_IMAGE, ///< name "popup-select-button-image", The image to use as the popup select icon, type STRING - POPUP_SELECT_ALL_BUTTON_ICON_IMAGE, ///< name "popup-select-all-button-image", The image to use as the popup select all icon, type STRING - POPUP_DIVIDER_COLOR, ///< name "popup-divider-color", The color of the divider between options, type VECTOR4 - POPUP_ICON_COLOR, ///< name "popup-icon-color", The color of the icons (if supplied), type VECTOR4 - POPUP_PRESSED_COLOR, ///< name "popup-pressed-color", The color of the option when pressed, type VECTOR4 - POPUP_PRESSED_IMAGE, ///< name "popup-pressed-image", The image to use for the option when pressed, type STRING - POPUP_FADE_IN_DURATION, ///< name "popup-fade-in-duration", The duration of the fade-in animation, type FLOAT - POPUP_FADE_OUT_DURATION, ///< name "popup-fade-out-duration", The duration of the fade-out animation, type FLOAT + /** + * @brief The maximum size the Popup can be. + * @details Name "popupMaxSize", type Vector2. + */ + POPUP_MAX_SIZE = PROPERTY_START_INDEX, + + /** + * @brief The minimum size the Popup can be. + * @details Name "popupMinSize", type Vector2. + */ + POPUP_MIN_SIZE, + + /** + * @brief The maximum size an option can be. + * @details Name "optionMaxSize", type Vector2. + */ + OPTION_MAX_SIZE, + + /** + * @brief The minimum size an option can be. + * @details Name "optionMinSize", type Vector2. + */ + OPTION_MIN_SIZE, + + /** + * @brief The size of the divider between options. + * @details Name "optionDividerSize", type Vector2. + */ + OPTION_DIVIDER_SIZE, + + /** + * @brief The padding of the divider between options. + * @details Name "optionDividerPadding", type Vector4. + */ + OPTION_DIVIDER_PADDING, + + /** + * @brief The image to use as the popup clipboard icon. + * @details Name "popupClipboardButtonImage", type string. + */ + POPUP_CLIPBOARD_BUTTON_ICON_IMAGE, + + /** + * @brief The image to use as the popup cut icon. + * @details Name "popupCutButtonImage", type string. + */ + POPUP_CUT_BUTTON_ICON_IMAGE, + + /** + * @brief The image to use as the popup copy icon. + * @details Name "popupCopyButtonImage", type string. + */ + POPUP_COPY_BUTTON_ICON_IMAGE, + + /** + * @brief The image to use as the popup paste icon. + * @details Name "popupPasteButtonImage", type string. + */ + POPUP_PASTE_BUTTON_ICON_IMAGE, + + /** + * @brief The image to use as the popup select icon. + * @details Name "popupSelectButtonImage", type string. + */ + POPUP_SELECT_BUTTON_ICON_IMAGE, + + /** + * @brief The image to use as the popup select all icon. + * @details Name "popupSelectAllButtonImage", type string. + */ + POPUP_SELECT_ALL_BUTTON_ICON_IMAGE, + + /** + * @brief The color of the divider between options. + * @details Name "popupDividerColor", type Vector4. + */ + POPUP_DIVIDER_COLOR, + + /** + * @brief The color of the icons (if supplied). + * @details Name "popupIconColor", type Vector4. + */ + POPUP_ICON_COLOR, + + /** + * @brief The color of the option when pressed. + * @details Name "popupPressedColor", type Vector4. + */ + POPUP_PRESSED_COLOR, + + /** + * @brief The image to use for the option when pressed. + * @details Name "popupPressedImage", type string. + */ + POPUP_PRESSED_IMAGE, + + /** + * @brief The duration of the fade-in animation. + * @details Name "popupFadeInDuration", type float. + */ + POPUP_FADE_IN_DURATION, + + /** + * @brief The duration of the fade-out animation. + * @details Name "popupFadeOutDuration", type float. + */ + POPUP_FADE_OUT_DURATION, + + /** + * @brief The popup background can have a separate border with a different color. + * @details Name "backgroundBorder", type Property::Map. + * @note Optional. + */ + BACKGROUND_BORDER }; }; @@ -100,7 +194,7 @@ public: * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks. * @return A handle to the TextSelectionPopup control. */ - static TextSelectionPopup New( TextSelectionPopupCallbackInterface* callbackInterface ); + static TextSelectionPopup New(TextSelectionPopupCallbackInterface* callbackInterface); /** * @brief Creates an empty handle. @@ -112,7 +206,7 @@ public: * * @param[in] handle The handle to copy from. */ - TextSelectionPopup( const TextSelectionPopup& handle ); + TextSelectionPopup(const TextSelectionPopup& handle); /** * @brief Assignment operator. @@ -120,7 +214,7 @@ public: * @param[in] handle The handle to copy from. * @return A reference to this. */ - TextSelectionPopup& operator=( const TextSelectionPopup& handle ); + TextSelectionPopup& operator=(const TextSelectionPopup& handle); /** * @brief Destructor @@ -138,20 +232,20 @@ public: * @param[in] handle Handle to an object * @return handle to a TextSelectionPopup or an empty handle */ - static TextSelectionPopup DownCast( BaseHandle handle ); + static TextSelectionPopup DownCast(BaseHandle handle); /** * @brief Specify which buttons to show in Popup * @param[in] buttonsToEnable Buttons to enable */ - void EnableButtons( Toolkit::TextSelectionPopup::Buttons buttonsToEnable ); + void EnableButtons(Toolkit::TextSelectionPopup::Buttons buttonsToEnable); /** - * @brief Raises the toolbar's layer above the given @e target layer. + * @brief Raises the toolbar's actor above the given @e target actor. * - * @param[in] target The layer to get above of. + * @param[in] target The actor to get above of. */ - void RaiseAbove( Layer target ); + void RaiseAbove(Actor target); /** * @brief Show the Popup if not being shown @@ -164,20 +258,19 @@ public: void HidePopup(); public: // Not intended for application developers - /** * @brief Creates a handle using the Toolkit::Internal implementation. * * @param[in] implementation The Control implementation. */ - DALI_INTERNAL TextSelectionPopup( Internal::TextSelectionPopup& implementation ); + DALI_INTERNAL TextSelectionPopup(Internal::TextSelectionPopup& implementation); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @param[in] internal A pointer to the internal CustomActor. */ - explicit DALI_INTERNAL TextSelectionPopup( Dali::Internal::CustomActor* internal ); + explicit DALI_INTERNAL TextSelectionPopup(Dali::Internal::CustomActor* internal); }; // Class TextSelectionPopup @@ -185,4 +278,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__ +#endif // DALI_TOOLKIT_TEXT_SELECTION_POPUP_H