src/ui/inc/FUiCtrl_IColorChangeEventListener.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_IColorChangeEventListener.h
  19  * @brief               This is the header file for the _IColorChangeEventListener class.
  20  *
  21  * This header file contains the declarations of the _IColorChangeEventListener 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_ICOLOR_CHANGE_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_INTERNAL_ICOLOR_CHANGE_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 Graphics
  38 {
  39 class Color;
  40 }} // Tizen::Graphics;
  41
  42 namespace Tizen { namespace Ui { namespace Controls
  43 {
  44 /**
  45  * @interface   _IColorChangeEventListener
  46  * @brief                       This interface implements the listener for color change events.
  47  * @since 2.0
  48  *
  49  * This is the listener interface for receiving color change events. The class that processes a color change event
  50  * implements this interface, and the object created with that class is registered with a UI control, using the control's
  51  * AddColorChangeEventListener() method. When the color change event occurs, the object's OnColorChanged() method is invoked.
  52  */
  53 class _IColorChangeEventListener
  54         : virtual public Tizen::Base::Runtime::IEventListener
  55 {
  56 // Operation
  57 public:
  58         /**
  59          * This is the destructor for this class.
  60          *
  61          * @since       1.0
  62          */
  63         virtual ~_IColorChangeEventListener(void) {}
  64
  65         /**
  66          * Notifies  when there is a change in Color. The color instance is passed as an input parameter.
  67          *
  68          * @since                               1.0
  69          * @param[in]   source          The source of the event
  70          * @param[in]           color           The color
  71          */
  72         virtual void OnColorChanged(const Tizen::Ui::_Control& source, const Tizen::Graphics::Color& color) = 0;
  73 };      // _IColorChangeEventListener
  74
  75 }}} // Tizen::Ui::Controls
  76
  77 #endif // _FUI_CTRL_INTERNAL_ICOLOR_CHANGE_EVENT_LISTENER_H_