1 #ifndef DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H
2 #define DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H
5 * Copyright (c) 2022 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>
28 namespace Internal DALI_INTERNAL
30 class TextSelectionToolbar;
34 * @brief A control which provides a Popup with a number of buttons
36 * The style of the pop can be set through style sheets, this includes the images for the buttons
37 * A Show and Hide API is provided.
39 * If the buttons exceed the size constraints of the popup then it will offer scrolling.
43 class DALI_TOOLKIT_API TextSelectionToolbar : public Control
47 * @brief The start and end property ranges for this control.
51 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
52 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
56 * @brief An enumeration of properties belonging to the TextSelectionToolbar class.
62 MAX_SIZE = PROPERTY_START_INDEX, ///< name "maxSize", The maximum size the Popup can be, type VECTOR2
63 ENABLE_OVERSHOOT, ///< name "enableOvershoot", Whether the overshoot image is enabled, type BOOLEAN
64 ENABLE_SCROLL_BAR, ///< name "enableScrollBar", Whether the scroll-bar is enabled, type BOOLEAN
65 SCROLL_BAR_PADDING, ///< name "scrollBarPadding", The padding used to position the scroll bar, type VECTOR2
66 SCROLL_VIEW, ///< name "scrollView", Properties to set on scroll view type Property::Map
71 * Create the TextSelectionToolbar control.
72 * @return A handle to the TextSelectionToolbar control.
74 static TextSelectionToolbar New();
77 * @brief Creates an empty handle.
79 TextSelectionToolbar();
82 * @brief Copy constructor.
84 * @param[in] handle The handle to copy from.
86 TextSelectionToolbar(const TextSelectionToolbar& handle);
89 * @brief Assignment operator.
91 * @param[in] handle The handle to copy from.
92 * @return A reference to this.
94 TextSelectionToolbar& operator=(const TextSelectionToolbar& handle);
97 * @brief Move constructor.
99 * @param[in] handle The handle to move from.
101 TextSelectionToolbar(TextSelectionToolbar&& handle);
104 * @brief Move assignment operator.
106 * @param[in] handle The handle to move from.
107 * @return A reference to this.
109 TextSelectionToolbar& operator=(TextSelectionToolbar&& handle);
114 * This is non-virtual since derived Handle types must not contain data or virtual methods.
116 ~TextSelectionToolbar();
119 * @brief Add a option to the the Tool bar
120 * @param[in] option Option actor to add
122 void AddOption(Actor& option);
125 * @brief Add a divider to the the Tool bar
126 * @param[in] divider Actor to be used as divider
128 void AddDivider(Actor& divider);
131 * @brief ResizeDividers
132 * @param[in] size New size of dividers, provide 0 for height to automatically set height
134 void ResizeDividers(Size& size);
137 * @brief Raises the actor above the given @e target actor.
139 * @param[in] target The actor to get above of.
141 void RaiseAbove(Actor target);
144 * @copydoc Toolkit::ScrollView::ScrollTo(const Vector2&)
146 void ScrollTo(const Vector2& position);
149 * @brief Downcast a handle to TextSelectionToolbar.
151 * If the BaseHandle points is a TextSelectionToolbar the downcast returns a valid handle.
152 * If not the returned handle is left empty.
154 * @param[in] handle Handle to an object
155 * @return handle to a TextSelectionToolbar or an empty handle
157 static TextSelectionToolbar DownCast(BaseHandle handle);
159 public: // Not intended for application developers
161 * @brief Creates a handle using the Toolkit::Internal implementation.
163 * @param[in] implementation The Control implementation.
165 DALI_INTERNAL TextSelectionToolbar(Internal::TextSelectionToolbar& implementation);
168 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
170 * @param[in] internal A pointer to the internal CustomActor.
172 explicit DALI_INTERNAL TextSelectionToolbar(Dali::Internal::CustomActor* internal);
174 }; // Class TextSelectionToolbar
176 } // namespace Toolkit
180 #endif // DALI_TOOLKIT_TEXT_SELECTION_TOOLBAR_H