1 #ifndef DALI_CLIPBOARD_H
2 #define DALI_CLIPBOARD_H
5 * Copyright (c) 2019 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.
23 #include <dali/public-api/math/rect.h>
24 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/dali-adaptor-common.h>
32 namespace Internal DALI_INTERNAL
42 * @brief Interface to the device's clipboard.
44 * Clipboard can manage it's item and set show / hide status.
47 class DALI_ADAPTOR_API Clipboard : public BaseHandle
51 * @brief Create an uninitialized Clipboard.
53 * this can be initialized with one of the derived Clipboard' New() methods
60 * This is non-virtual since derived Handle types must not contain data or virtual methods.
65 * @brief This constructor is used by Adaptor::GetClipboard().
67 * @param[in] clipboard A pointer to the clipboard.
69 explicit DALI_INTERNAL Clipboard( Internal::Adaptor::Clipboard* clipboard );
72 * @brief Retrieve a handle to the ClipboardEventNotifier instance.
74 * @return A handle to the Clipboard
76 static Clipboard Get();
79 * @brief Send the given string to the clipboard.
81 * @param[in] itemData string to send to clip board
82 * @return bool true if the internal clip board sending was successful.
84 bool SetItem( const std::string& itemData );
87 * @brief Request clipboard service to retrieve an item
89 * Calling this method will trigger a signal from the clipboard event notifier.
90 * @see Dali::ClipboardEventNotifier::ContentSelectedSignal()
95 * @brief Returns the number of item currently in the clipboard.
97 * @return unsigned int number of clipboard items
99 unsigned int NumberOfItems();
102 * @brief Show the clipboard window.
104 void ShowClipboard();
107 * @brief Hide the clipboard window.
109 void HideClipboard();
112 * @brief Retrieves the clipboard's visibility
113 * @return bool true if the clipboard is visible.
115 bool IsVisible() const;
120 #endif // DALI_CLIPBOARD_H