inc/FUiIDateChangeEventListener.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 /**
  19  * @file                FUiIDateChangeEventListener.h
  20  * @brief               This is the header file for the %IDateChangeEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IDateChangeEventListener interface.
  23  * If a change event is generated, a method of this interface is called.
  24  * So, for tasks related to the change events, use the methods of this interface.
  25  *
  26  */
  27 #ifndef _FUI_IDATE_CHANGE_EVENT_LISTENER_H_
  28 #define _FUI_IDATE_CHANGE_EVENT_LISTENER_H_
  29
  30 // Includes
  31 #include <FBaseRtIEventListener.h>
  32 #include <FBaseObject.h>
  33
  34 namespace Tizen { namespace Ui
  35 {
  36 class Control;
  37 } }
  38
  39 namespace Tizen {namespace Ui
  40 {
  41
  42 /**
  43  * @interface   IDateChangeEventListener
  44  * @brief               This interface implements the listener for Date change events.
  45  *
  46  * @since               2.0
  47  *
  48  * The %IDateChangeEventListener interface is the listener interface for receiving date change events.
  49  * The class that processes a date change event implements this interface, and the instance created with that class is registered
  50  * with a UI control, using the control's AddDateChangeEventListener() method. When the date change event occurs, the
  51  * OnDateChanged() method of that instance is invoked.
  52  * @n
  53  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_edittime_editdate.htm">EditDate and EditTime</a> and <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_datepicker.htm">DatePicker, TimePicker, and DateTimePicker</a>.
  54  */
  55 class _OSP_EXPORT_ IDateChangeEventListener
  56         : public Tizen::Base::Runtime::IEventListener
  57 {
  58 // Operation
  59 public:
  60         /**
  61          * This is the destructor for this class.
  62          *
  63          * @since                       2.0
  64          */
  65         virtual ~IDateChangeEventListener(void) {}
  66
  67         /**
  68          * Called when there is a change in the date. @n
  69          * The changed values of the year, month, and day are passed as input parameters.
  70          *
  71          * @since               2.0
  72          *
  73          * @param[in]   source          The source of the event
  74          * @param[in]   year            The year
  75          * @param[in]   month           The month
  76          * @param[in]   day                     The day
  77          */
  78         virtual void OnDateChanged(const Tizen::Ui::Control& source, int year, int month, int day) = 0;
  79
  80
  81         /**
  82         * Called when the change in date is canceled.
  83         *
  84         * @since                2.0
  85         *
  86         * @param[in]    source          The source of the event
  87         */
  88         virtual void OnDateChangeCanceled(const Tizen::Ui::Control& source) = 0;
  89
  90 protected:
  91         //
  92         // This method is for internal use only.
  93         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  94         //
  95         // This method is reserved and may change its name at any time without
  96         // prior notice.
  97         //
  98         // @since      2.0
  99         //
 100         virtual void IDateChangeEventListener_Reserved1(void) {}
 101
 102         //
 103         // This method is for internal use only.
 104         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 105         //
 106         // This method is reserved and may change its name at any time without
 107         // prior notice.
 108         //
 109         // @since      2.0
 110         //
 111         virtual void IDateChangeEventListener_Reserved2(void) {}
 112
 113         //
 114         // This method is for internal use only.
 115         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 116         //
 117         // This method is reserved and may change its name at any time without
 118         // prior notice.
 119         //
 120         // @since      2.0
 121         //
 122         virtual void IDateChangeEventListener_Reserved3(void) {}
 123
 124 }; // IDateChangeEventListener
 125
 126 }}  // Tizen::Ui
 127
 128 #endif // _FUI_IDATE_CHANGE_EVENT_LISTENER_H_