inc/FUiIClipboardPopupEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FUiIClipboardPopupEventListener.h
  20  * @brief               This is the header file for the %IClipboardPopupEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IClipboardPopupEventListener interface. @n
  23  * If the item event is generated, a method of this interface will be called. @n
  24  * The applications that perform tasks related to the item event, must call methods of this interface.
  25  */
  26
  27 #ifndef _FUI_ICLIPBOARD_POPUP_EVENT_LISTENER_H_
  28 #define _FUI_ICLIPBOARD_POPUP_EVENT_LISTENER_H_
  29
  30 #include <FBaseRtIEventListener.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34 class ClipboardItem;
  35
  36 /**
  37  * @interface   IClipboardPopupEventListener
  38  * @brief               This interface defines the listener for clipboard pop-up events.
  39  *
  40  * @since               2.0
  41  *
  42  * The %IClipboardPopupEventListener interface is the listener interface for receiving clipboard pop-up events.
  43  * @n
  44  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/clipboard.htm">Clipboard</a>.
  45  */
  46 class _OSP_EXPORT_ IClipboardPopupEventListener
  47         : virtual public Tizen::Base::Runtime::IEventListener
  48 {
  49 public:
  50         /**
  51          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  52          *
  53          * @since     2.0
  54          */
  55         virtual ~IClipboardPopupEventListener(void) {}
  56
  57         /**
  58          * Called when the clipboard popup is closed by user interaction.
  59          *
  60          * @since       2.0
  61          *
  62          * @param[in]   pClipboardItem  The pointer to ClipboardItem that
  63          *                                  is selected, @n
  64          *                                  else @c null if no item is selected
  65          * @remarks     @c pClipboardItem is deleted by the system after this method call.
  66          */
  67         virtual void OnClipboardPopupClosed(const ClipboardItem* pClipboardItem) = 0;
  68
  69 protected:
  70         //
  71         // This method is for internal use only. Using this method can cause behavioral, security-related,
  72         // and consistency-related issues in the application.
  73         //
  74         // This method is reserved and may change its name at any time without prior notice.
  75         //
  76         virtual void IClipboardPopupEventListener_Reserved1(void) {}
  77
  78         //
  79         // This method is for internal use only. Using this method can cause behavioral, security-related,
  80         // and consistency-related issues in the application.
  81         //
  82         // This method is reserved and may change its name at any time without prior notice.
  83         //
  84         virtual void IClipboardPopupEventListener_Reserved2(void) {}
  85
  86         //
  87         // This method is for internal use only. Using this method can cause behavioral, security-related,
  88         // and consistency-related issues in the application.
  89         //
  90         // This method is reserved and may change its name at any time without prior notice.
  91         //
  92         virtual void IClipboardPopupEventListener_Reserved3(void) {}
  93 }; // IClipboardPopupEventListener
  94
  95 }} // Tizen::Ui
  96
  97 #endif //_FUI_ICLIPBOARD_POPUP_EVENT_LISTENER_H_