adaptors/wearable/watch/watch-time.h

   1 #ifndef __DALI_WATCH_TIME_H__
   2 #define __DALI_WATCH_TIME_H__
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <dali/public-api/dali-core.h>
  25
  26 namespace Dali
  27 {
  28 /**
  29  * @addtogroup dali_adaptor_framework
  30  * @{
  31  */
  32
  33 /**
  34  * @brief The WatchTime class is used to get time for the WatchApplication.
  35  *
  36  * A WatchTime has a time handle from watch application framework.
  37  * You can get time(hour, minute, second) on receiving timeTick signal
  38  * @SINCE_1_1.37
  39  */
  40 class DALI_IMPORT_API WatchTime
  41 {
  42 public:
  43
  44   /**
  45    * @brief Constructor
  46    * @SINCE_1_1.37
  47    */
  48   WatchTime();
  49
  50   /**
  51    * @brief Destructor
  52    * @SINCE_1_1.37
  53    */
  54   ~WatchTime();
  55
  56   /**
  57    * @brief return current hour
  58    *
  59    * @SINCE_1_1.37
  60    * @return the current hour
  61    * @pre The WatchTime needs to be initialized.
  62    */
  63   int GetHour() const;
  64
  65   /**
  66    * @brief return current hour24
  67    *
  68    * @SINCE_1_1.37
  69    * @return the current hour(the 24-hour clock)
  70    * @pre The WatchTime needs to be initialized.
  71    */
  72   int GetHour24() const;
  73
  74   /**
  75    * @brief return current minute
  76    *
  77    * @SINCE_1_1.37
  78    * @return the current minute
  79    * @pre The WatchTime needs to be initialized.
  80    */
  81   int GetMinute() const;
  82
  83   /**
  84    * @brief return current second
  85    *
  86    * @SINCE_1_1.37
  87    * @return the current second
  88    * @pre The WatchTime needs to be initialized.
  89    */
  90   int GetSecond() const;
  91
  92 public: // Not intended for application developers
  93   DALI_INTERNAL WatchTime(void *time_handle);
  94
  95 private:  // Internal Data
  96
  97   struct Impl;
  98   Impl* mImpl;
  99 };
 100
 101 /**
 102  * @}
 103  */
 104 } // namespace Dali
 105
 106 #endif // __DALI_WATCH_TIME_H__