inc/FUiITouchModeChangedEventListener.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                FUiITouchModeChangedEventListener.h
  20  * @brief               This is the header file for the %ITouchModeChangedEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ITouchModeChangedEventListener interface. @n
  23  * If the touch mode of a device is changed, a method of this interface is called.
  24  * Therefore, if an application performs tasks related to the touch mode event, use the methods of this interface.
  25  *
  26  */
  27
  28 #ifndef _FUI_ITOUCH_MODE_CHANGED_EVENT_LISTENER_H_
  29 #define _FUI_ITOUCH_MODE_CHANGED_EVENT_LISTENER_H_
  30
  31 #include <FBaseRtIEventListener.h>
  32
  33 namespace Tizen {namespace Ui
  34 {
  35 class Control;
  36
  37 /**
  38  * @interface           ITouchModeChangedEventListener
  39  * @brief                       This interface implements the listener for the touch mode changed event.
  40  *
  41  * @since           2.0
  42  *
  43  * The %ITouchModeChangedEventListener interface is the listener interface for receiving touch mode change events.
  44  * @n
  45  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/event_listener.htm">Event Listeners</a>.
  46  */
  47 class _OSP_EXPORT_ ITouchModeChangedEventListener
  48         : virtual public Tizen::Base::Runtime::IEventListener
  49 {
  50 public:
  51         /**
  52          * This polymorphic destructor should be overridden if required.
  53          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  54          *
  55          * @since                               2.0
  56          */
  57         virtual ~ITouchModeChangedEventListener(void) {};
  58
  59         /**
  60          * Called when an action event occurs.
  61          *
  62          * @since                               2.0
  63          *
  64          * @param[in]   source              The source of the event
  65          * @param[in]   isInTouchMode   The current mode
  66          */
  67         virtual void OnTouchModeChanged(const Tizen::Ui::Control& source, bool isInTouchMode) = 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
  75         // prior notice.
  76         //
  77         virtual void ITouchModeChangedEventListener_Reserved1(void) {}
  78
  79         //
  80         // This method is for internal use only. Using this method can cause behavioral, security-related,
  81         // and consistency-related issues in the application.
  82         //
  83         // This method is reserved and may change its name at any time without
  84         // prior notice.
  85         //
  86         virtual void ITouchModeChangedEventListener_Reserved2(void) {}
  87
  88         //
  89         // This method is for internal use only. Using this method can cause behavioral, security-related,
  90         // and consistency-related issues in the application.
  91         //
  92         // This method is reserved and may change its name at any time without
  93         // prior notice.
  94         //
  95         virtual void ITouchModeChangedEventListener_Reserved3(void) {}
  96
  97 }; // ITouchModeChangedEventListener
  98
  99 } } // Tizen::Ui
 100
 101 #endif // _FUI_ITOUCH_MODE_CHANGED_EVENT_LISTENER_H_