1 #ifndef __DALI_CLIPBOARD_H__
2 #define __DALI_CLIPBOARD_H__
5 * Copyright (c) 2014 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 * @addtogroup CAPI_DALI_ADAPTOR_MODULE
28 #include <dali/public-api/math/rect.h>
29 #include <dali/public-api/object/base-handle.h>
32 namespace Dali DALI_IMPORT_API
35 namespace Internal DALI_INTERNAL
45 * @brief Interface to the device's clipboard.
47 * Clipboard can manage it's item and set show / hide status.
50 class Clipboard : public BaseHandle
54 * @brief Create an uninitialized Clipboard.
56 * this can be initialized with one of the derived Clipboard' New() methods
63 * This is non-virtual since derived Handle types must not contain data or virtual methods.
68 * @brief This constructor is used by Adaptor::GetClipboard().
70 * @param[in] clipboard A pointer to the clipboard.
72 Clipboard( Internal::Adaptor::Clipboard* clipboard );
75 * @brief Retrieve a handle to the ClipboardEventNotifier instance.
77 * @return A handle to the Clipboard
79 static Clipboard Get();
82 * @brief Send the given string to the clipboard.
84 * @param[in] itemData string to send to clip board
85 * @return bool true if the internal clip board sending was successful.
87 bool SetItem( const std::string& itemData );
90 * @brief Retreive the string at the given index in the clipboard.
92 * @param[in] index item in clipboard list to retrieve
93 * @return string the text item at the current index.
95 std::string GetItem( unsigned int index );
98 * @brief Returns the number of item currently in the clipboard.
100 * @return unsigned int number of clipboard items
102 unsigned int NumberOfItems();
105 * @brief Show the clipboard window.
107 void ShowClipboard();
110 * @brief Hide the clipboard window.
112 void HideClipboard();
120 #endif // __DALI_CLIPBOARD_H__