dali/devel-api/adaptor-framework/clipboard.h

   1 #ifndef DALI_CLIPBOARD_H
   2 #define DALI_CLIPBOARD_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/math/rect.h>
  23 #include <dali/public-api/object/base-handle.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal DALI_INTERNAL
  31 {
  32 namespace Adaptor
  33 {
  34 class Clipboard;
  35 }
  36 } // namespace DALI_INTERNAL
  37
  38 /**
  39  * @brief Interface to the device's clipboard.
  40  *
  41  * Clipboard can manage it's item and set show / hide status.
  42  */
  43
  44 class DALI_ADAPTOR_API Clipboard : public BaseHandle
  45 {
  46 public:
  47   /**
  48    * @brief Create an uninitialized Clipboard.
  49    *
  50    * this can be initialized with one of the derived Clipboard' New() methods
  51    */
  52   Clipboard();
  53
  54   /**
  55    * @brief Destructor
  56    *
  57    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  58    */
  59   ~Clipboard();
  60
  61   /**
  62    * @brief This constructor is used by Adaptor::GetClipboard().
  63    *
  64    * @param[in] clipboard A pointer to the clipboard.
  65    */
  66   explicit DALI_INTERNAL Clipboard(Internal::Adaptor::Clipboard* clipboard);
  67
  68   /**
  69    * @brief Retrieve a handle to the ClipboardEventNotifier instance.
  70    *
  71    * @return A handle to the Clipboard
  72    */
  73   static Clipboard Get();
  74
  75   /**
  76    * @brief Send the given string to the clipboard.
  77    *
  78    * @param[in] itemData string to send to clip board
  79    * @return bool true if the internal clip board sending was successful.
  80    */
  81   bool SetItem(const std::string& itemData);
  82
  83   /**
  84    * @brief Request clipboard service to retrieve an item
  85    *
  86    * Calling this method will trigger a signal from the clipboard event notifier.
  87    * @see Dali::ClipboardEventNotifier::ContentSelectedSignal()
  88    */
  89   void RequestItem();
  90
  91   /**
  92    * @brief Returns the number of item currently in the clipboard.
  93    *
  94    * @return unsigned int number of clipboard items
  95    */
  96   unsigned int NumberOfItems();
  97
  98   /**
  99    * @brief Show the clipboard window.
 100    */
 101   void ShowClipboard();
 102
 103   /**
 104    * @brief Hide the clipboard window.
 105    */
 106   void HideClipboard();
 107
 108   /**
 109   * @brief Retrieves the clipboard's visibility
 110   * @return bool true if the clipboard is visible.
 111   */
 112   bool IsVisible() const;
 113 };
 114 } // namespace Dali
 115
 116 #endif // DALI_CLIPBOARD_H