← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpcontext.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpcontext.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpcontext</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
8
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
9
 
<link rel="prev" href="libgimp-gimp.html" title="gimp">
 
9
<link rel="prev" href="libgimp-gimpbuffer.html" title="gimpbuffer">
10
10
<link rel="next" href="libgimp-gimpgimprc.html" title="gimpgimprc">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
24
27
<tr valign="middle">
25
 
<td><a accesskey="p" href="libgimp-gimp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
28
<td><a accesskey="p" href="libgimp-gimpbuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
26
29
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
27
30
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimpgimprc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2548965" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2569853" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2547572" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2599702" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpcontext"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2548965"></a><span class="refentrytitle">gimpcontext</span>
 
43
<a name="id2569853"></a><span class="refentrytitle">gimpcontext</span>
41
44
</h2>
42
45
<p>gimpcontext &#8212; Functions to manipulate a plug-in's context.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-push">gimp_context_push</a>               (void);
53
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-pop">gimp_context_pop</a>                (void);
54
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-get-foreground">gimp_context_get_foreground</a>     (<a
55
 
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
56
 
>GimpRGB</a> *foreground);
57
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-foreground">gimp_context_set_foreground</a>     (const <a
58
 
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
59
 
>GimpRGB</a> *foreground);
60
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-get-background">gimp_context_get_background</a>     (<a
61
 
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
62
 
>GimpRGB</a> *background);
63
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-background">gimp_context_set_background</a>     (const <a
64
 
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
65
 
>GimpRGB</a> *background);
66
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-default-colors">gimp_context_set_default_colors</a> (void);
67
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-swap-colors">gimp_context_swap_colors</a>        (void);
68
 
gdouble     <a href="libgimp-gimpcontext.html#gimp-context-get-opacity">gimp_context_get_opacity</a>        (void);
69
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-opacity">gimp_context_set_opacity</a>        (gdouble opacity);
70
 
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a href="libgimp-gimpcontext.html#gimp-context-get-paint-mode">gimp_context_get_paint_mode</a>
71
 
                                            (void);
72
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-paint-mode">gimp_context_set_paint_mode</a>     (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
73
 
gchar*      <a href="libgimp-gimpcontext.html#gimp-context-get-brush">gimp_context_get_brush</a>          (void);
74
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-brush">gimp_context_set_brush</a>          (const gchar *name);
75
 
gchar*      <a href="libgimp-gimpcontext.html#gimp-context-get-pattern">gimp_context_get_pattern</a>        (void);
76
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-pattern">gimp_context_set_pattern</a>        (const gchar *name);
77
 
gchar*      <a href="libgimp-gimpcontext.html#gimp-context-get-gradient">gimp_context_get_gradient</a>       (void);
78
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-gradient">gimp_context_set_gradient</a>       (const gchar *name);
79
 
gchar*      <a href="libgimp-gimpcontext.html#gimp-context-get-palette">gimp_context_get_palette</a>        (void);
80
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-palette">gimp_context_set_palette</a>        (const gchar *name);
81
 
gchar*      <a href="libgimp-gimpcontext.html#gimp-context-get-font">gimp_context_get_font</a>           (void);
82
 
gboolean    <a href="libgimp-gimpcontext.html#gimp-context-set-font">gimp_context_set_font</a>           (const gchar *name);
 
55
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-push">gimp_context_push</a>                   (void);
 
56
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-pop">gimp_context_pop</a>                    (void);
 
57
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-get-foreground">gimp_context_get_foreground</a>         (<a
 
58
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
59
>GimpRGB</a> *foreground);
 
60
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-foreground">gimp_context_set_foreground</a>         (const <a
 
61
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
62
>GimpRGB</a> *foreground);
 
63
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-get-background">gimp_context_get_background</a>         (<a
 
64
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
65
>GimpRGB</a> *background);
 
66
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-background">gimp_context_set_background</a>         (const <a
 
67
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
68
>GimpRGB</a> *background);
 
69
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-default-colors">gimp_context_set_default_colors</a>     (void);
 
70
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-swap-colors">gimp_context_swap_colors</a>            (void);
 
71
gdouble             <a href="libgimp-gimpcontext.html#gimp-context-get-opacity">gimp_context_get_opacity</a>            (void);
 
72
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-opacity">gimp_context_set_opacity</a>            (gdouble opacity);
 
73
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a href="libgimp-gimpcontext.html#gimp-context-get-paint-mode">gimp_context_get_paint_mode</a>        (void);
 
