Source/WebKit2/UIProcess/API/efl/ewk_intent_service.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_service.h
  28  * @brief Describes the Ewk Intent Service API.
  29  */
  30
  31 #ifndef ewk_intent_service_h
  32 #define ewk_intent_service_h
  33
  34 #include <Evas.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /** Creates a type name for Ewk_Intent_Service */
  41 typedef struct Ewk_Intent_Service Ewk_Intent_Service;
  42
  43 /**
  44  * Increases the reference count of the given object.
  45  *
  46  * @param service the intent service object to increase the reference count
  47  *
  48  * @return a pointer to the object on success, @c NULL otherwise.
  49  */
  50 EAPI Ewk_Intent_Service *ewk_intent_service_ref(Ewk_Intent_Service *service);
  51
  52 /**
  53  * Decreases the reference count of the given object, possibly freeing it.
  54  *
  55  * When the reference count reaches 0, the intent service is freed.
  56  *
  57  * @param service the intent service object to decrease the reference count
  58  */
  59 EAPI void ewk_intent_service_unref(Ewk_Intent_Service *service);
  60
  61 /**
  62  * Query action for this intent service.
  63  *
  64  * @param service service 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_service_action_get(const Ewk_Intent_Service *service);
  73
  74 /**
  75  * Query type for this intent service.
  76  *
  77  * @param service service 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_service_type_get(const Ewk_Intent_Service *service);
  86
  87 /**
  88  * Query URL for this intent service.
  89  *
  90  * @param service service item to query.
  91  *
  92  * @return the URL 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_href_get(const Ewk_Intent_Service *service);
  99
 100 /**
 101  * Query title for this intent service.
 102  *
 103  * @param service service item to query.
 104  *
 105  * @return the title pointer, that may be @c NULL. This pointer is
 106  * guaranteed to be eina_stringshare, so whenever possible
 107  * save yourself some cpu cycles and use
 108  * eina_stringshare_ref() instead of eina_stringshare_add() or
 109  * strdup().
 110  */
 111 EAPI const char *ewk_intent_service_title_get(const Ewk_Intent_Service *service);
 112
 113 /**
 114  * Query disposition for this intent service.
 115  *
 116  * @param service service item to query.
 117  *
 118  * @return the disposition pointer, that may be @c NULL. This pointer is
 119  * guaranteed to be eina_stringshare, so whenever possible
 120  * save yourself some cpu cycles and use
 121  * eina_stringshare_ref() instead of eina_stringshare_add() or
 122  * strdup().
 123  */
 124 EAPI const char *ewk_intent_service_disposition_get(const Ewk_Intent_Service *service);
 125
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129
 130 #endif // ewk_intent_service_h