notification-ex/icon_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_ICON_ITEM_H_
  18 #define NOTIFICATION_EX_ICON_ITEM_H_
  19
  20 #include <string>
  21 #include <memory>
  22 #include <list>
  23
  24 #include "notification-ex/image_item.h"
  25
  26 /**
  27  * @brief The class for IconItem type notification.
  28  * @details The class to make the notification with icon.
  29  * @since_tizen 5.5
  30  */
  31 namespace notification {
  32 namespace item {
  33
  34 class EXPORT_API IconItem : public ImageItem {
  35  public:
  36   /**
  37    * @brief Constructor
  38    * @since_tizen 5.5
  39    * @param[in] icon_path The icon path of IconItem
  40    * @param[in] action The action for IconItem
  41    */
  42   IconItem(std::string icon_path,
  43     std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  44
  45   /**
  46    * @brief Constructor
  47    * @since_tizen 5.5
  48    * @param[in] id The IconItem id
  49    * @param[in] icon_path The icon path of IconItem
  50    * @param[in] action The action for IconItem
  51    */
  52   IconItem(std::string id, std::string icon_path,
  53     std::shared_ptr<AbstractAction> action = std::shared_ptr<AbstractAction>({}));
  54
  55   /**
  56    * @brief Destructor
  57    * @since_tizen 5.5
  58    */
  59   virtual ~IconItem();
  60
  61   /**
  62    * @brief Gets the type of IconItem.
  63    * @since_tizen 5.5
  64    * @return AbstractItem::Type::Icon
  65    */
  66   int GetType() const override;
  67
  68  private:
  69   class Impl;
  70   std::unique_ptr<Impl> impl_;
  71 };  // class IconItem
  72
  73 }  // namespace item
  74 }  // namespace notification
  75 #endif  // NOTIFICATION_EX_ICON_ITEM_H_