1 #ifndef __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__
2 #define __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-toolkit/public-api/controls/control.h>
30 class TextSelectionPopupCallbackInterface;
32 namespace Internal DALI_INTERNAL
34 class TextSelectionPopup;
38 * @brief A control which provides a Popup with a number of buttons
40 * The style of the pop can be set through style sheets, this includes the images for the buttons
41 * A Show and Hide API is provided.
43 * If the buttons exceed the size constraints of the popup then it will offer scrolling.
47 class DALI_IMPORT_API TextSelectionPopup : public Control
63 * @brief The start and end property ranges for this control.
67 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
68 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
72 * @brief An enumeration of properties belonging to the TextSelectionPopup class.
79 * @brief The maximum size the Popup can be.
80 * @details Name "popupMaxSize", type Vector2.
82 POPUP_MAX_SIZE = PROPERTY_START_INDEX,
85 * @brief The minimum size the Popup can be.
86 * @details Name "popupMinSize", type Vector2.
91 * @brief The maximum size an option can be.
92 * @details Name "optionMaxSize", type Vector2.
97 * @brief The minimum size an option can be.
98 * @details Name "optionMinSize", type Vector2.
103 * @brief The size of the divider between options.
104 * @details Name "optionDividerSize", type Vector2.
109 * @brief The image to use as the popup clipboard icon.
110 * @details Name "popupClipboardButtonImage", type string.
112 POPUP_CLIPBOARD_BUTTON_ICON_IMAGE,
115 * @brief The image to use as the popup cut icon.
116 * @details Name "popupCutButtonImage", type string.
118 POPUP_CUT_BUTTON_ICON_IMAGE,
121 * @brief The image to use as the popup copy icon.
122 * @details Name "popupCopyButtonImage", type string.
124 POPUP_COPY_BUTTON_ICON_IMAGE,
127 * @brief The image to use as the popup paste icon.
128 * @details Name "popupPasteButtonImage", type string.
130 POPUP_PASTE_BUTTON_ICON_IMAGE,
133 * @brief The image to use as the popup select icon.
134 * @details Name "popupSelectButtonImage", type string.
136 POPUP_SELECT_BUTTON_ICON_IMAGE,
139 * @brief The image to use as the popup select all icon.
140 * @details Name "popupSelectAllButtonImage", type string.
142 POPUP_SELECT_ALL_BUTTON_ICON_IMAGE,
145 * @brief The color of the divider between options.
146 * @details Name "popupDividerColor", type Vector4.
151 * @brief The color of the icons (if supplied).
152 * @details Name "popupIconColor", type Vector4.
157 * @brief The color of the option when pressed.
158 * @details Name "popupPressedColor", type Vector4.
163 * @brief The image to use for the option when pressed.
164 * @details Name "popupPressedImage", type string.
169 * @brief The duration of the fade-in animation.
170 * @details Name "popupFadeInDuration", type float.
172 POPUP_FADE_IN_DURATION,
175 * @brief The duration of the fade-out animation.
176 * @details Name "popupFadeOutDuration", type float.
178 POPUP_FADE_OUT_DURATION,
181 * @brief The popup background can have a separate border with a different color.
182 * @details Name "backgroundBorder", type Property::Map.
190 * Create the TextSelectionPopup control.
191 * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
192 * @return A handle to the TextSelectionPopup control.
194 static TextSelectionPopup New( TextSelectionPopupCallbackInterface* callbackInterface );
197 * @brief Creates an empty handle.
199 TextSelectionPopup();
202 * @brief Copy constructor.
204 * @param[in] handle The handle to copy from.
206 TextSelectionPopup( const TextSelectionPopup& handle );
209 * @brief Assignment operator.
211 * @param[in] handle The handle to copy from.
212 * @return A reference to this.
214 TextSelectionPopup& operator=( const TextSelectionPopup& handle );
219 * This is non-virtual since derived Handle types must not contain data or virtual methods.
221 ~TextSelectionPopup();
224 * @brief Downcast a handle to TextSelectionPopup.
226 * If the BaseHandle points is a TextSelectionPopup the downcast returns a valid handle.
227 * If not the returned handle is left empty.
229 * @param[in] handle Handle to an object
230 * @return handle to a TextSelectionPopup or an empty handle
232 static TextSelectionPopup DownCast( BaseHandle handle );
235 * @brief Specify which buttons to show in Popup
236 * @param[in] buttonsToEnable Buttons to enable
238 void EnableButtons( Toolkit::TextSelectionPopup::Buttons buttonsToEnable );
241 * @brief Raises the toolbar's layer above the given @e target layer.
243 * @param[in] target The layer to get above of.
245 void RaiseAbove( Layer target );
248 * @brief Show the Popup if not being shown
253 * @brief Hide the Popup if shown
257 public: // Not intended for application developers
260 * @brief Creates a handle using the Toolkit::Internal implementation.
262 * @param[in] implementation The Control implementation.
264 DALI_INTERNAL TextSelectionPopup( Internal::TextSelectionPopup& implementation );
267 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
269 * @param[in] internal A pointer to the internal CustomActor.
271 explicit DALI_INTERNAL TextSelectionPopup( Dali::Internal::CustomActor* internal );
273 }; // Class TextSelectionPopup
275 } // namespace Toolkit
279 #endif // __DALI_TOOLKIT_TEXT_SELECTION_POPUP_H__