notification-ex/entry_item.h

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef NOTIFICATION_EX_ENTRY_ITEM_H_
  18 #define NOTIFICATION_EX_ENTRY_ITEM_H_
  19
  20 #include <memory>
  21 #include <string>
  22
  23 #include "notification-ex/abstract_item.h"
  24
  25 #ifndef EXPORT_API
  26 #define EXPORT_API __attribute__((visibility("default")))
  27 #endif
  28
  29 namespace notification {
  30 namespace item {
  31
  32 /**
  33  * @brief The class for EntryItem type notification.
  34  * @details The class to make the notification with text input.
  35  * @since_tizen 5.5
  36  */
  37 class EXPORT_API EntryItem : public AbstractItem {
  38  public:
  39   /**
  40    * @brief Constructor
  41    * @since_tizen 5.5
  42    * @param[in] action The action for EntryItem
  43    */
  44   EntryItem(std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  45
  46   /**
  47    * @brief Constructor
  48    * @since_tizen 5.5
  49    * @param[in] id The EntryItem id
  50    * @param[in] action The action for EntryItem
  51    */
  52   EntryItem(std::string id,
  53       std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  54
  55   /**
  56    * @brief Destructor
  57    * @since_tizen 5.5
  58    */
  59   virtual ~EntryItem();
  60
  61   /**
  62    * @brief Serialize the data of EntryItem.
  63    * @since_tizen 5.5
  64    * @return Bundle type data
  65    */
  66   Bundle Serialize() const override;
  67
  68   /**
  69    * @brief Deserialize the serialized data.
  70    * @since_tizen 5.5
  71    * @param[in] b The serialized Bundle data
  72    */
  73   void Deserialize(Bundle b) override;
  74
  75   /**
  76    * @brief Finds the AbstractItem using by notification item id.
  77    * @since_tizen 5.5
  78    * @param[in] id notification item id
  79    * @return AbstractItem object
  80    */
  81   AbstractItem& FindByID(std::string id) override;
  82
  83   /**
  84    * @brief Checks the item type exist in this notification.
  85    * @since_tizen 5.5
  86    * @param[in] type notification item type
  87    * @return true if the item type exists
  88    */
  89   bool IsItemTypeExist(int type) override;
  90
  91   /**
  92    * @brief Gets the type of EntryItem.
  93    * @since_tizen 5.5
  94    * @return AbstractItem::Type::Entry
  95    */
  96   int GetType() const override;
  97
  98   /**
  99    * @brief Gets the text data of EntryItem.
 100    * @since_tizen 5.5
 101    * @return The text data
 102    */;
 103   std::string GetText() const;
 104
 105   /**
 106    * @brief Sets the text data of EntryItem.
 107    * @since_tizen 5.5
 108    * @param[in] The text data
 109    */
 110   void SetText(std::string text);
 111
 112   /**
 113    * @brief Gets the limit of text size.
 114    * @since_tizen 5.5
 115    * @return The limit of text size
 116    */
 117   int GetTextLimit() const;
 118
 119  private:
 120   class Impl;
 121   std::unique_ptr<Impl> impl_;
 122 };  // class EntryItem
 123
 124 }  // namespace item
 125 }  // namespace notification
 126 #endif  // NOTIFICATION_EX_ENTRY_ITEM_H_