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