Source/WebKit2/UIProcess/API/efl/ewk_navigation_data.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_navigation_data.h
  28  * @brief   Describes the Ewk navigation data API.
  29  */
  30
  31 #ifndef ewk_navigation_data_h
  32 #define ewk_navigation_data_h
  33
  34 #include "ewk_url_request.h"
  35 #include <Eina.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /** Creates a type name for Ewk_Navigation_Data */
  42 typedef struct Ewk_Navigation_Data Ewk_Navigation_Data;
  43
  44 /**
  45  * Increases the reference count of the given object.
  46  *
  47  * @param data the navigation data object to increase the reference count
  48  *
  49  * @return a pointer to the object on success, @c NULL otherwise.
  50  */
  51 EAPI Ewk_Navigation_Data *ewk_navigation_data_ref(Ewk_Navigation_Data *data);
  52
  53 /**
  54  * Decreases the reference count of the given object, possibly freeing it.
  55  *
  56  * When the reference count reaches 0, the object is freed.
  57  *
  58  * @param data the navigation data object to decrease the reference count
  59  */
  60 EAPI void ewk_navigation_data_unref(Ewk_Navigation_Data *data);
  61
  62 /**
  63  * Returns title for this navigation data.
  64  *
  65  * The title of the navigated page.
  66  *
  67  * @param data navigation data object to query
  68  *
  69  * @return the title 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  */
  75 EAPI const char *ewk_navigation_data_title_get(const Ewk_Navigation_Data *data);
  76
  77 /**
  78  * Returns the original request for this navigation data.
  79  *
  80  * @param data navigation data object to query
  81  *
  82  * @return The URL request pointer or @c NULL in case of error.
  83  */
  84 EAPI Ewk_Url_Request *ewk_navigation_data_original_request_get(const Ewk_Navigation_Data *data);
  85
  86 /**
  87  * Returns URL for this navigation data.
  88  *
  89  * The URL of the navigated page.
  90  *
  91  * @param data navigation data object to query
  92  *
  93  * @return the URL of the @a data or @c NULL in case of error. This pointer is
  94  *         guaranteed to be eina_stringshare, so whenever possible
  95  *         save yourself some cpu cycles and use
  96  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  97  *         strdup()
  98  */
  99 EAPI const char *ewk_navigation_data_url_get(const Ewk_Navigation_Data *data);
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif // ewk_navigation_data_h