Release version 0.7.18

[platform/core/api/notification.git] / notification-ex / button_item.h

diff --git a/notification-ex/button_item.h b/notification-ex/button_item.h
index 246ffc7..95880f3 100644 (file)
--- a/notification-ex/button_item.h
+++ b/notification-ex/button_item.h
@@ -26,19 +26,104 @@
 namespace notification {
 namespace item {
 
+/**
+ * @brief The class for ButtonItem type notification.
+ * @details The class to make the notification with button.
+ * @since_tizen 5.5
+ */
 class EXPORT_API ButtonItem : public AbstractItem {
  public:
+  /**
+   * @brief Constructor
+   * @since_tizen 5.5
+   * @param[in] id The ButtonItem id
+   * @param[in] title The title of ButtonItem
+   * @param[in] action The action for ButtonItem
+   */
+
   ButtonItem(std::string id, std::string title,
       std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
+
+  /**
+   * @brief Constructor
+   * @since_tizen 5.5
+   * @param[in] title The title of ButtonItem
+   * @param[in] action The action for ButtonItem
+   */
+
   ButtonItem(std::string title,
       std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
+
+  /**
+   * @brief Destructor
+   * @since_tizen 5.5
+   */
   virtual ~ButtonItem();
 
-  Bundle Serialize() override;
-  void Deserialize(Bundle b) override;
-  AbstractItem& FindByID(std::string id) override;
+  /**
+   * @brief Serialize the data of ButtonItem.
+   * @since_tizen 5.5
+   * @return Bundle type data
+   */
+  tizen_base::Bundle Serialize() const override;
+
+  /**
+   * @brief Deserialize the serialized data.
+   * @since_tizen 5.5
+   * @param[in] b The serialized Bundle data
+   */
+  void Deserialize(tizen_base::Bundle b) override;
+
+  /**
+   * @brief Checks the item type exist in this notification.
+   * @since_tizen 5.5
+   * @param[in] type notification item type
+   * @return true if the item type exists
+   */
+  bool IsItemTypeExist(int type) override;
+
+  /**
+   * @brief Gets the type of ButtonItem.
+   * @since_tizen 5.5
+   * @return AbstractItem::Type::Button
+   */
+  int GetType() const override;
+
+  /**
+   * @brief Gets the title of ButtonItem.
+   * @since_tizen 5.5
+   * @return The title of ButtonItem
+   */
   std::string GetTitle() const;
 
+  /**
+   * @brief Gets the image path of ButtonItem.
+   * @since_tizen 5.5
+   * @return The path of image
+   */
+  std::string GetImgPath() const;
+
+  /**
+   * @brief Sets the image path of ButtonItem.
+   * @since_tizen 5.5
+   * @param[in] path Image path
+   */
+  void SetImgPath(std::string path);
+
+  /**
+   * @brief Gets the contents of ButtonItem.
+   * @since_tizen 5.5
+   * @return The contents string
+   */
+  std::string GetContents() const;
+
+  /**
+   * @brief Sets the contents of ButtonItem.
+   * @since_tizen 5.5
+   * @param[in] contents The contents string
+   */
+  void SetContents(std::string contents);
+
  private:
   class Impl;
   std::unique_ptr<Impl> impl_;