inc/FUiCtrlISliderEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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                FUiCtrlISliderEventListener.h
  20  * @brief               This is the header file for the %ISliderEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ISliderEventListener interface. @n
  23  * If a change event is generated, a method of this interface is called. @n
  24  * So, if the applications perform tasks related to change events, use the methods of this interface.
  25  *
  26  */
  27 #ifndef _FUI_CTRL_ISLIDER_EVENT_LISTENER_H_
  28 #define _FUI_CTRL_ISLIDER_EVENT_LISTENER_H_
  29
  30 #include <FBaseRtIEventListener.h>
  31 #include <FBaseObject.h>
  32
  33 namespace Tizen { namespace Ui { namespace Controls
  34 {
  35 class Slider;
  36
  37 /**
  38  * @interface   ISliderEventListener
  39  * @brief               This interface implements the listener for all slider events.
  40  *
  41  * @since               2.0
  42  *
  43  * The %ISliderEventListener interface is the listener interface for receiving Slider events, which are fired when the slider knob moves.
  44  * The class that processes a slider event implements this interface, and the instance created with that class is registered with
  45  * a UI control, using the control's AddSliderEventListener() method. When the slider event occurs, the OnSliderBarMoved()
  46  *  method of that instance is invoked.
  47  *
  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 class ISliderEventListener
  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 ~ISliderEventListener(void) {}
  61
  62         /**
  63          * Called when the Slider bar moves.
  64          *
  65          * @since     2.0
  66          *
  67          * @param[in] source    The source of the event
  68          * @param[in] value     The current value indicated by the knob
  69          * @remarks   This event is fired when the knob is moved until the user releases the knob.
  70          */
  71         virtual void OnSliderBarMoved(Tizen::Ui::Controls::Slider& source, int value) = 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 prior notice.
  79         //
  80         // @since      2.0
  81         //
  82         virtual void ISliderEventListener_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 prior notice.
  89         //
  90         // @since      2.0
  91         //
  92         virtual void ISliderEventListener_Reserved2(void) {}
  93
  94         //
  95         // This method is for internal use only.
  96         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  97         //
  98         // This method is reserved and may change its name at any time without prior notice.
  99         //
 100         // @since      2.0
 101         //
 102         virtual void ISliderEventListener_Reserved3(void) {}
 103
 104 };      // ISliderEventListener
 105
 106 }}} // Tizen::Ui::Controls
 107
 108 #endif // _FUI_CTRL_ISLIDER_EVENT_LISTENER_H_