Source/WebKit2/UIProcess/API/efl/ewk_back_forward_list_item.h

   1 /*
   2  * Copyright (C) 2012 Intel Corporation. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 /**
  27  * @file    ewk_back_forward_list_item.h
  28  * @brief   Describes the Ewk Back Forward List Item API.
  29  */
  30
  31 #ifndef ewk_back_forward_list_item_h
  32 #define ewk_back_forward_list_item_h
  33
  34 #include <Eina.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /** Creates a type name for Ewk_Back_Forward_List_Item */
  41 typedef struct Ewk_Back_Forward_List_Item Ewk_Back_Forward_List_Item;
  42
  43 /**
  44  * Increases the reference count of the given object.
  45  *
  46  * @param item the back-forward list item instance to increase the reference count
  47  *
  48  * @return a pointer to the object on success, @c NULL otherwise.
  49  */
  50 EAPI Ewk_Back_Forward_List_Item *ewk_back_forward_list_item_ref(Ewk_Back_Forward_List_Item *item);
  51
  52 /**
  53  * Decreases the reference count of the given object, possibly freeing it.
  54  *
  55  * When the reference count reaches 0, the item is freed.
  56  *
  57  * @param item the back-forward list item instance to decrease the reference count
  58  */
  59 EAPI void ewk_back_forward_list_item_unref(Ewk_Back_Forward_List_Item *item);
  60
  61 /**
  62  * Returns URL of the item.
  63  *
  64  * The returned URL may differ from the original URL (For example if the page was redirected).
  65  *
  66  * @see ewk_back_forward_list_item_original_url_get()
  67  *
  68  * @param item the back-forward list item instance
  69  *
  70  * @return the URL of the @a item or @c NULL in case of error. This pointer is
  71  *         guaranteed to be eina_stringshare, so whenever possible
  72  *         save yourself some cpu cycles and use
  73  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  74  *         strdup()
  75  */
  76 EAPI const char *ewk_back_forward_list_item_url_get(const Ewk_Back_Forward_List_Item *item);
  77
  78 /**
  79  * Returns title of the item.
  80  *
  81  * @param item the back-forward list item instance
  82  *
  83  * @return the title of the @a item or @c NULL in case of error. This pointer is
  84  *         guaranteed to be eina_stringshare, so whenever possible
  85  *         save yourself some cpu cycles and use
  86  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  87  *         strdup()
  88  */
  89 EAPI const char *ewk_back_forward_list_item_title_get(const Ewk_Back_Forward_List_Item *item);
  90
  91 /**
  92  * Returns original URL of the item.
  93  *
  94  * @see ewk_back_forward_list_item_url_get()
  95  *
  96  * @param item the back-forward list item instance
  97  *
  98  * @return the original URL of the @a item or @c NULL in case of error. This pointer is
  99  *         guaranteed to be eina_stringshare, so whenever possible
 100  *         save yourself some cpu cycles and use
 101  *         eina_stringshare_ref() instead of eina_stringshare_add() or
 102  *         strdup()
 103  */
 104 EAPI const char *ewk_back_forward_list_item_original_url_get(const Ewk_Back_Forward_List_Item *item);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109 #endif // ewk_back_forward_list_item_h