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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<!-- ##### SECTION Title ##### -->
GimpModule
<!-- ##### SECTION Short_Description ##### -->
A #GTypeModule subclass which implements module loading using #GModule.
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GTypeModule subclass which implements module loading using #GModule.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<para>
#GTypeModule
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GimpModule ##### -->
<para>
#GimpModule is a generic mechanism to dynamically load modules into
the GIMP. It is a #GTypeModule subclass, implementing module loading
using #GModule. #GimpModule does not know which functionality is
implemented by the modules, it just provides a framework to get
arbitrary #GType implementations loaded from disk.
</para>
@filename:
@verbose:
@state:
@on_disk:
@load_inhibit:
@info:
@last_module_error:
<!-- ##### SIGNAL GimpModule::modified ##### -->
<para>
</para>
@gimpmodule: the object which received the signal.
<!-- ##### STRUCT GimpModuleInfo ##### -->
<para>
This structure contains information about a loadable module.
</para>
@abi_version: The #GIMP_MODULE_ABI_VERSION the module was compiled against.
@purpose: The module's general purpose.
@author: The module's author.
@version: The module's version.
@copyright: The module's copyright.
@date: The module's release date.
<!-- ##### ENUM GimpModuleState ##### -->
<para>
The possible states a #GimpModule can be in.
</para>
@GIMP_MODULE_STATE_ERROR: Missing gimp_module_register() function
or other error.
@GIMP_MODULE_STATE_LOADED: An instance of a type implemented by
this module is allocated.
@GIMP_MODULE_STATE_LOAD_FAILED: gimp_module_register() returned #FALSE.
@GIMP_MODULE_STATE_NOT_LOADED: There are no instances allocated of
types implemented by this module.
<!-- ##### USER_FUNCTION GimpModuleQueryFunc ##### -->
<para>
The signature of the query function a loadable GIMP module must
implement. In the module, the function must be called
gimp_module_query().
</para>
<para>
#GimpModule will copy the returned #GimpModuleInfo struct, so the
module doesn't need to keep these values around (however in most cases
the module will just return a pointer to a constant structure).
</para>
@module: The #GimpModule responsible for this loadable module.
@Returns: The #GimpModuleInfo struct describing the module.
<!-- ##### USER_FUNCTION GimpModuleRegisterFunc ##### -->
<para>
The signature of the register function a loadable GIMP module must
implement. In the module, the function must be called
gimp_module_register().
</para>
<para>
When this function is called, the module should register all the types
it implements with the passed @module.
</para>
@module: The #GimpModule responsible for this loadable module.
@Returns: #TRUE on success, #FALSE otherwise.
<!-- ##### MACRO GIMP_MODULE_ABI_VERSION ##### -->
<para>
The version of the module system's ABI. Modules put this value into
#GimpModuleInfo's @abi_version field so the code loading the modules
can check if it was compiled against the same module ABI the modules
are compiled against.
</para>
<!-- ##### MACRO GIMP_MODULE_PARAM_SERIALIZE ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_module_new ##### -->
<para>
</para>
@filename:
@load_inhibit:
@verbose:
@Returns:
<!-- ##### FUNCTION gimp_module_modified ##### -->
<para>
</para>
@module:
<!-- ##### FUNCTION gimp_module_query_module ##### -->
<para>
</para>
@module:
@Returns:
<!-- ##### FUNCTION gimp_module_set_load_inhibit ##### -->
<para>
</para>
@module:
@load_inhibit:
<!-- ##### FUNCTION gimp_module_state_name ##### -->
<para>
</para>
@state:
@Returns:
<!-- ##### FUNCTION gimp_module_register_enum ##### -->
<para>
</para>
@module:
@name:
@const_static_values:
@Returns:
<!-- ##### FUNCTION gimp_module_info_new ##### -->
<para>
</para>
@abi_version:
@purpose:
@author:
@version:
@copyright:
@date:
@Returns:
<!-- ##### FUNCTION gimp_module_info_copy ##### -->
<para>
</para>
@info:
@Returns:
<!-- ##### FUNCTION gimp_module_info_free ##### -->
<para>
</para>
@info:
|
