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
37extern "C" {
38#endif
39
40/**
41 * Declare Ewk_Back_Forward_List_Item as Ewk_Object.
42 *
43 * @see Ewk_Object
44 */
45typedef struct EwkObject Ewk_Back_Forward_List_Item;
46
47/**
48 * Returns URL of the item.
49 *
50 * The returned URL may differ from the original URL (For example if the page was redirected).
51 *
52 * @see ewk_back_forward_list_item_original_url_get()
53 *
54 * @param item the back-forward list item instance
55 *
56 * @return the URL of the @a item or @c NULL in case of error. This pointer is
57 *         guaranteed to be eina_stringshare, so whenever possible
58 *         save yourself some cpu cycles and use
59 *         eina_stringshare_ref() instead of eina_stringshare_add() or
60 *         strdup()
61 */
62EAPI const char *ewk_back_forward_list_item_url_get(const Ewk_Back_Forward_List_Item *item);
63
64/**
65 * Returns title of the item.
66 *
67 * @param item the back-forward list item instance
68 *
69 * @return the title of the @a item or @c NULL in case of error. This pointer is
70 *         guaranteed to be eina_stringshare, so whenever possible
71 *         save yourself some cpu cycles and use
72 *         eina_stringshare_ref() instead of eina_stringshare_add() or
73 *         strdup()
74 */
75EAPI const char *ewk_back_forward_list_item_title_get(const Ewk_Back_Forward_List_Item *item);
76
77/**
78 * Returns original URL of the item.
79 *
80 * @see ewk_back_forward_list_item_url_get()
81 *
82 * @param item the back-forward list item instance
83 *
84 * @return the original URL of the @a item or @c NULL in case of error. This pointer is
85 *         guaranteed to be eina_stringshare, so whenever possible
86 *         save yourself some cpu cycles and use
87 *         eina_stringshare_ref() instead of eina_stringshare_add() or
88 *         strdup()
89 */
90EAPI const char *ewk_back_forward_list_item_original_url_get(const Ewk_Back_Forward_List_Item *item);
91
92#ifdef __cplusplus
93}
94#endif
95#endif // ewk_back_forward_list_item_h
96