1 #ifndef DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_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.
25 using Uint32Pair = std::pair<uint32_t, uint32_t>;
26 using string = std::string;
30 * @brief An interface that the Text::Controller used for text selection functionality.
32 class SelectableControlInterface
36 * @brief Virtual destructor.
38 virtual ~SelectableControlInterface() = default;
41 * @brief Called to set the selection postions in the texts.
42 * @param start start selection position (pass NULL to ignore).
43 * @param end end selection position (pass NULL to ignore).
45 virtual void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) = 0;
48 * @brief Called to return the selection postions in the texts.
49 * @return pair contains start and end positions.
51 virtual Uint32Pair GetTextSelectionRange() const = 0;
54 * @brief Called to select the whole texts.
56 virtual void SelectWholeText() = 0;
59 * @brief Called to unselect the whole texts.
61 virtual void SelectNone() = 0;
64 * @brief Retrive Selected text.
65 * @return The seletced text.
67 virtual string GetSelectedText() const = 0;
72 } // namespace Toolkit
76 #endif // DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H