inc/FShellIAppWidgetViewEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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        FShellIAppWidgetViewEventListener.h
  20  * @brief       This is the header file for the %IAppWidgetViewEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IAppWidgetViewEventListener interface.
  23  */
  24
  25 #ifndef _FSHELL_IAPP_WIDGET_VIEW_EVENT_LISTENER_H_
  26 #define _FSHELL_IAPP_WIDGET_VIEW_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace Shell
  31 {
  32
  33 class AppWidgetView;
  34
  35 /*
  36  * @interface   IAppWidgetViewEventListener
  37  * @brief               This interface defines a listener for the AppWidgetView that receives AppWidgetProvider removed event.
  38  *
  39  * @since       2.1
  40  *
  41  * The %IAppWidgetViewEventListener interface defines a listener for the AppWidgetView that receives AppWidgetProvider removed event.
  42  */
  43 class _OSP_EXPORT_ IAppWidgetViewEventListener
  44         : public Tizen::Base::Runtime::IEventListener
  45 {
  46 public:
  47         /*\r
  48          * This polymorphic destructor should be overridden if required.\r
  49          * This way, the destructors of the derived classes are called when the destructor of this interface is called.\r
  50          *\r
  51          * @since       2.1\r
  52          */
  53         virtual ~IAppWidgetViewEventListener(void) {}
  54
  55         /*\r
  56          * Called when a AppWidgetProvider instance is about to be removed. @n
  57          *\r
  58          * @since 2.1\r
  59          *\r
  60          * @param[in]  appWidgetView    The source of the event
  61          */\r
  62         virtual void OnAppWidgetProviderRemoved(AppWidgetView& appWidgetView) = 0;
  63
  64 protected:
  65         //\r
  66         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  67         // and consistency-related issues in the application.\r
  68         //\r
  69         // Following method is reserved and may change its name at any time without prior notice.\r
  70         //\r
  71         virtual void IAppWidgetViewEventListener_Reserved1(void) {}\r
  72 \r
  73         //\r
  74         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  75         // and consistency-related issues in the application.\r
  76         //\r
  77         // Following method is reserved and may change its name at any time without prior notice.\r
  78         //\r
  79         virtual void IAppWidgetViewEventListener_Reserved2(void) {}\r
  80 \r
  81         //\r
  82         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  83         // and consistency-related issues in the application.\r
  84         //\r
  85         // Following method is reserved and may change its name at any time without prior notice.\r
  86         //\r
  87         virtual void IAppWidgetViewEventListener_Reserved3(void) {}\r
  88 \r
  89         //\r
  90         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  91         // and consistency-related issues in the application.\r
  92         //\r
  93         // Following method is reserved and may change its name at any time without prior notice.\r
  94         //\r
  95         virtual void IAppWidgetViewEventListener_Reserved4(void) {}\r
  96 \r
  97         //\r
  98         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  99         // and consistency-related issues in the application.\r
 100         //\r
 101         // Following method is reserved and may change its name at any time without prior notice.\r
 102         //\r
 103         virtual void IAppWidgetViewEventListener_Reserved5(void) {}
 104 };
 105
 106 }} // Tizen::Shell
 107
 108 #endif /* _FSHELL_IAPP_WIDGET_VIEW_EVENT_LISTENER_H_ */