74
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-paint-mode">gimp_context_set_paint_mode</a>         (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
 
75
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-brush">gimp_context_get_brush</a>              (void);
 
76
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-brush">gimp_context_set_brush</a>              (const gchar *name);
 
77
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-pattern">gimp_context_get_pattern</a>            (void);
 
78
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-pattern">gimp_context_set_pattern</a>            (const gchar *name);
 
79
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-gradient">gimp_context_get_gradient</a>           (void);
 
80
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-gradient">gimp_context_set_gradient</a>           (const gchar *name);
 
81
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-palette">gimp_context_get_palette</a>            (void);
 
82
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-palette">gimp_context_set_palette</a>            (const gchar *name);
 
83
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-font">gimp_context_get_font</a>               (void);
 
84
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-font">gimp_context_set_font</a>               (const gchar *name);
 
85
gchar*              <a href="libgimp-gimpcontext.html#gimp-context-get-paint-method">gimp_context_get_paint_method</a>       (void);
 
86
gboolean            <a href="libgimp-gimpcontext.html#gimp-context-set-paint-method">gimp_context_set_paint_method</a>       (const gchar *name);
83
87
</pre>
84
88
</div>
85
89
<div class="refsect1" lang="en">
86
 
<a name="id2547572"></a><h2>Description</h2>
 
90
<a name="id2599702"></a><h2>Description</h2>
87
91
<p>
88
92
Functions to manipulate a plug-in's context.
89
93
</p>
90
94
</div>
91
95
<div class="refsect1" lang="en">
92
 
<a name="id2532642"></a><h2>Details</h2>
 
96
<a name="id2558540"></a><h2>Details</h2>
93
97
<div class="refsect2" lang="en">
94
 
<a name="id2532653"></a><h3>
 
98
<a name="id2558551"></a><h3>
95
99
<a name="gimp-context-push"></a>gimp_context_push ()</h3>
96
 
<a class="indexterm" name="id2532667"></a><pre class="programlisting">gboolean    gimp_context_push               (void);</pre>
 
100
<a class="indexterm" name="id2558566"></a><pre class="programlisting">gboolean            gimp_context_push                   (void);</pre>
97
101
<p>
98
102
Pushes a context to the top of the plug-in's context stack.
99
103
</p>
100
104
<p>
101
105
This procedure creates a new context by copying the current context.
102
106
This copy becomes the new current context for the calling plug-in
103
 
until it is popped again.</p>
 
107
until it is popped again using <a href="libgimp-gimpcontext.html#gimp-context-pop"><code class="function">gimp_context_pop()</code></a>.</p>
104
108
<p>
105
109
 
106
110
</p>
107
111
<div class="variablelist"><table border="0">
108
112
<col align="left" valign="top">
109
113
<tbody><tr>
110
 
<td>
111
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
114
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
112
115
<td> TRUE on success.
113
116
 
114
117
</td>
115
118
</tr></tbody>
116
119
</table></div>
117
 
<p>Since  GIMP 2.2
 
120
<p class="since">Since  GIMP 2.2
118
121
</p>
119
122
</div>
120
123
<hr>
121
124
<div class="refsect2" lang="en">
122
 
<a name="id2532718"></a><h3>
 
125
<a name="id2558630"></a><h3>
123
126
<a name="gimp-context-pop"></a>gimp_context_pop ()</h3>
124
 
<a class="indexterm" name="id2532732"></a><pre class="programlisting">gboolean    gimp_context_pop                (void);</pre>
 
127
<a class="indexterm" name="id2558645"></a><pre class="programlisting">gboolean            gimp_context_pop                    (void);</pre>
125
128
<p>
126
129
Pops the topmost context from the plug-in's context stack.
127
130
</p>
128
131
<p>
129
 
This procedure creates a new context and makes it the current
130
 
context for the calling plug-in.</p>
 
132
This procedure removes the topmost context from the plug-in's
 
133
context stack. The context that was active before the corresponding
 
134
call to <a href="libgimp-gimpcontext.html#gimp-context-push"><code class="function">gimp_context_push()</code></a> becomes the new current context of the
 
135
plug-in.</p>
131
136
<p>
132
137
 
133
138
</p>
134
139
<div class="variablelist"><table border="0">
135
140
<col align="left" valign="top">
136
141
<tbody><tr>
137
 
<td>
138
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
142
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
139
143
<td> TRUE on success.
140
144
 
