1 #ifndef __DALI_CLIPBOARD_H__
2 #define __DALI_CLIPBOARD_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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 * @addtogroup CAPI_DALI_ADAPTOR_MODULE
27 #include <dali/public-api/math/rect.h>
28 #include <dali/public-api/object/base-handle.h>
31 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
44 * @brief Interface to the device's clipboard.
46 * Clipboard can manage it's item and set show / hide status.
49 class Clipboard : public BaseHandle
53 * @brief Create an uninitialized Clipboard.
55 * this can be initialized with one of the derived Clipboard' New() methods
60 * @brief Virtual destructor.
65 * @brief This constructor is used by Adaptor::GetClipboard().
67 * @param[in] clipboard A pointer to the clipboard.
69 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 Retreive the string at the given index in the clipboard.
89 * @param[in] index item in clipboard list to retrieve
90 * @return string the text item at the current index.
92 std::string GetItem( unsigned int index );
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();
117 #endif // __DALI_CLIPBOARD_H__