Source/WebKit2/UIProcess/API/efl/ewk_intent.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_intent.h
  28  * @brief   Describes the Ewk Intent API.
  29  */
  30
  31 #ifndef ewk_intent_h
  32 #define ewk_intent_h
  33
  34 #include <Eina.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /** Creates a type name for Ewk_Intent */
  41 typedef struct Ewk_Intent Ewk_Intent;
  42
  43 /**
  44  * Increases the reference count of the given object.
  45  *
  46  * @param intent the intent object to increase the reference count
  47  *
  48  * @return a pointer to the object on success, @c NULL otherwise.
  49  */
  50 EAPI Ewk_Intent *ewk_intent_ref(Ewk_Intent *intent);
  51
  52 /**
  53  * Decreases the reference count of the given object, possibly freeing it.
  54  *
  55  * When the reference count reaches 0, the intent is freed.
  56  *
  57  * @param intent the intent object to decrease the reference count
  58  */
  59 EAPI void ewk_intent_unref(Ewk_Intent *intent);
  60
  61 /**
  62  * Query action for this intent.
  63  *
  64  * @param intent intent item to query.
  65  *
  66  * @return the action pointer, that may be @c NULL. This pointer is
  67  *         guaranteed to be eina_stringshare, so whenever possible
  68  *         save yourself some cpu cycles and use
  69  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  70  *         strdup().
  71  */
  72 EAPI const char *ewk_intent_action_get(const Ewk_Intent *intent);
  73
  74 /**
  75  * Query type for this intent.
  76  *
  77  * @param intent intent item to query.
  78  *
  79  * @return the type pointer, that may be @c NULL. This pointer is
  80  *         guaranteed to be eina_stringshare, so whenever possible
  81  *         save yourself some cpu cycles and use
  82  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  83  *         strdup().
  84  */
  85 EAPI const char *ewk_intent_type_get(const Ewk_Intent *intent);
  86
  87 /**
  88  * Query service for this intent.
  89  *
  90  * @param intent intent item to query.
  91  *
  92  * @return the service pointer, that may be @c NULL. This pointer is
  93  *         guaranteed to be eina_stringshare, so whenever possible
  94  *         save yourself some cpu cycles and use
  95  *         eina_stringshare_ref() instead of eina_stringshare_add() or
  96  *         strdup().
  97  */
  98 EAPI const char *ewk_intent_service_get(const Ewk_Intent *intent);
  99
 100 /**
 101  * Query suggestions for this intent.
 102  *
 103  * This function provides a list of (absolute) suggested Service URLs of which the Client
 104  * is aware and which can handle the intent.
 105  *
 106  * @param intent intent item to query.
 107  *
 108  * @return @c Eina_List with suggested service URLs on success, or @c NULL on failure,
 109  *         the Eina_List and its items should be freed after use. Use eina_stringshare_del()
 110  *         to free the items.
 111  */
 112 EAPI Eina_List *ewk_intent_suggestions_get(const Ewk_Intent *intent);
 113
 114 /**
 115  * Retrieves the value (if any) from the extra data dictionary this intent was constructed with.
 116  *
 117  * The returned string should be freed by eina_stringshare_del() after use.
 118  *
 119  * @param intent intent item to query.
 120  * @param key key to query in the dictionary.
 121  *
 122  * @return a newly allocated string or @c NULL in case of error or if the key does not exist.
 123  */
 124 EAPI const char *ewk_intent_extra_get(const Ewk_Intent *intent, const char *key);
 125
 126 /**
 127  * Retrieve a list of the names of extra metadata associated with the intent.
 128  *
 129  * The item of a returned list should be freed by eina_stringshare_del() after use.
 130  *
 131  * @param intent intent item to query.
 132  *
 133  * @return @c Eina_List with names of extra metadata on success, or @c NULL on failure,
 134  *         the Eina_List and its items should be freed after use. Use eina_stringshare_del()
 135  *         to free the items.
 136  */
 137 EAPI Eina_List *ewk_intent_extra_names_get(const Ewk_Intent *intent);
 138
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142 #endif // ewk_intent_h