141
145
</td>
142
146
</tr></tbody>
143
147
</table></div>
144
 
<p>Since  GIMP 2.2
 
148
<p class="since">Since  GIMP 2.2
145
149
</p>
146
150
</div>
147
151
<hr>
148
152
<div class="refsect2" lang="en">
149
 
<a name="id2532783"></a><h3>
 
153
<a name="id2558709"></a><h3>
150
154
<a name="gimp-context-get-foreground"></a>gimp_context_get_foreground ()</h3>
151
 
<a class="indexterm" name="id2532796"></a><pre class="programlisting">gboolean    gimp_context_get_foreground     (<a
 
155
<a class="indexterm" name="id2558723"></a><pre class="programlisting">gboolean            gimp_context_get_foreground         (<a
152
156
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
153
157
>GimpRGB</a> *foreground);</pre>
154
158
<p>
165
169
<col align="left" valign="top">
166
170
<tbody>
167
171
<tr>
168
 
<td>
169
 
<span class="term"><em class="parameter"><code>foreground</code></em>&#160;:</span></td>
 
172
<td><span class="term"><em class="parameter"><code>foreground</code></em>&#160;:</span></td>
170
173
<td> The foreground color.
171
174
</td>
172
175
</tr>
173
176
<tr>
174
 
<td>
175
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
177
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
176
178
<td> TRUE on success.
177
179
 
178
180
</td>
179
181
</tr>
180
182
</tbody>
181
183
</table></div>
182
 
<p>Since  GIMP 2.2
 
184
<p class="since">Since  GIMP 2.2
183
185
</p>
184
186
</div>
185
187
<hr>
186
188
<div class="refsect2" lang="en">
187
 
<a name="id2532866"></a><h3>
 
189
<a name="id2599868"></a><h3>
188
190
<a name="gimp-context-set-foreground"></a>gimp_context_set_foreground ()</h3>
189
 
<a class="indexterm" name="id2532880"></a><pre class="programlisting">gboolean    gimp_context_set_foreground     (const <a
 
191
<a class="indexterm" name="id2599882"></a><pre class="programlisting">gboolean            gimp_context_set_foreground         (const <a
190
192
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
191
193
>GimpRGB</a> *foreground);</pre>
192
194
<p>
203
205
<col align="left" valign="top">
204
206
<tbody>
205
207
<tr>
206
 
<td>
207
 
<span class="term"><em class="parameter"><code>foreground</code></em>&#160;:</span></td>
 
208
<td><span class="term"><em class="parameter"><code>foreground</code></em>&#160;:</span></td>
208
209
<td> The foreground color.
209
210
</td>
210
211
</tr>
211
212
<tr>
212
 
<td>
213
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
213
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
214
214
<td> TRUE on success.
215
215
 
216
216
</td>
217
217
</tr>
218
218
</tbody>
219
219
</table></div>
220
 
<p>Since  GIMP 2.2
 
220
<p class="since">Since  GIMP 2.2
221
221
</p>
222
222
</div>
223
223
<hr>
224
224
<div class="refsect2" lang="en">
225
 
<a name="id2567113"></a><h3>
 
225
<a name="id2599955"></a><h3>
226
226
<a name="gimp-context-get-background"></a>gimp_context_get_background ()</h3>
227
 
<a class="indexterm" name="id2567127"></a><pre class="programlisting">gboolean    gimp_context_get_background     (<a
 
227
<a class="indexterm" name="id2599969"></a><pre class="programlisting">gboolean            gimp_context_get_background         (<a
228
228
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
229
229
>GimpRGB</a> *background);</pre>
230
230
<p>
241
241
<col align="left" valign="top">
242
242
<tbody>
243
243
<tr>
244
 
<td>
245
 
<span class="term"><em class="parameter"><code>background</code></em>&#160;:</span></td>
 
244
<td><span class="term"><em class="parameter"><code>background</code></em>&#160;:</span></td>
246
245
<td> The background color.
247
246
</td>
248
247
</tr>
249
248
<tr>
250
 
<td>
251
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
249
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
252
250
<td> TRUE on success.
253
251
 
254
252
</td>
255
253
</tr>
256
254
</tbody>
257
255
</table></div>
258
 
<p>Since  GIMP 2.2
 
256
<p class="since">Since  GIMP 2.2
259
257
</p>
260
258
</div>
261
259
<hr>
262
260
<div class="refsect2" lang="en">
263
 
<a name="id2567199"></a><h3>
 
261
<a name="id2600042"></a><h3>
264
262
<a name="gimp-context-set-background"></a>gimp_context_set_background ()</h3>
265
 
<a class="indexterm" name="id2567212"></a><pre class="programlisting">gboolean    gimp_context_set_background     (const <a
 
263
<a class="indexterm" name="id2600056"></a><pre class="programlisting">gboolean            gimp_context_set_background         (const <a
266
264
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
267
265
>GimpRGB</a> *background);</pre>
268
266
<p>
280
278
<col align="left" valign="top">
281
279
<tbody>
282
280
<tr>
283
 
<td>
284
 
<span class="term"><em class="parameter"><code>background</code></em>&#160;:</span></td>
 
281
<td><span class="term"><em class="parameter"><code>background</code></em>&#160;:</span></td>
285
282
<td> The background color.
286
283
</td>
287
284
</tr>
288
285
<tr>
289
 
<td>
290
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
286
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
291
287
<td> TRUE on success.
292
288
 
293
289
</td>
294
290
</tr>
295
291
</tbody>
296
292
</table></div>
297
 
<p>Since  GIMP 2.2
 
293
<p class="since">Since  GIMP 2.2
298
294
</p>
299
295
</div>
300
296
<hr>
301
297
<div class="refsect2" lang="en">
302
 
<a name="id2567284"></a><h3>
 
298
<a name="id2600130"></a><h3>
303
299
<a name="gimp-context-set-default-colors"></a>gimp_context_set_default_colors ()</h3>
304
 
<a class="indexterm" name="id2567298"></a><pre class="programlisting">gboolean    gimp_context_set_default_colors (void);</pre>
 
300
<a class="indexterm" name="id2606575"></a><pre class="programlisting">gboolean            gimp_context_set_default_colors     (void);</pre>
305
301
<p>
306
302
Set the current GIMP foreground and background colors to black and
307
303
white.
315
311
<div class="variablelist"><table border="0">
316
312
<col align="left" valign="top">
317
313
<tbody><tr>
318
 
<td>
319
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
314
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
320
315
<td> TRUE on success.
321
316
 
322
317
</td>
323
318
</tr></tbody>
324
319
</table></div>
325
 
<p>Since  GIMP 2.2
 
320
<p class="since">Since  GIMP 2.2
326
321
</p>
327
322
</div>
328
323
<hr>
329
324
<div class="refsect2" lang="en">
330
 
<a name="id2568192"></a><h3>
 
325
<a name="id2606623"></a><h3>
331
326
<a name="gimp-context-swap-colors"></a>gimp_context_swap_colors ()</h3>
332
 
<a class="indexterm" name="id2568206"></a><pre class="programlisting">gboolean    gimp_context_swap_colors        (void);</pre>
 
327
<a class="indexterm" name="id2606636"></a><pre class="programlisting">gboolean            gimp_context_swap_colors            (void);</pre>
333
328
<p>
334
329
Swap the current GIMP foreground and background colors.
335
330
</p>
343
338
<div class="variablelist"><table border="0">
344
339
<col align="left" valign="top">
345
340
<tbody><tr>
346
 
<td>
347
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
341
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
348
342
<td> TRUE on success.
349
343
 
350
344
</td>
351
345
</tr></tbody>
352
346
</table></div>
353
 
<p>Since  GIMP 2.2
 
347
<p class="since">Since  GIMP 2.2
354
348
</p>
355
349
</div>
356
350
<hr>
357
351
<div class="refsect2" lang="en">
358
 
<a name="id2568257"></a><h3>
 
352
<a name="id2606684"></a><h3>
359
353
<a name="gimp-context-get-opacity"></a>gimp_context_get_opacity ()</h3>
360
 
<a class="indexterm" name="id2568271"></a><pre class="programlisting">gdouble     gimp_context_get_opacity        (void);</pre>
 
354
<a class="indexterm" name="id2606697"></a><pre class="programlisting">gdouble             gimp_context_get_opacity            (void);</pre>
361
355
<p>
362
356
Get the opacity.
363
357
</p>
370
364
<div class="variablelist"><table border="0">
371
365
<col align="left" valign="top">
372
366
<tbody><tr>
373
 
<td>
374
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
367
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
375
368
<td> The opacity.
376
369
 
377
370
</td>
378
371
</tr></tbody>
379
372
</table></div>
380
 
<p>Since  GIMP 2.2
 
373
<p class="since">Since  GIMP 2.2
381
374
</p>
382
375
</div>
383
376
<hr>
384
377
<div class="refsect2" lang="en">
385
 
<a name="id2568321"></a><h3>
 
378
<a name="id2606744"></a><h3>
386
379
<a name="gimp-context-set-opacity"></a>gimp_context_set_opacity ()</h3>
387
 
<a class="indexterm" name="id2568334"></a><pre class="programlisting">gboolean    gimp_context_set_opacity        (gdouble opacity);</pre>
 
380
<a class="indexterm" name="id2606756"></a><pre class="programlisting">gboolean            gimp_context_set_opacity            (gdouble opacity);</pre>
388
381
<p>
389
382
Set the opacity.
390
383
</p>
398
391
<col align="left" valign="top">
399
392
<tbody>
400
393
<tr>
401
 
<td>
402
 
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
 
394
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
403
395
<td> The opacity.
404
396
</td>
405
397
</tr>
406
398
<tr>
407
 
<td>
408
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
399
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
409
400
<td> TRUE on success.
410
401
 
411
402
</td>
412
403
</tr>
413
404
</tbody>
414
405
</table></div>
415
 
<p>Since  GIMP 2.2
 
406
<p class="since">Since  GIMP 2.2
416
407
</p>
417
408
</div>
418
409
<hr>
419
410
<div class="refsect2" lang="en">
420
 
<a name="id2568405"></a><h3>
 
411
<a name="id2606821"></a><h3>
421
412
<a name="gimp-context-get-paint-mode"></a>gimp_context_get_paint_mode ()</h3>
422
 
<a class="indexterm" name="id2568418"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_context_get_paint_mode
423
 
                                            (void);</pre>
 
413
<a class="indexterm" name="id2606833"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_context_get_paint_mode        (void);</pre>
424
414
<p>
425
415
Get the paint mode.
426
416
</p>
434
424
<div class="variablelist"><table border="0">
435
425
<col align="left" valign="top">
436
426
<tbody><tr>
437
 
<td>
438
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
427
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
439
428
<td> The paint mode.
440
429
 
441
430
</td>
442
431
</tr></tbody>
443
432
</table></div>
444
 
<p>Since  GIMP 2.2
 
433
<p class="since">Since  GIMP 2.2
445
434
</p>
446
435
</div>
447
436
<hr>
448
437
<div class="refsect2" lang="en">
449
 
<a name="id2568469"></a><h3>
 
438
<a name="id2606880"></a><h3>
450
439
<a name="gimp-context-set-paint-mode"></a>gimp_context_set_paint_mode ()</h3>
451
 
<a class="indexterm" name="id2568482"></a><pre class="programlisting">gboolean    gimp_context_set_paint_mode     (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
 
440
<a class="indexterm" name="id2606892"></a><pre class="programlisting">gboolean            gimp_context_set_paint_mode         (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
452
441
<p>
453
442
Set the paint mode.
454
443
</p>
461
450
<col align="left" valign="top">
462
451
<tbody>
463
452
<tr>
464
 
<td>
465
 
<span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
 
453
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
466
454
<td> The paint mode.
467
455
</td>
468
456
</tr>
469
457
<tr>
470
 
<td>
471
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
458
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
472
459
<td> TRUE on success.
473
460
 
474
461
</td>
475
462
</tr>
476
463
</tbody>
477
464
</table></div>
478
 
<p>Since  GIMP 2.2
 
465
<p class="since">Since  GIMP 2.2
479
466
</p>
480
467
</div>
481
468
<hr>
482
469
<div class="refsect2" lang="en">
483
 
<a name="id2568551"></a><h3>
 
470
<a name="id2606956"></a><h3>
484
471
<a name="gimp-context-get-brush"></a>gimp_context_get_brush ()</h3>
485
 
<a class="indexterm" name="id2568565"></a><pre class="programlisting">gchar*      gimp_context_get_brush          (void);</pre>
 
472
<a class="indexterm" name="id2606968"></a><pre class="programlisting">gchar*              gimp_context_get_brush              (void);</pre>
486
473
<p>
487
474
Retrieve the currently active brush.
488
475
</p>
489
476
<p>
490
 
This procedure returns the nme of the currently active brush. All
 
477
This procedure returns the name of the currently active brush. All
491
478
paint operations and stroke operations use this brush to control the
492
479
application of paint to the image.</p>
493
480
<p>
496
483
<div class="variablelist"><table border="0">
497
484
<col align="left" valign="top">
498
485
<tbody><tr>
499
 
<td>
500
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
486
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
501
487
<td> The name of the active brush.
502
488
 
503
489
</td>
504
490
</tr></tbody>
505
491
</table></div>
506
 
<p>Since  GIMP 2.2
 
492
<p class="since">Since  GIMP 2.2
507
493
</p>
508
494
</div>
509
495
<hr>
510
496
<div class="refsect2" lang="en">
511
 
<a name="id2568616"></a><h3>
 
497
<a name="id2607016"></a><h3>
512
498
<a name="gimp-context-set-brush"></a>gimp_context_set_brush ()</h3>
513
 
<a class="indexterm" name="id2568630"></a><pre class="programlisting">gboolean    gimp_context_set_brush          (const gchar *name);</pre>
 
499
<a class="indexterm" name="id2607029"></a><pre class="programlisting">gboolean            gimp_context_set_brush              (const gchar *name);</pre>
514
500
<p>
515
501
Set the specified brush as the active brush.
516
502
</p>
527
513
<col align="left" valign="top">
528
514
<tbody>
529
515
<tr>
530
 
<td>
531
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
532
 
<td> The name o the brush.
 
516
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
517
<td> The name of the brush.
533
518
</td>
534
519
</tr>
535
520
<tr>
536
 
<td>
537
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
521
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
538
522
<td> TRUE on success.
539
523
 
540
524
</td>
541
525
</tr>
542
526
</tbody>
543
527
</table></div>
544
 
<p>Since  GIMP 2.2
 
528
<p class="since">Since  GIMP 2.2
545
529
</p>
546
530
</div>
547
531
<hr>
548
532
<div class="refsect2" lang="en">
549
 
<a name="id2568704"></a><h3>
 
533
<a name="id2607098"></a><h3>
550
534
<a name="gimp-context-get-pattern"></a>gimp_context_get_pattern ()</h3>
551
 
<a class="indexterm" name="id2568718"></a><pre class="programlisting">gchar*      gimp_context_get_pattern        (void);</pre>
 
535
<a class="indexterm" name="id2607111"></a><pre class="programlisting">gchar*              gimp_context_get_pattern            (void);</pre>
552
536
<p>
553
537
Retrieve the currently active pattern.
554
538
</p>
562
546
<div class="variablelist"><table border="0">
563
547
<col align="left" valign="top">
564
548
<tbody><tr>
565
 
<td>
566
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
549
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
567
550
<td> The name of the active pattern.
568
551
 
569
552
</td>
570
553
</tr></tbody>
571
554
</table></div>
572
 
<p>Since  GIMP 2.2
 
555
<p class="since">Since  GIMP 2.2
573
556
</p>
574
557
</div>
575
558
<hr>
576
559
<div class="refsect2" lang="en">
577
 
<a name="id2568769"></a><h3>
 
560
<a name="id2607159"></a><h3>
578
561
<a name="gimp-context-set-pattern"></a>gimp_context_set_pattern ()</h3>
579
 
<a class="indexterm" name="id2568784"></a><pre class="programlisting">gboolean    gimp_context_set_pattern        (const gchar *name);</pre>
 
562
<a class="indexterm" name="id2607172"></a><pre class="programlisting">gboolean            gimp_context_set_pattern            (const gchar *name);</pre>
580
563
<p>
581
564
Set the specified pattern as the active pattern.
582
565
</p>
594
577
<col align="left" valign="top">
595
578
<tbody>
596
579
<tr>
597
 
<td>
598
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
580
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
599
581
<td> The name of the pattern.
600
582
</td>
601
583
</tr>
602
584
<tr>
603
 
<td>
604
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
585
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
605
586
<td> TRUE on success.
606
587
 
607
588
</td>
608
589
</tr>
609
590
</tbody>
610
591
</table></div>
611
 
<p>Since  GIMP 2.2
 
592
<p class="since">Since  GIMP 2.2
612
593
</p>
613
594
</div>
614
595
<hr>
615
596
<div class="refsect2" lang="en">
616
 
<a name="id2568858"></a><h3>
 
597
<a name="id2607241"></a><h3>
617
598
<a name="gimp-context-get-gradient"></a>gimp_context_get_gradient ()</h3>
618
 
<a class="indexterm" name="id2568872"></a><pre class="programlisting">gchar*      gimp_context_get_gradient       (void);</pre>
 
599
<a class="indexterm" name="id2607254"></a><pre class="programlisting">gchar*              gimp_context_get_gradient           (void);</pre>
619
600
<p>
620
601
Retrieve the currently active gradient.
621
602
</p>
627
608
<div class="variablelist"><table border="0">
628
609
<col align="left" valign="top">
629
610
<tbody><tr>
630
 
<td>
631
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
611
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
632
612
<td> The name of the active gradient.
633
613
 
634
614
</td>
635
615
</tr></tbody>
636
616
</table></div>
637
 
<p>Since  GIMP 2.2
 
617
<p class="since">Since  GIMP 2.2
638
618
</p>
639
619
</div>
640
620
<hr>
641
621
<div class="refsect2" lang="en">
642
 
<a name="id2568922"></a><h3>
 
622
<a name="id2607301"></a><h3>
643
623
<a name="gimp-context-set-gradient"></a>gimp_context_set_gradient ()</h3>
644
 
<a class="indexterm" name="id2568936"></a><pre class="programlisting">gboolean    gimp_context_set_gradient       (const gchar *name);</pre>
 
624
<a class="indexterm" name="id2607314"></a><pre class="programlisting">gboolean            gimp_context_set_gradient           (const gchar *name);</pre>
645
625
<p>
646
626
Sets the specified gradient as the active gradient.
647
627
</p>
659
639
<col align="left" valign="top">
660
640
<tbody>
661
641
<tr>
662
 
<td>
663
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
642
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
664
643
<td> The name of the gradient.
665
644
</td>
666
645
</tr>
667
646
<tr>
668
 
<td>
669
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
647
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
670
648
<td> TRUE on success.
671
649
 
672
650
</td>
673
651
</tr>
674
652
</tbody>
675
653
</table></div>
676
 
<p>Since  GIMP 2.2
 
654
<p class="since">Since  GIMP 2.2
677
655
</p>
678
656
</div>
679
657
<hr>
680
658
<div class="refsect2" lang="en">
681
 
<a name="id2569011"></a><h3>
 
659
<a name="id2607384"></a><h3>
682
660
<a name="gimp-context-get-palette"></a>gimp_context_get_palette ()</h3>
683
 
<a class="indexterm" name="id2569025"></a><pre class="programlisting">gchar*      gimp_context_get_palette        (void);</pre>
 
661
<a class="indexterm" name="id2607396"></a><pre class="programlisting">gchar*              gimp_context_get_palette            (void);</pre>
684
662
<p>
685
663
Retrieve the currently active palette.
686
664
</p>
692
670
<div class="variablelist"><table border="0">
693
671
<col align="left" valign="top">
694
672
<tbody><tr>
695
 
<td>
696
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
673
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
697
674
<td> The name of the active palette.
698
675
 
699
676
</td>
700
677
</tr></tbody>
701
678
</table></div>
702
 
<p>Since  GIMP 2.2
 
679
<p class="since">Since  GIMP 2.2
703
680
</p>
704
681
</div>
705
682
<hr>
706
683
<div class="refsect2" lang="en">
707
 
<a name="id2569075"></a><h3>
 
684
<a name="id2607444"></a><h3>
708
685
<a name="gimp-context-set-palette"></a>gimp_context_set_palette ()</h3>
709
 
<a class="indexterm" name="id2569088"></a><pre class="programlisting">gboolean    gimp_context_set_palette        (const gchar *name);</pre>
 
686
<a class="indexterm" name="id2607456"></a><pre class="programlisting">gboolean            gimp_context_set_palette            (const gchar *name);</pre>
710
687
<p>
711
688
Set the specified palette as the active palette.
712
689
</p>
724
701
<col align="left" valign="top">
725
702
<tbody>
726
703
<tr>
727
 
<td>
728
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
704
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
729
705
<td> The name of the palette.
730
706
</td>
731
707
</tr>
732
708
<tr>
733
 
<td>
734
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
709
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
735
710
<td> TRUE on success.
736
711
 
737
712
</td>
738
713
</tr>
739
714
</tbody>
740
715
</table></div>
741
 
<p>Since  GIMP 2.2
 
716
<p class="since">Since  GIMP 2.2
742
717
</p>
743
718
</div>
744
719
<hr>
745
720
<div class="refsect2" lang="en">
746
 
<a name="id2569163"></a><h3>
 
721
<a name="id2607526"></a><h3>
747
722
<a name="gimp-context-get-font"></a>gimp_context_get_font ()</h3>
748
 
<a class="indexterm" name="id2569177"></a><pre class="programlisting">gchar*      gimp_context_get_font           (void);</pre>
 
723
<a class="indexterm" name="id2607538"></a><pre class="programlisting">gchar*              gimp_context_get_font               (void);</pre>
749
724
<p>
750
725
Retrieve the currently active font.
751
726
</p>
757
732
<div class="variablelist"><table border="0">
758
733
<col align="left" valign="top">
759
734
<tbody><tr>
760
 
<td>
761
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
735
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
762
736
<td> The name of the active font.
763
737
 
764
738
</td>
765
739
</tr></tbody>
766
740
</table></div>
767
 
<p>Since  GIMP 2.2
 
741
<p class="since">Since  GIMP 2.2
768
742
</p>
769
743
</div>
770
744
<hr>
771
745
<div class="refsect2" lang="en">
772
 
<a name="id2569227"></a><h3>
 
746
<a name="id2607586"></a><h3>
773
747
<a name="gimp-context-set-font"></a>gimp_context_set_font ()</h3>
774
 
<a class="indexterm" name="id2569240"></a><pre class="programlisting">gboolean    gimp_context_set_font           (const gchar *name);</pre>
 
748
<a class="indexterm" name="id2607598"></a><pre class="programlisting">gboolean            gimp_context_set_font               (const gchar *name);</pre>
775
749
<p>
776
750
Set the specified font as the active font.
777
751
</p>
788
762
<col align="left" valign="top">
789
763
<tbody>
790
764
<tr>
791
 
<td>
792
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
765
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
793
766
<td> The name of the font.
794
767
</td>
795
768
</tr>
796
769
<tr>
797
 
<td>
798
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
799
 
<td> TRUE on success.
800
 
 
801
 
</td>
802
 
</tr>
803
 
</tbody>
804
 
</table></div>
805
 
<p>Since  GIMP 2.2
 
770
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
771
<td> TRUE on success.
 
772
 
 
773
</td>
 
774
</tr>
 
775
</tbody>
 
776
</table></div>
 
777
<p class="since">Since  GIMP 2.2
 
778
</p>
 
779
</div>
 
780
<hr>
 
781
<div class="refsect2" lang="en">
 
782
<a name="id2607668"></a><h3>
 
783
<a name="gimp-context-get-paint-method"></a>gimp_context_get_paint_method ()</h3>
 
784
<a class="indexterm" name="id2607682"></a><pre class="programlisting">gchar*              gimp_context_get_paint_method       (void);</pre>
 
785
<p>
 
786
Retrieve the currently active paint method.
 
787
</p>
 
788
<p>
 
789
This procedure returns the name of the currently active paint
 
790
method.</p>
 
791
<p>
 
792
 
 
793
</p>
 
794
<div class="variablelist"><table border="0">
 
795
<col align="left" valign="top">
 
796
<tbody><tr>
 
797
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
798
<td> The name of the active paint method.
 
799
 
 
800
</td>
 
801
</tr></tbody>
 
802
</table></div>
 
803
<p class="since">Since  GIMP 2.4
 
804
</p>
 
805
</div>
 
806
<hr>
 
807
<div class="refsect2" lang="en">
 
808
<a name="id2607731"></a><h3>
 
809
<a name="gimp-context-set-paint-method"></a>gimp_context_set_paint_method ()</h3>
 
810
<a class="indexterm" name="id2607746"></a><pre class="programlisting">gboolean            gimp_context_set_paint_method       (const gchar *name);</pre>
 
811
<p>
 
812
Set the specified paint method as the active paint method.
 
813
</p>
 
814
<p>
 
815
This procedure allows the active paint method to be set by
 
816
specifying its name. The name is simply a string which corresponds
 
817
to one of the names of the available paint methods. If there is no
 
818
matching method found, this procedure will return an error.
 
819
Otherwise, the specified method becomes active and will be used in
 
820
all subsequent paint operations.</p>
 
821
<p>
 
822
 
 
823
</p>
 
824
<div class="variablelist"><table border="0">
 
825
<col align="left" valign="top">
 
826
<tbody>
 
827
<tr>
 
828
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
829
<td> The name of the paint method.
 
830
</td>
 
831
</tr>
 
832
<tr>
 
833
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
834
<td> TRUE on success.
 
835
 
 
836
</td>
 
837
</tr>
 
838
</tbody>
 
839
</table></div>
 
840
<p class="since">Since  GIMP 2.4
806
841
</p>
807
842
</div>
808
843
</div>