src/ui/inc/FUiCtrl_IAdjustmentEventListener.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                FUiCtrl_IAdjustmentEventListener.h
  19  * @brief               This is the header file for the _IAdjustmentEventListener class.
  20  *
  21  * This header file contains the declarations of the _IAdjustmentEventListener class.
  22  * If a change event is generated, a method of this class is called.
  23  * So, if applications do jobs related to change events, use the methods of this class.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_INTERNAL_IADJUSTMENT_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_INTERNAL_IADJUSTMENT_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBaseObject.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34 class _Control;
  35 }} // Tizen::Ui
  36
  37 namespace Tizen { namespace Ui { namespace Controls
  38 {
  39 /**
  40  * @interface   _IAdjustmentEventListener
  41  * @brief       This interface implements the listener for adjustment events.
  42  * @since       1.0
  43  *
  44  * The _IAdjustmentEventListener interface receives adjustment events which are fired when the knob of a Slider moves. The class that is
  45  * interested in processing an adjustment event implements this interface, and the object created with that class
  46  * is registered with a UI control, using the control's AddAdjustmentEventListener() method. When adjustment event occurs,
  47  * the object's OnAdjustmentValueChanged() method is invoked.
  48  */
  49 class _IAdjustmentEventListener
  50         : virtual public Tizen::Base::Runtime::IEventListener
  51 {
  52 // Operation
  53 public:
  54         /**
  55          * This is the destructor for this class.
  56          *
  57          * @since       1.0
  58          */
  59         virtual ~_IAdjustmentEventListener(void) {}
  60
  61         /**
  62          * Notifies when a change event occurs.
  63          *
  64          * @since                               1.0
  65          * @param[in]   source          The source of the event
  66          * @param[in]           adjustment                      The adjustment value
  67          */
  68         virtual void OnAdjustmentValueChanged(const Tizen::Ui::_Control& source, int adjustment) = 0;
  69
  70 };      // _IAdjustmentEventListener
  71
  72 }}} // Tizen::Ui::Controls
  73
  74 #endif // _FUI_CTRL_INTERNAL_IADJUSTMENT_EVENT_LISTENER_H_