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    * @pre The WatchTime needs to be initialized.
  61    */
  62   int GetHour() const;
  63
  64   /**
  65    * @brief return current hour24
  66    *
  67    * @SINCE_1_1.37
  68    * @pre The WatchTime needs to be initialized.
  69    */
  70   int GetHour24() const;
  71
  72   /**
  73    * @brief return current minute
  74    *
  75    * @SINCE_1_1.37
  76    * @pre The WatchTime needs to be initialized.
  77    */
  78   int GetMinute() const;
  79
  80   /**
  81    * @brief return current second
  82    *
  83    * @SINCE_1_1.37
  84    * @pre The WatchTime needs to be initialized.
  85    */
  86   int GetSecond() const;
  87
  88 public: // Not intended for application developers
  89   DALI_INTERNAL WatchTime(void *time_handle);
  90
  91 private:  // Internal Data
  92
  93   struct Impl;
  94   Impl* mImpl;
  95 };
  96
  97 /**
  98  * @}
  99  */
 100 } // namespace Dali
 101
 102 #endif // __DALI_WATCH_TIME_H__