inc/FUiCtrlISliderEventListener.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                FUiCtrlISliderEventListener.h
  19  * @brief               This is the header file for the %ISliderEventListener interface.
  20  *
  21  * This header file contains the declarations of the %ISliderEventListener interface. @n
  22  * If a change event is generated, a method of this interface is called. @n
  23  * So, if the applications perform tasks related to change events, use the methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_ISLIDER_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_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  *
  40  * @since               2.0
  41  *
  42  * The %ISliderEventListener interface is the listener interface for receiving Slider events, which are fired when the slider knob moves.
  43  * The class that processes a slider event implements this interface, and the instance created with that class is registered with
  44  * a UI control, using the control's AddSliderEventListener() method. When the slider event occurs, the OnSliderBarMoved()
  45  *  method of that instance is invoked.
  46  *
  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 class ISliderEventListener
  50         : public Tizen::Base::Runtime::IEventListener
  51 {
  52 // Operation
  53 public:
  54         /**
  55          * This is the destructor for this class.
  56          *
  57          * @since 2.0
  58          */
  59         virtual ~ISliderEventListener(void) {}
  60
  61         /**
  62          * Called when the Slider bar moves.
  63          *
  64          * @since     2.0
  65          *
  66          * @param[in] source    The source of the event
  67          * @param[in] value     The current value indicated by the knob
  68          * @remarks   This event is fired when the knob is moved until the user releases the knob.
  69          */
  70         virtual void OnSliderBarMoved(Tizen::Ui::Controls::Slider& source, int value) = 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 prior notice.
  78         //
  79         // @since      2.0
  80         //
  81         virtual void ISliderEventListener_Reserved1(void) {}
  82
  83         //
  84         // This method is for internal use only.
  85         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  86         //
  87         // This method is reserved and may change its name at any time without prior notice.
  88         //
  89         // @since      2.0
  90         //
  91         virtual void ISliderEventListener_Reserved2(void) {}
  92
  93         //
  94         // This method is for internal use only.
  95         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  96         //
  97         // This method is reserved and may change its name at any time without prior notice.
  98         //
  99         // @since      2.0
 100         //
 101         virtual void ISliderEventListener_Reserved3(void) {}
 102
 103 };      // ISliderEventListener
 104
 105 }}} // Tizen::Ui::Controls
 106
 107 #endif // _FUI_CTRL_ISLIDER_EVENT_LISTENER_H_