inc/FUiIAdjustmentEventListener.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  * @file                FUiIAdjustmentEventListener.h
  19  * @brief               This is the header file for the %IAdjustmentEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IAdjustmentEventListener interface. @n
  22  * If a change event is generated, a method of this interface is called. @n
  23  * So, for tasks related to change events, use the methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_IADJUSTMENT_EVENT_LISTENER_H_
  27 #define _FUI_IADJUSTMENT_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBaseObject.h>
  31
  32 namespace Tizen {namespace Ui
  33 {
  34 class Control;
  35
  36 /**
  37  * @interface   IAdjustmentEventListener
  38  * @brief               This interface implements the listener for adjustment events.
  39  *
  40  * @since               2.0
  41  *
  42  * The %IAdjustmentEventListener interface is the listener interface for receiving adjustment events, which
  43  * are fired when the knob of a Slider moves. The class that processes an adjustment event implements this interface, and the
  44  * instance created with that class is registered with a UI control, using the control's AddAdjustmentEventListener() method.
  45  * When the adjustment event occurs, the OnAdjustmentValueChanged() method of that instance is invoked.
  46  * @n
  47  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_slider.htm">Slider</a>.
  48
  49  */
  50 class IAdjustmentEventListener
  51         : public Tizen::Base::Runtime::IEventListener
  52 {
  53 // Operation
  54 public:
  55         /**
  56          * This is the destructor for this class.
  57          *
  58          * @since       2.0
  59          */
  60         virtual ~IAdjustmentEventListener(void) {}
  61
  62         /**
  63          * Called when a change event occurs.
  64          *
  65          * @since               2.0
  66          *
  67          * @param[in]   source                  The source of the event
  68          * @param[in]   adjustment              The adjustment value
  69          */
  70         virtual void OnAdjustmentValueChanged(const Tizen::Ui::Control& source, int adjustment) = 0;
  71
  72 protected:
  73         //
  74         // This method is for internal use only.
  75         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  76         //
  77         // This method is reserved and may change its name at any time without
  78         // without prior notice.
  79         //
  80         // @since      2.0
  81         //
  82         virtual void IAdjustmentEventListener_Reserved1(void) {}
  83
  84         //
  85         // This method is for internal use only.
  86         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  87         //
  88         // This method is reserved and may change its name at any time without
  89         // without prior notice.
  90         //
  91         // @since      2.0
  92         //
  93         virtual void IAdjustmentEventListener_Reserved2(void) {}
  94
  95         //
  96         // This method is for internal use only.
  97         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  98         //
  99         // This method is reserved and may change its name at any time without
 100         // without prior notice.
 101         //
 102         // @since      2.0
 103         //
 104         virtual void IAdjustmentEventListener_Reserved3(void) {}
 105
 106 };      // IAdjustmentEventListener
 107
 108 }}      // Tizen::Ui
 109
 110 #endif // _FUI_IADJUSTMENT_EVENT_LISTENER_H_