summaryrefslogtreecommitdiff
path: root/notification-ex/text_item.h
blob: fadd3fc077215fae97824d9fd7bb7424a3bc8208 (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
/*
 * 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_TEXT_ITEM_H_
#define NOTIFICATION_EX_TEXT_ITEM_H_

#include <memory>
#include <string>

#include "notification-ex/abstract_item.h"

#ifndef EXPORT_API
#define EXPORT_API __attribute__((visibility("default")))
#endif

namespace notification {
namespace item {


/**
 * @brief The class for TextItem type notification.
 * @details The class to make the notification with text.
 * @since_tizen 5.5
 */
class EXPORT_API TextItem : public AbstractItem {
 public:
  /**
   * @brief Constructor
   * @since_tizen 5.5
   * @param[in] id The TextItem id
   * @param[in] text The text of TextItem
   * @param[in] hyperlink The hyperlink of TextItem
   * @param[in] action The action for TextItem
   */
  TextItem(std::string id, std::string text,
      std::string hyperlink = std::string(),
      std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));

  /**
   * @brief Destructor
   * @since_tizen 5.5
   */
  virtual ~TextItem();

  /**
   * @brief Gets the type of TextItem.
   * @since_tizen 5.5
   * @return AbstractItem::Type::Text
   */
  int GetType() const override;

  /**
   * @brief Serialize the data of TextItem.
   * @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 Sets the contents of TextItem.
   * @since_tizen 5.5
   * @param[in] contents the contents of TextItem
   */
  void SetContents(std::string contents);

  /**
   * @brief Gets the contents of TextItem.
   * @since_tizen 5.5
   * @return The text contents
   */
  std::string GetContents() const;

  /**
   * @brief Gets the hyperlink data of TextItem.
   * @since_tizen 5.5
   * @return The hyperlink data of TextItem
   */
  std::string GetHyperLink() const;

 private:
  class Impl;
  std::unique_ptr<Impl> impl_;
};  // class TextItem

}  // namespace item
}  // namespace notification
#endif  // NOTIFICATION_EX_TEXT_ITEM_H_