summaryrefslogtreecommitdiff
path: root/Source/WebKit2/UIProcess/API/efl/ewk_intent_service.h
blob: a7d3d1a14fd806544ab30576d0892b332cd52fe8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (C) 2012 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file ewk_intent_service.h
 * @brief Describes the Ewk Intent Service API.
 */

#ifndef ewk_intent_service_h
#define ewk_intent_service_h

#include <Evas.h>

#ifdef __cplusplus
extern "C" {
#endif

/** Creates a type name for Ewk_Intent_Service */
typedef struct Ewk_Intent_Service Ewk_Intent_Service;

/**
 * Increases the reference count of the given object.
 *
 * @param service the intent service object to increase the reference count
 *
 * @return a pointer to the object on success, @c NULL otherwise.
 */
EAPI Ewk_Intent_Service *ewk_intent_service_ref(Ewk_Intent_Service *service);

/**
 * Decreases the reference count of the given object, possibly freeing it.
 *
 * When the reference count reaches 0, the intent service is freed.
 *
 * @param service the intent service object to decrease the reference count
 */
EAPI void ewk_intent_service_unref(Ewk_Intent_Service *service);

/**
 * Query action for this intent service.
 *
 * @param service service item to query.
 *
 * @return the action pointer, that may be @c NULL. This pointer is
 * guaranteed to be eina_stringshare, so whenever possible
 * save yourself some cpu cycles and use
 * eina_stringshare_ref() instead of eina_stringshare_add() or
 * strdup().
 */
EAPI const char *ewk_intent_service_action_get(const Ewk_Intent_Service *service);

/**
 * Query type for this intent service.
 *
 * @param service service item to query.
 *
 * @return the type pointer, that may be @c NULL. This pointer is
 * guaranteed to be eina_stringshare, so whenever possible
 * save yourself some cpu cycles and use
 * eina_stringshare_ref() instead of eina_stringshare_add() or
 * strdup().
 */
EAPI const char *ewk_intent_service_type_get(const Ewk_Intent_Service *service);

/**
 * Query URL for this intent service.
 *
 * @param service service item to query.
 *
 * @return the URL pointer, that may be @c NULL. This pointer is
 * guaranteed to be eina_stringshare, so whenever possible
 * save yourself some cpu cycles and use
 * eina_stringshare_ref() instead of eina_stringshare_add() or
 * strdup().
 */
EAPI const char *ewk_intent_service_href_get(const Ewk_Intent_Service *service);

/**
 * Query title for this intent service.
 *
 * @param service service item to query.
 *
 * @return the title pointer, that may be @c NULL. This pointer is
 * guaranteed to be eina_stringshare, so whenever possible
 * save yourself some cpu cycles and use
 * eina_stringshare_ref() instead of eina_stringshare_add() or
 * strdup().
 */
EAPI const char *ewk_intent_service_title_get(const Ewk_Intent_Service *service);

/**
 * Query disposition for this intent service.
 *
 * @param service service item to query.
 *
 * @return the disposition pointer, that may be @c NULL. This pointer is
 * guaranteed to be eina_stringshare, so whenever possible
 * save yourself some cpu cycles and use
 * eina_stringshare_ref() instead of eina_stringshare_add() or
 * strdup().
 */
EAPI const char *ewk_intent_service_disposition_get(const Ewk_Intent_Service *service);

#ifdef __cplusplus
}
#endif

#endif // ewk_intent_service_h