1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_POPUP_H__
2 #define __DALI_TOOLKIT_INTERNAL_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-impl.h>
23 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
24 #include <dali-toolkit/public-api/controls/table-view/table-view.h>
25 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h>
26 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-toolbar.h>
29 #include <dali/public-api/actors/layer.h>
40 enum PopupCustomisations
48 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,
67 Dali::Image& buttonIcon,
70 priority( buttonPriority ),
72 caption( buttonCaption ),
74 enabled( buttonEnabled )
77 Toolkit::TextSelectionPopup::Buttons id;
85 struct ButtonPriorityCompare
87 bool operator()( const ButtonRequirement& lhs, const ButtonRequirement& rhs ) const {
88 return lhs.priority < rhs.priority;
93 * @brief New constructor with provided buttons to enable.
94 * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
95 * @return A handle to the TextSelectionPopup control.
97 static Toolkit::TextSelectionPopup New( TextSelectionPopupCallbackInterface* callbackInterface );
102 * @brief Called when a property of an object of this type is set.
103 * @param[in] object The object whose property is set.
104 * @param[in] index The property index.
105 * @param[in] value The new property value.
107 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
110 * @brief Called to retrieve a property of an object of this type.
112 * @param[in] object The object whose property is to be retrieved.
113 * @param[in] index The property index.
114 * @return The current value of the property.
116 static Property::Value GetProperty( BaseObject* object, Property::Index index );
119 * @copydoc Toolkit::EnableButtons
121 void EnableButtons( Toolkit::TextSelectionPopup::Buttons buttonsToEnable );
124 * @copydoc Toolkit::TextSelectionPopup::RaiseAbove()
126 void RaiseAbove( Layer target );
129 * @copydoc Toolkit::TextSelectionPopup::ShowPopup()
134 * @copydoc Toolkiut::TextSelectionPopup::HidePopup()
138 private: // From Control
141 * @copydoc Control::OnInitialize()
143 virtual void OnInitialize();
146 * @copydoc Control::OnStageConnection()
148 virtual void OnStageConnection( int depth );
150 private: // Implementation
152 void HideAnimationFinished( Animation& animation );
155 * @brief When the cut button is pressed.
156 * @param[in] button the button pressed
157 * @return @e true to consume the event.
159 bool OnCutButtonPressed( Toolkit::Button button );
162 * @brief When the copy button is pressed.
163 * @param[in] button the button pressed
164 * @return @e true to consume the event.
166 bool OnCopyButtonPressed( Toolkit::Button button );
169 * @brief When the paste button is pressed.
170 * @param[in] button the button pressed
171 * @return @e true to consume the event.
173 bool OnPasteButtonPressed( Toolkit::Button button );
176 * @brief When the select button is pressed.
177 * @param[in] button the button pressed
178 * @return @e true to consume the event.
180 bool OnSelectButtonPressed( Toolkit::Button button );
183 * @brief When the select all button is pressed.
184 * @param[in] button the button pressed
185 * @return @e true to consume the event.
187 bool OnSelectAllButtonPressed( Toolkit::Button button );
190 * @brief When the clipboard button is pressed.
191 * @param[in] button the button pressed
192 * @return @e true to consume the event.
194 bool OnClipboardButtonPressed( Toolkit::Button button );
197 * @brief Method to set the dimension or dimension constraint on certain aspects of the Popup.
199 * @param[in] settingToCustomise The setting for the PopupCustomisations enum that can be customised
200 * @param[in] dimension The size to customise with
202 void SetDimensionToCustomise( const PopupCustomisations& settingToCustomise, const Size& dimension );
205 * @brief Method to get the dimension or dimension constraint on certain aspects of the Popup that was previously customised
207 * @param[in] setting The setting from the PopupCustomisations enum
209 Size GetDimensionToCustomise( const PopupCustomisations& setting );
212 * @brief Sets the image for the given button of the Popup.
214 * @param[in] button The button the image should be used for from the Buttons Enum.
215 * @param[in] image The image to use.
217 void SetButtonImage( Toolkit::TextSelectionPopup::Buttons button, Dali::Image image );
220 * @brief Retrieves the image of the given button used by the popup
222 * @param[in] button The button to get the image from
223 * @return The image used for that button.
225 Dali::Image GetButtonImage( Toolkit::TextSelectionPopup::Buttons button );
228 * @brief Sets the image for the pressed state of a popup option.
230 * @param[in] filename The image filename to use.
232 void SetPressedImage( const std::string& filename);
235 * @brief Gets the image used for the pressed state of a popup option.
237 * @return The image filename used.
239 std::string GetPressedImage() const;
241 void CreateOrderedListOfPopupOptions();
243 void AddOption( const ButtonRequirement& button, bool showDivider, bool showIcons, bool showCaption );
245 std::size_t GetNumberOfEnabledOptions();
247 void AddPopupOptionsToToolbar( bool showIcons, bool showCaptions );
250 * Construct a new TextField.
252 TextSelectionPopup( TextSelectionPopupCallbackInterface* callbackInterface );
255 * A reference counted object may only be deleted by calling Unreference()
257 virtual ~TextSelectionPopup();
261 // Undefined copy constructor and assignment operators
262 TextSelectionPopup(const TextSelectionPopup&);
263 TextSelectionPopup& operator=(const TextSelectionPopup& rhs);
268 Dali::Toolkit::TextSelectionToolbar mToolbar;
270 Dali::Toolkit::TableView mTableOfButtons; // Actor which holds all the buttons, sensitivity can be set on buttons via this actor
272 // Images to be used by the Popup buttons
274 Image mCopyIconImage;
275 Image mPasteIconImage;
276 Image mClipboardIconImage;
277 Image mSelectIconImage;
278 Image mSelectAllIconImage;
280 Size mPopupMaxSize; // Maximum size of the Popup
281 Size mOptionMaxSize; // Maximum size of an Option button
282 Size mOptionMinSize; // Minimum size of an Option button
283 Size mOptionDividerSize; // Size of divider line
285 std::vector<ButtonRequirement> mOrderListOfButtons; // List of buttons in the order to be displayed and a flag to indicate if needed.
287 Toolkit::TextSelectionPopup::Buttons mEnabledButtons; // stores enabled buttons
288 Toolkit::TextSelectionPopupCallbackInterface* mCallbackInterface;
290 std::string mPressedImage; // Image used for the popup option when pressed.
291 Vector4 mPressedColor; // Color of the popup option when pressed.
292 Vector4 mDividerColor; // Color of the divider between buttons
293 Vector4 mIconColor; // Color of the popup icon.
295 // Priority of Options/Buttons in the Cut and Paste pop-up, higher priority buttons are displayed first, left to right.
296 std::size_t mSelectOptionPriority; // Position of Select Button
297 std::size_t mSelectAllOptionPriority; // Position of Select All button
298 std::size_t mCutOptionPriority; // Position of Cut button
299 std::size_t mCopyOptionPriority; // Position of Copy button
300 std::size_t mPasteOptionPriority; // Position of Paste button
301 std::size_t mClipboardOptionPriority; // Position of Clipboard button
302 float mFadeInDuration; // Duration of the animation to fade in the Popup
303 float mFadeOutDuration; // Duration of the animation to fade out the Popup
305 bool mShowIcons:1; // Flag to show icons
306 bool mShowCaptions:1; // Flag to show text captions
307 bool mPopupShowing:1; // Flag to indicate Popup showing
308 bool mButtonsChanged:1; // Flag to indicate the Popup Buttons have changed
312 } // namespace Internal
314 // Helpers for public-api forwarding methods
316 inline Toolkit::Internal::TextSelectionPopup& GetImpl( Toolkit::TextSelectionPopup& textSelectionPopup )
318 DALI_ASSERT_ALWAYS( textSelectionPopup );
320 Dali::RefObject& handle = textSelectionPopup.GetImplementation();
322 return static_cast<Toolkit::Internal::TextSelectionPopup&>(handle);
325 inline const Toolkit::Internal::TextSelectionPopup& GetImpl( const Toolkit::TextSelectionPopup& textSelectionPopup )
327 DALI_ASSERT_ALWAYS( textSelectionPopup );
329 const Dali::RefObject& handle = textSelectionPopup.GetImplementation();
331 return static_cast<const Toolkit::Internal::TextSelectionPopup&>(handle);
334 } // namespace Toolkit
338 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_SELECTION_POPUP_H__