src/ui/inc/FUiCtrl_ISliderEventListener.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_ISliderEventListener.h
  19  * @brief               This is the header file for the _ISliderEventListener class.
  20  *
  21  * This header file contains the declarations of the _ISliderEventListener 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 _FUICTRL_INTERNAL_ISLIDER_EVENT_LISTENER_H_
  27 #define _FUICTRL_INTERNAL_ISLIDER_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBaseObject.h>
  31
  32 namespace Tizen { namespace Ui { namespace Controls
  33 {
  34 class _Slider;
  35
  36 /**
  37  * @interface   _ISliderEventListener
  38  * @brief                       This interface implements the listener for all slider events.
  39  * @since                       2.0
  40  *
  41  * The _ISliderEventListener interface receives slider events which are fired when the knob of a Slider moves.
  42  * The class that is interested in processing an slider event implements this interface, and the object created
  43  * with that class is registered with a UI control, using the control's AddSliderEventListener() method.
  44  * When slider event occurs, the object's OnSliderBarMoved() method is invoked.
  45  */
  46 class _ISliderEventListener
  47         : virtual public Tizen::Base::Runtime::IEventListener
  48 {
  49 // Operation
  50 public:
  51         /**
  52          * This is the destructor for this class.
  53          *
  54          * @since 2.0
  55          */
  56         virtual ~_ISliderEventListener(void) {}
  57
  58         /**
  59          * Notifies that the Slider bar moved.
  60          *
  61          * @since     2.0
  62          * @param[in] source  The source of the event
  63          * @param[in] value   The current value indicated by the knob
  64          * @remarks   This event is fired when the knob is moved until the user releases
  65          *            the knob.
  66          */
  67         virtual void OnSliderBarMoved(Tizen::Ui::Controls::_Slider& source, int value) = 0;
  68
  69 };      // _ISliderEventListener
  70
  71 }}} // Tizen::Ui::Controls
  72
  73 #endif // _FUICTRL_INTERNAL_ISLIDER_EVENT_LISTENER_H_