dali-toolkit/devel-api/controls/web-view/web-back-forward-list-item.h

   1 #ifndef DALI_TOOLKIT_WEB_BACK_FORWARD_LIST_ITEM_H
   2 #define DALI_TOOLKIT_WEB_BACK_FORWARD_LIST_ITEM_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  26
  27 namespace Dali
  28 {
  29 class WebEngineBackForwardListItem;
  30
  31 namespace Toolkit
  32 {
  33 /**
  34  * @addtogroup dali_toolkit_controls_web_view
  35  * @{
  36  */
  37
  38 /**
  39  * @brief WebBackForwardListItem is a class for back-forward list item of WebView.
  40  *
  41  *
  42  * For working WebBackForwardListItem, a Dali::WebBackForwardListItem should be provided.
  43  *
  44  */
  45 class DALI_TOOLKIT_API WebBackForwardListItem
  46 {
  47 public:
  48   /**
  49    * @brief Creates a WebBackForwardListItem.
  50    */
  51   WebBackForwardListItem(const Dali::WebEngineBackForwardListItem* item);
  52
  53   /**
  54    * @brief Destructor.
  55    */
  56   virtual ~WebBackForwardListItem() final;
  57
  58   /**
  59    * @brief Returns the URL of the item.
  60    *
  61    * @details The returned URL may differ from the original URL (For example,
  62    *          if the page is redirected).
  63    *
  64    * @return The URL of the @a item, otherwise "" in case of an error
  65    */
  66   std::string GetUrl() const;
  67
  68   /**
  69    * @brief Returns the title of the item.
  70    *
  71    * @return The title of the @a item, otherwise "" in case of an error
  72    */
  73   std::string GetTitle() const;
  74
  75   /**
  76    * @brief Returns the original URL of the item.
  77    *
  78    * @return The original URL of the @a item, otherwise "" in case of an error
  79    */
  80   std::string GetOriginalUrl() const;
  81
  82 private:
  83   const Dali::WebEngineBackForwardListItem* mWebEngineBackForwardListItem;
  84 };
  85
  86 /**
  87  * @}
  88  */
  89
  90 } // namespace Toolkit
  91
  92 } // namespace Dali
  93
  94 #endif // DALI_TOOLKIT_WEB_BACK_FORWARD_LIST_ITEM_H