src/ui/inc/FUiCtrl_IDateTimeChangeEventListener.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_IDateTimeChangeEventListener.h
  19  * @brief               This is the header file for the _IDateTimeChangeEventListener interface.
  20  */
  21
  22 #ifndef _FUI_CTRL_INTERNAL_IDATETIME_CHANGE_EVENT_LISTENER_H_
  23 #define _FUI_CTRL_INTERNAL_IDATETIME_CHANGE_EVENT_LISTENER_H_
  24
  25 // Includes
  26 #include <FBaseRtIEventListener.h>
  27 #include <FBaseObject.h>
  28
  29 namespace Tizen { namespace Ui
  30 {
  31 class _Control;
  32 }} // Tizen::Ui
  33
  34 namespace Tizen {namespace Ui { namespace Controls
  35 {
  36
  37 /**
  38  * @interface   _IDateTimeChangeEventListener
  39  * @brief                       This interface implements the listener for Date and Time change events.
  40  * @since                       1.0
  41  *
  42  * The listener interface for receiving date and time change events. The class that processes date and time change event
  43  * implements this interface, and the object created with that class is registered with a UI control, using the control's
  44  * AddDateTimeChangeEventListener() method. When the action event occurs, that instance's OnDateTimeChanged() method is invoked.
  45  */
  46 class _IDateTimeChangeEventListener
  47         : virtual public Tizen::Base::Runtime::IEventListener
  48 {
  49 // Operation
  50 public:
  51         /**
  52          * This is the destructor for this class.
  53          *
  54          * @since                       1.0
  55          */
  56         virtual ~_IDateTimeChangeEventListener(void) {}
  57
  58         /**
  59          * Notifies when there is a change in DateTime . The changed values of day, month, year, hour and minute are passed as input parameters.
  60          *
  61          * @since                               1.0
  62          * @param[in]   source              The source of the event
  63          * @param[in]           year                    The year value
  64          * @param[in]           month                   The month value
  65          * @param[in]           day                             The day value
  66          * @param[in]           hour                    The hour value
  67          * @param[in]           minute                  The minute value
  68          *
  69          */
  70         virtual void OnDateTimeChanged(const Tizen::Ui::_Control& source, int year, int month, int day, int hour, int minute) = 0;
  71
  72
  73         /**
  74         * Notifies when date and time change is canceled.
  75         *
  76         * @since                        1.0
  77         * @param[in]    source          The source of the event
  78         */
  79         virtual void OnDateTimeChangeCanceled(const Tizen::Ui::_Control& source) = 0;
  80 };
  81
  82 }}} // Tizen::Ui::Controls
  83
  84 #endif // _FUI_CTRL_INTERNAL_IDATETIME_CHANGE_EVENT_LISTENER_H_