summaryrefslogtreecommitdiff
path: root/notification-ex/button_item.h
blob: 95880f3dd493298f7d439c1b59145a4e0f007939 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef NOTIFICATION_EX_BUTTON_ITEM_H_
#define NOTIFICATION_EX_BUTTON_ITEM_H_

#include <string>
#include <memory>
#include <list>

#include "notification-ex/abstract_item.h"

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();

  /**
   * @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_;
};  // class ButtonItem

}  // namespace item
}  // namespace notification

#endif  // NOTIFICATION_EX_BUTTON_ITEM_H_