automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-clipboard.h

   1 #ifndef  TOOLKIT_CLIPBOARD_H
   2 #define  TOOLKIT_CLIPBOARD_H
   3
   4 /*
   5  * Copyright (c) 2019 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 #define DALI_CLIPBOARD_H
  22
  23 // EXTERNAL INCLUDES
  24 #include <dali/public-api/math/rect.h>
  25 #include <dali/public-api/object/base-handle.h>
  26
  27 namespace Dali DALI_IMPORT_API
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32
  33 namespace Adaptor
  34 {
  35 class Clipboard;
  36 }
  37 }
  38
  39 /**
  40  * The Clipboard can operate using various funtion.
  41  * Clipboard can manage it's item and set show / hide status.
  42  */
  43 class Clipboard : public BaseHandle
  44 {
  45 public:
  46   /**
  47    * Create an uninitialized Clipboard;
  48    *  this can be initialized with one of the derived Clipboard' New() methods
  49    */
  50   Clipboard();
  51
  52   /**
  53    * Non virtual destructor.
  54    */
  55   ~Clipboard();
  56
  57   /**
  58    * This constructor is used by Adaptor::GetClipboard().
  59    * @param[in] clipboard A pointer to the clipboard.
  60    */
  61   Clipboard( Internal::Adaptor::Clipboard* clipboard );
  62
  63   /**
  64    * Retrieve a handle to the ClipboardEventNotifier instance
  65    * @return A handle to the Clipboard
  66    */
  67   static Clipboard Get();
  68
  69   /**
  70    * @brief Checks whether the clipboard is available.
  71    *
  72    * @return true, if it is available, false otherwise.
  73    */
  74   static bool IsAvailable();
  75
  76   /**
  77    * Send the given string to the clipboard
  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    * Request clipboard service to retrieve an item
  85    */
  86   void RequestItem();
  87
  88   /**
  89    * Returns the number of item currently in the clipboard
  90    * @return unsigned int number of clipboard items
  91    */
  92   unsigned int NumberOfItems();
  93
  94   /**
  95    * Show the clipboard window
  96    */
  97   void ShowClipboard();
  98
  99   /**
 100    * Hide the clipboard window
 101    */
 102   void HideClipboard();
 103
 104   /**
 105   * @brief Retrieves the clipboard's visibility
 106   * @return bool true if the clipboard is visible.
 107   */
 108   bool IsVisible() const;
 109
 110 };
 111 } // namespace Dali
 112
 113 #endif // TOOLKIT_CLIPBOARD_H