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
|
/*
* peas-plugins-info.h
* This file is part of libpeas
*
* Copyright (C) 2002-2005 - Paolo Maggi
* Copyright (C) 2007 - Steve Frécinaux
*
* libpeas is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* libpeas is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
#ifndef __PEAS_PLUGIN_INFO_H__
#define __PEAS_PLUGIN_INFO_H__
#include <gio/gio.h>
#include "peas-version-macros.h"
G_BEGIN_DECLS
#define PEAS_TYPE_PLUGIN_INFO (peas_plugin_info_get_type ())
#define PEAS_PLUGIN_INFO(obj) ((PeasPluginInfo *) (obj))
/**
* PEAS_PLUGIN_INFO_ERROR:
*
* Error domain for PeasPluginInfo. Errors in this domain will
* be from the PeasPluginInfoError enumeration. See #GError for
* more information on error domains.
*/
#define PEAS_PLUGIN_INFO_ERROR peas_plugin_info_error_quark ()
/**
* PeasPluginInfoError:
* @PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED:
* The plugin failed to load.
* @PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND:
* The plugin's loader was not found.
* @PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND:
* A dependency of the plugin was not found.
* @PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED:
* A dependency of the plugin failed to load.
*
* These identify the various errors that can occur while
* loading a plugin.
*/
typedef enum {
PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED,
PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND,
PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND,
PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED
} PeasPluginInfoError;
/**
* PeasPluginInfo:
*
* The #PeasPluginInfo structure contains only private data and should only
* be accessed using the provided API.
*/
typedef struct _PeasPluginInfo PeasPluginInfo;
PEAS_AVAILABLE_IN_ALL
GType peas_plugin_info_get_type (void) G_GNUC_CONST;
PEAS_AVAILABLE_IN_ALL
GQuark peas_plugin_info_error_quark (void);
PEAS_AVAILABLE_IN_ALL
gboolean peas_plugin_info_is_loaded (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
gboolean peas_plugin_info_is_available (const PeasPluginInfo *info,
GError **error);
PEAS_AVAILABLE_IN_ALL
gboolean peas_plugin_info_is_builtin (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
gboolean peas_plugin_info_is_hidden (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_module_name (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_module_dir (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_data_dir (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
GSettings *peas_plugin_info_get_settings (const PeasPluginInfo *info,
const gchar *schema_id);
PEAS_AVAILABLE_IN_ALL
const gchar **peas_plugin_info_get_dependencies (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
gboolean peas_plugin_info_has_dependency (const PeasPluginInfo *info,
const gchar *module_name);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_name (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_description (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_icon_name (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar **peas_plugin_info_get_authors (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_website (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_copyright (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_version (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_help_uri (const PeasPluginInfo *info);
PEAS_AVAILABLE_IN_ALL
const gchar *peas_plugin_info_get_external_data (const PeasPluginInfo *info,
const gchar *key);
G_END_DECLS
#endif /* __PEAS_PLUGIN_INFO_H__ */
|
