← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimpmodule/tmpl/gimpmodule.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpmodule/tmpl/gimpmodule.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
GimpModule
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
A #GTypeModule subclass which implements module loading using #GModule.
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
A #GTypeModule subclass which implements module loading using #GModule.
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
#GModule
 
15
</para>
 
16
<para>
 
17
#GTypeModule
 
18
</para>
 
19
 
 
20
<!-- ##### SECTION Stability_Level ##### -->
 
21
 
 
22
 
 
23
<!-- ##### STRUCT GimpModule ##### -->
 
24
<para>
 
25
#GimpModule is a generic mechanism to dynamically load modules into
 
26
the GIMP.  It is a #GTypeModule subclass, implementing module loading
 
27
using #GModule.  #GimpModule does not know which functionality is
 
28
implemented by the modules, it just provides a framework to get
 
29
arbitrary #GType implementations loaded from disk.
 
30
</para>
 
31
 
 
32
@filename: 
 
33
@verbose: 
 
34
@state: 
 
35
@on_disk: 
 
36
@load_inhibit: 
 
37
@info: 
 
38
@last_module_error: 
 
39
 
 
40
<!-- ##### SIGNAL GimpModule::modified ##### -->
 
41
<para>
 
42
 
 
43
</para>
 
44
 
 
45
@gimpmodule: the object which received the signal.
 
46
 
 
47
<!-- ##### STRUCT GimpModuleInfo ##### -->
 
48
<para>
 
49
This structure contains information about a loadable module.
 
50
</para>
 
51
 
 
52
@abi_version: The #GIMP_MODULE_ABI_VERSION the module was compiled against.
 
53
@purpose:     The module's general purpose.
 
54
@author:      The module's author.
 
55
@version:     The module's version.
 
56
@copyright:   The module's copyright.
 
57
@date:        The module's release date.
 
58
 
 
59
<!-- ##### ENUM GimpModuleState ##### -->
 
60
<para>
 
61
The possible states a #GimpModule can be in.
 
62
</para>
 
63
 
 
64
@GIMP_MODULE_STATE_ERROR:       Missing gimp_module_register() function
 
65
                                or other error.
 
66
@GIMP_MODULE_STATE_LOADED:      An instance of a type implemented by
 
67
                                this module is allocated.
 
68
@GIMP_MODULE_STATE_LOAD_FAILED: gimp_module_register() returned #FALSE.
 
69
@GIMP_MODULE_STATE_NOT_LOADED:  There are no instances allocated of
 
70
                                types implemented by this module.
 
71
 
 
72
<!-- ##### USER_FUNCTION GimpModuleQueryFunc ##### -->
 
73
<para>
 
74
The signature of the query function a loadable GIMP module must
 
75
implement.  In the module, the function must be called
 
76
gimp_module_query().
 
77
</para>
 
78
 
 
79
<para>
 
80
#GimpModule will copy the returned #GimpModuleInfo struct, so the
 
81
module doesn't need to keep these values around (however in most cases
 
82
the module will just return a pointer to a constant structure).
 
83
</para>
 
84
 
 
85
@module:  The #GimpModule responsible for this loadable module.
 
86
@Returns: The #GimpModuleInfo struct describing the module.
 
87
 
 
88
 
 
89
<!-- ##### USER_FUNCTION GimpModuleRegisterFunc ##### -->
 
90
<para>
 
91
The signature of the register function a loadable GIMP module must
 
92
implement.  In the module, the function must be called
 
93
gimp_module_register().
 
94
</para>
 
95
 
 
96
<para>
 
97
When this function is called, the module should register all the types
 
98
it implements with the passed @module.
 
99
</para>
 
100
 
 
101
@module:  The #GimpModule responsible for this loadable module.
 
102
@Returns: #TRUE on success, #FALSE otherwise.
 
103
 
 
104
 
 
105
<!-- ##### MACRO GIMP_MODULE_ABI_VERSION ##### -->
 
106
<para>
 
107
The version of the module system's ABI. Modules put this value into
 
108
#GimpModuleInfo's @abi_version field so the code loading the modules
 
109
can check if it was compiled against the same module ABI the modules
 
110
are compiled against.
 
111
</para>
 
112
 
 
113
 
 
114
 
 
115
<!-- ##### MACRO GIMP_MODULE_PARAM_SERIALIZE ##### -->
 
116
<para>
 
117
 
 
118
</para>
 
119
 
 
120
 
 
121
 
 
122
<!-- ##### FUNCTION gimp_module_new ##### -->
 
123
<para>
 
124
 
 
125
</para>
 
126
 
 
127
@filename: 
 
128
@load_inhibit: 
 
129
@verbose: 
 
130
@Returns: 
 
131
 
 
132
 
 
133
<!-- ##### FUNCTION gimp_module_modified ##### -->
 
134
<para>
 
135
 
 
136
</para>
 
137
 
 
138
@module: 
 
139
 
 
140
 
 
141
<!-- ##### FUNCTION gimp_module_query_module ##### -->
 
142
<para>
 
143
 
 
144
</para>
 
145
 
 
146
@module: 
 
147
@Returns: 
 
148
 
 
149
 
 
150
<!-- ##### FUNCTION gimp_module_set_load_inhibit ##### -->
 
151
<para>
 
152
 
 
153
</para>
 
154
 
 
155
@module: 
 
156
@load_inhibit: 
 
157
 
 
158
 
 
159
<!-- ##### FUNCTION gimp_module_state_name ##### -->
 
160
<para>
 
161
 
 
162
</para>
 
163
 
 
164
@state: 
 
165
@Returns: 
 
166
 
 
167
 
 
168
<!-- ##### FUNCTION gimp_module_register_enum ##### -->
 
169
<para>
 
170
 
 
171
</para>
 
172
 
 
173
@module: 
 
174
@name: 
 
175
@const_static_values: 
 
176
@Returns: 
 
177
 
 
178
 
 
179
<!-- ##### FUNCTION gimp_module_info_new ##### -->
 
180
<para>
 
181
 
 
182
</para>
 
183
 
 
184
@abi_version: 
 
185
@purpose: 
 
186
@author: 
 
187
@version: 
 
188
@copyright: 
 
189
@date: 
 
190
@Returns: 
 
191
 
 
192
 
 
193
<!-- ##### FUNCTION gimp_module_info_copy ##### -->
 
194
<para>
 
195
 
 
196
</para>
 
197
 
 
198
@info: 
 
199
@Returns: 
 
200
 
 
201
 
 
202
<!-- ##### FUNCTION gimp_module_info_free ##### -->
 
203
<para>
 
204
 
 
205
</para>
 
206
 
 
207
@info: 
 
208
 
 
209