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
  30 class WebEngineBackForwardListItem;
  31
  32 namespace Toolkit
  33 {
  34
  35 /**
  36  * @addtogroup dali_toolkit_controls_web_view
  37  * @{
  38  */
  39
  40 /**
  41  * @brief WebBackForwardListItem is a class for back-forward list item of WebView.
  42  *
  43  *
  44  * For working WebBackForwardListItem, a Dali::WebBackForwardListItem should be provided.
  45  *
  46  */
  47 class DALI_TOOLKIT_API WebBackForwardListItem
  48 {
  49 public:
  50   /**
  51    * @brief Creates a WebBackForwardListItem.
  52    */
  53   WebBackForwardListItem( const Dali::WebEngineBackForwardListItem* item );
  54
  55   /**
  56    * @brief Destructor.
  57    */
  58   virtual ~WebBackForwardListItem() final;
  59
  60   /**
  61    * @brief Returns the URL of the item.
  62    *
  63    * @details The returned URL may differ from the original URL (For example,
  64    *          if the page is redirected).
  65    *
  66    * @return The URL of the @a item, otherwise "" in case of an error
  67    */
  68   std::string GetUrl() const;
  69
  70   /**
  71    * @brief Returns the title of the item.
  72    *
  73    * @return The title of the @a item, otherwise "" in case of an error
  74    */
  75   std::string GetTitle() const;
  76
  77   /**
  78    * @brief Returns the original URL of the item.
  79    *
  80    * @return The original URL of the @a item, otherwise "" in case of an error
  81    */
  82   std::string GetOriginalUrl() const;
  83
  84 private:
  85
  86   const Dali::WebEngineBackForwardListItem* mWebEngineBackForwardListItem;
  87 };
  88
  89 /**
  90  * @}
  91  */
  92
  93 } // namespace Toolkit
  94
  95 } // namespace Dali
  96
  97 #endif // DALI_TOOLKIT_WEB_BACK_FORWARD_LIST_ITEM_H