adaptors/public-api/adaptor-framework/clipboard-event-notifier.h

   1 #ifndef __DALI_CLIPBOARD_EVENT_NOTIFIER_H__
   2 #define __DALI_CLIPBOARD_EVENT_NOTIFIER_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 <boost/function.hpp>
  23
  24 #include <dali/public-api/object/base-handle.h>
  25 #include <dali/public-api/signals/dali-signal.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 namespace Adaptor
  33 {
  34 class ClipboardEventNotifier;
  35 }
  36 }
  37
  38 /**
  39  * @brief The ClipboardEventNotifier provides signals when clipboard events are received from the device.
  40  */
  41 class DALI_IMPORT_API ClipboardEventNotifier : public BaseHandle
  42 {
  43 public:
  44
  45   // Typedefs
  46
  47   /**
  48    * @brief Clipboard event
  49    */
  50   typedef Signal< void ( ClipboardEventNotifier& ) > ClipboardEventSignalType;
  51
  52   /**
  53    * @brief Create an uninitialized handle.
  54    *
  55    * This can be initialized by getting the notifier from Dali::Adaptor.
  56    */
  57   ClipboardEventNotifier();
  58
  59   /**
  60    * @brief Retrieve a handle to the ClipboardEventNotifier instance.
  61    *
  62    * @return A handle to the ClipboardEventNotifier
  63    */
  64   static ClipboardEventNotifier Get();
  65
  66   /**
  67    * @brief Destructor
  68    *
  69    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  70    */
  71   ~ClipboardEventNotifier();
  72
  73   /**
  74    * @brief Returns the selected content.
  75    * @return A reference to the string representing the selected content.
  76    */
  77   const std::string& GetContent() const;
  78
  79   /**
  80    * @brief Sets the selected content.
  81    * @param[in] content  A string that represents the content that has been selected.
  82    */
  83   void SetContent( const std::string& content );
  84
  85   /**
  86    * @brief Clears the stored content.
  87    */
  88   void ClearContent();
  89
  90   /**
  91    * @brief Called when content is selected in the clipboard.
  92    */
  93   void EmitContentSelectedSignal();
  94
  95 public:  // Signals
  96
  97   /**
  98    * @brief This is emitted when content is selected from the clipboard.
  99    *
 100    * A callback of the following type may be connected:
 101    * @code
 102    *   void YourCallback( ClipboardEventNotifier& notifier );
 103    * @endcode
 104    * @return The signal to connect to.
 105    */
 106   ClipboardEventSignalType& ContentSelectedSignal();
 107
 108 public: // Not intended for application developers
 109
 110   /**
 111    * @brief This constructor is used by ClipboardEventNotifier::Get().
 112    *
 113    * @param[in] notifier A pointer to the drag and drop notifier.
 114    */
 115   explicit DALI_INTERNAL ClipboardEventNotifier( Internal::Adaptor::ClipboardEventNotifier* notifier );
 116 };
 117
 118 } // namespace Dali
 119
 120 #endif // __DALI_CLIPBOARD_EVENT_NOTIFIER_H__