1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_POPUP_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_POPUP_H
5 * Copyright (c) 2021 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/public-api/actors/layer.h>
23 #include <dali/public-api/object/property-map.h>
27 #include <dali-toolkit/devel-api/controls/control-devel.h>
28 #include <dali-toolkit/devel-api/controls/table-view/table-view.h>
29 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h>
30 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-toolbar.h>
31 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
32 #include <dali-toolkit/public-api/controls/control-impl.h>
33 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
41 enum PopupCustomisations
49 class TextSelectionPopup : public Control
52 struct ButtonRequirement
55 : id(Toolkit::TextSelectionPopup::NONE),
63 ButtonRequirement(Toolkit::TextSelectionPopup::Buttons buttonId,
64 std::size_t buttonPriority,
65 const std::string& buttonName,
66 const std::string& buttonCaption,
69 priority(buttonPriority),
71 caption(buttonCaption),
72 enabled(buttonEnabled)
76 Toolkit::TextSelectionPopup::Buttons id;
83 struct ButtonPriorityCompare
85 bool operator()(const ButtonRequirement& lhs, const ButtonRequirement& rhs) const
87 return lhs.priority < rhs.priority;
92 * @brief New constructor with provided buttons to enable.
93 * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
94 * @return A handle to the TextSelectionPopup control.
96 static Toolkit::TextSelectionPopup New(TextSelectionPopupCallbackInterface* callbackInterface);
101 * @brief Called when a property of an object of this type is set.
102 * @param[in] object The object whose property is set.
103 * @param[in] index The property index.
104 * @param[in] value The new property value.
106 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
109 * @brief Called to retrieve a property of an object of this type.
111 * @param[in] object The object whose property is to be retrieved.
112 * @param[in] index The property index.
113 * @return The current value of the property.
115 static Property::Value GetProperty(BaseObject* object, Property::Index index);
118 * @copydoc Toolkit::EnableButtons
120 void EnableButtons(Toolkit::TextSelectionPopup::Buttons buttonsToEnable);
123 * @copydoc Toolkit::TextSelectionPopup::RaiseAbove()
125 void RaiseAbove(Actor target);
128 * @copydoc Toolkit::TextSelectionPopup::ShowPopup()
133 * @copydoc Toolkiut::TextSelectionPopup::HidePopup()
137 private: // From Control
139 * @copydoc Control::OnInitialize()
141 void OnInitialize() override;
144 * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
146 DevelControl::ControlAccessible* CreateAccessibleObject() override;
148 private: // Implementation
149 void HideAnimationFinished(Animation& animation);
152 * @brief When the cut button is pressed.
153 * @param[in] button the button pressed
154 * @return @e true to consume the event.
156 bool OnCutButtonPressed(Toolkit::Button button);
159 * @brief When the copy button is pressed.
160 * @param[in] button the button pressed
161 * @return @e true to consume the event.
163 bool OnCopyButtonPressed(Toolkit::Button button);
166 * @brief When the paste button is pressed.
167 * @param[in] button the button pressed
168 * @return @e true to consume the event.
170 bool OnPasteButtonPressed(Toolkit::Button button);
173 * @brief When the select button is pressed.
174 * @param[in] button the button pressed
175 * @return @e true to consume the event.
177 bool OnSelectButtonPressed(Toolkit::Button button);
180 * @brief When the select all button is pressed.
181 * @param[in] button the button pressed
182 * @return @e true to consume the event.
184 bool OnSelectAllButtonPressed(Toolkit::Button button);
187 * @brief When the clipboard button is pressed.
188 * @param[in] button the button pressed
189 * @return @e true to consume the event.
191 bool OnClipboardButtonPressed(Toolkit::Button button);
194 * @brief Method to set the dimension or dimension constraint on certain aspects of the Popup.
196 * @param[in] settingToCustomise The setting for the PopupCustomisations enum that can be customised
197 * @param[in] dimension The size to customise with
199 void SetDimensionToCustomise(const PopupCustomisations& settingToCustomise, const Size& dimension);
202 * @brief Method to get the dimension or dimension constraint on certain aspects of the Popup that was previously customised
204 * @param[in] setting The setting from the PopupCustomisations enum
206 Size GetDimensionToCustomise(const PopupCustomisations& setting) const;
209 * @brief Sets the image for the given button of the Popup.
211 * @param[in] button The button the image should be used for from the Buttons Enum.
212 * @param[in] image The image to use.
214 void SetButtonImage(Toolkit::TextSelectionPopup::Buttons button, const std::string& image);
217 * @brief Retrieves the image of the given button used by the popup
219 * @param[in] button The button to get the image from
220 * @return The image used for that button.
222 const std::string& GetButtonImage(Toolkit::TextSelectionPopup::Buttons button) const;
225 * @brief Sets the image for the pressed state of a popup option.
227 * @param[in] filename The image filename to use.
229 void SetPressedImage(const std::string& filename);
232 * @brief Gets the image used for the pressed state of a popup option.
234 * @return The image filename used.
236 std::string GetPressedImage() const;
239 * Set option divider padding
240 * @param[in] padding BEGIN END BOTTOM TOP
242 void SetOptionDividerPadding(const Padding& padding);
245 * Get option divider padding
248 Padding GetOptionDividerPadding() const;
250 void CreateOrderedListOfPopupOptions();
252 void AddOption(const ButtonRequirement& button, bool showDivider, bool showIcons, bool showCaption);
254 std::size_t GetNumberOfEnabledOptions() const;
256 void AddPopupOptionsToToolbar(bool showIcons, bool showCaptions);
259 * Creates the background-border image
261 * @param[in] propertyMap The properties describing the background-border
263 void CreateBackgroundBorder(Property::Map& propertyMap);
266 * Construct a new TextField.
268 TextSelectionPopup(TextSelectionPopupCallbackInterface* callbackInterface);
271 * A reference counted object may only be deleted by calling Unreference()
273 virtual ~TextSelectionPopup();
276 struct PropertyHandler;
278 class TextSelectionPopupAccessible : public DevelControl::ControlAccessible
281 using DevelControl::ControlAccessible::ControlAccessible;
284 * @copydoc DevelControl::ControlAccessible::CalculateStates()
286 Dali::Accessibility::States CalculateStates() override;
290 // Undefined copy constructor and assignment operators
291 TextSelectionPopup(const TextSelectionPopup&);
292 TextSelectionPopup& operator=(const TextSelectionPopup& rhs);
295 Dali::Toolkit::TextSelectionToolbar mToolbar;
297 Dali::Toolkit::TableView mTableOfButtons; // Actor which holds all the buttons, sensitivity can be set on buttons via this actor
299 // Images paths to be used by the Popup buttons
300 std::string mCutIconImage;
301 std::string mCopyIconImage;
302 std::string mPasteIconImage;
303 std::string mClipboardIconImage;
304 std::string mSelectIconImage;
305 std::string mSelectAllIconImage;
307 Size mPopupMaxSize; // Maximum size of the Popup
308 Size mOptionMaxSize; // Maximum size of an Option button
309 Size mOptionMinSize; // Minimum size of an Option button
310 Size mOptionDividerSize; // Size of divider line
311 Padding mOptionDividerPadding; // Padding of divider line
313 std::vector<ButtonRequirement> mOrderListOfButtons; // List of buttons in the order to be displayed and a flag to indicate if needed.
315 Toolkit::TextSelectionPopup::Buttons mEnabledButtons; // stores enabled buttons
316 Toolkit::TextSelectionPopupCallbackInterface* mCallbackInterface;
318 std::string mPressedImage; // Image used for the popup option when pressed.
319 Vector4 mPressedColor; // Color of the popup option when pressed.
320 Vector4 mDividerColor; // Color of the divider between buttons
321 Vector4 mIconColor; // Color of the popup icon.
323 // Priority of Options/Buttons in the Cut and Paste pop-up, higher priority buttons are displayed first, left to right.
324 std::size_t mSelectOptionPriority; // Position of Select Button
325 std::size_t mSelectAllOptionPriority; // Position of Select All button
326 std::size_t mCutOptionPriority; // Position of Cut button
327 std::size_t mCopyOptionPriority; // Position of Copy button
328 std::size_t mPasteOptionPriority; // Position of Paste button
329 std::size_t mClipboardOptionPriority; // Position of Clipboard button
330 float mFadeInDuration; // Duration of the animation to fade in the Popup
331 float mFadeOutDuration; // Duration of the animation to fade out the Popup
333 bool mShowIcons : 1; // Flag to show icons
334 bool mShowCaptions : 1; // Flag to show text captions
335 bool mPopupShowing : 1; // Flag to indicate Popup showing
336 bool mButtonsChanged : 1; // Flag to indicate the Popup Buttons have changed
339 } // namespace Internal
341 // Helpers for public-api forwarding methods
343 inline Toolkit::Internal::TextSelectionPopup& GetImpl(Toolkit::TextSelectionPopup& textSelectionPopup)
345 DALI_ASSERT_ALWAYS(textSelectionPopup);
347 Dali::RefObject& handle = textSelectionPopup.GetImplementation();
349 return static_cast<Toolkit::Internal::TextSelectionPopup&>(handle);
352 inline const Toolkit::Internal::TextSelectionPopup& GetImpl(const Toolkit::TextSelectionPopup& textSelectionPopup)
354 DALI_ASSERT_ALWAYS(textSelectionPopup);
356 const Dali::RefObject& handle = textSelectionPopup.GetImplementation();
358 return static_cast<const Toolkit::Internal::TextSelectionPopup&>(handle);
361 } // namespace Toolkit
365 #endif // DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_POPUP_H