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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimppalette">
<refmeta>
<refentrytitle role="top_of_page">gimppalette</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppalette</refname>
<refpurpose>Functions operating on a single palette.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-palette-new">gimp_palette_new</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>* <link linkend="gimp-palette-duplicate">gimp_palette_duplicate</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>* <link linkend="gimp-palette-rename">gimp_palette_rename</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *new_name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-delete">gimp_palette_delete</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-get-info">gimp_palette_get_info</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *num_colors);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-add-entry">gimp_palette_add_entry</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *entry_name,
const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="gint">gint</link> *entry_num);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-delete-entry">gimp_palette_delete_entry</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-entry-get-color">gimp_palette_entry_get_color</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
<link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-entry-set-color">gimp_palette_entry_set_color</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-entry-get-name">gimp_palette_entry_get_name</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
<link linkend="gchar">gchar</link> **entry_name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-entry-set-name">gimp_palette_entry_set_name</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
const <link linkend="gchar">gchar</link> *entry_name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-get-foreground">gimp_palette_get_foreground</link> (<link linkend="GimpRGB">GimpRGB</link> *foreground);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-get-background">gimp_palette_get_background</link> (<link linkend="GimpRGB">GimpRGB</link> *background);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-set-foreground">gimp_palette_set_foreground</link> (const <link linkend="GimpRGB">GimpRGB</link> *foreground);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-set-background">gimp_palette_set_background</link> (const <link linkend="GimpRGB">GimpRGB</link> *background);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-set-default-colors">gimp_palette_set_default_colors</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-palette-swap-colors">gimp_palette_swap_colors</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions operating on a single palette.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-palette-new" role="function" condition="since:GIMP 2.2"/>gimp_palette_new ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_palette_new (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Creates a new palette
</para>
<para>
This procedure creates a new, uninitialized palette</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The requested name of the new palette.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new palette name.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-duplicate" role="function" condition="since:GIMP 2.2"/>gimp_palette_duplicate ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_palette_duplicate (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Duplicates a palette
</para>
<para>
This procedure creates an identical palette by a different name</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the palette's copy.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-rename" role="function" condition="since:GIMP 2.2"/>gimp_palette_rename ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_palette_rename (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *new_name);</programlisting>
<para>
Rename a palette
</para>
<para>
This procedure renames a palette</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_name</parameter> :</term>
<listitem><simpara> The new name of the palette.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new name of the palette.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-delete" role="function" condition="since:GIMP 2.2"/>gimp_palette_delete ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_delete (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Deletes a palette
</para>
<para>
This procedure deletes a palette</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-get-info" role="function" condition="since:GIMP 2.2"/>gimp_palette_get_info ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_get_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_get_info (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *num_colors);</programlisting>
<para>
Retrieve information about the specified palette.
</para>
<para>
This procedure retrieves information about the specified palette.
This includes the name, and the number of colors.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_colors</parameter> :</term>
<listitem><simpara> The number of colors in the palette.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-add-entry" role="function" condition="since:GIMP 2.2"/>gimp_palette_add_entry ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_add_entry</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_add_entry (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *entry_name,
const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="gint">gint</link> *entry_num);</programlisting>
<para>
Adds a palette entry to the specified palette.
</para>
<para>
This procedure adds an entry to the specifed palette. It returns an
error if the entry palette does not exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_name</parameter> :</term>
<listitem><simpara> The name of the entry.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The new entry's color color.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The index of the added entry.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-delete-entry" role="function" condition="since:GIMP 2.2"/>gimp_palette_delete_entry ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_delete_entry</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_delete_entry (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num);</programlisting>
<para>
Deletes a palette entry from the specified palette.
</para>
<para>
This procedure deletes an entry from the specifed palette. It
returns an error if the entry palette does not exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The index of the added entry.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-entry-get-color" role="function" condition="since:GIMP 2.2"/>gimp_palette_entry_get_color ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_entry_get_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_entry_get_color (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Gets the specified palette entry from the specified palette.
</para>
<para>
This procedure retrieves the color of the zero-based entry specifed
for the specified palette. It returns an error if the entry does not
exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The entry to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The color requested.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-entry-set-color" role="function" condition="since:GIMP 2.2"/>gimp_palette_entry_set_color ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_entry_set_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_entry_set_color (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Sets the specified palette entry in the specified palette.
</para>
<para>
This procedure sets the color of the zero-based entry specifed for
the specified palette. It returns an error if the entry does not
exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The entry to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The new color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-entry-get-name" role="function" condition="since:GIMP 2.2"/>gimp_palette_entry_get_name ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_entry_get_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_entry_get_name (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
<link linkend="gchar">gchar</link> **entry_name);</programlisting>
<para>
Gets the specified palette entry from the specified palette.
</para>
<para>
This procedure retrieves the name of the zero-based entry specifed
for the specified palette. It returns an error if the entry does not
exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The entry to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_name</parameter> :</term>
<listitem><simpara> The name requested.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-entry-set-name" role="function" condition="since:GIMP 2.2"/>gimp_palette_entry_set_name ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_palette_entry_set_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_entry_set_name (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> entry_num,
const <link linkend="gchar">gchar</link> *entry_name);</programlisting>
<para>
Sets the specified palette entry in the specified palette.
</para>
<para>
This procedure sets the name of the zero-based entry specifed for
the specified palette. It returns an error if the entry does not
exist.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The palette name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_num</parameter> :</term>
<listitem><simpara> The entry to retrieve.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_name</parameter> :</term>
<listitem><simpara> The new name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-palette-get-foreground" role="function" condition="deprecated:"/>gimp_palette_get_foreground ()</title>
<indexterm role="deprecated"><primary>gimp_palette_get_foreground</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_get_foreground (<link linkend="GimpRGB">GimpRGB</link> *foreground);</programlisting>
<warning><para><literal>gimp_palette_get_foreground</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the current GIMP foreground color.
</para>
<para>
This procedure retrieves the current GIMP foreground color. The
foreground color is used in a variety of tools such as paint tools,
blending, and bucket fill.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>foreground</parameter> :</term>
<listitem><simpara> The foreground color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-palette-get-background" role="function" condition="deprecated:"/>gimp_palette_get_background ()</title>
<indexterm role="deprecated"><primary>gimp_palette_get_background</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_get_background (<link linkend="GimpRGB">GimpRGB</link> *background);</programlisting>
<warning><para><literal>gimp_palette_get_background</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the current GIMP background color.
</para>
<para>
This procedure retrieves the current GIMP background color. The
background color is used in a variety of tools such as blending,
erasing (with non-alpha images), and image filling.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>background</parameter> :</term>
<listitem><simpara> The background color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-palette-set-foreground" role="function" condition="deprecated:"/>gimp_palette_set_foreground ()</title>
<indexterm role="deprecated"><primary>gimp_palette_set_foreground</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_set_foreground (const <link linkend="GimpRGB">GimpRGB</link> *foreground);</programlisting>
<warning><para><literal>gimp_palette_set_foreground</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set the current GIMP foreground color.
</para>
<para>
This procedure sets the current GIMP foreground color. After this is
set, operations which use foreground such as paint tools, blending,
and bucket fill will use the new value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>foreground</parameter> :</term>
<listitem><simpara> The foreground color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-palette-set-background" role="function" condition="deprecated:"/>gimp_palette_set_background ()</title>
<indexterm role="deprecated"><primary>gimp_palette_set_background</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_set_background (const <link linkend="GimpRGB">GimpRGB</link> *background);</programlisting>
<warning><para><literal>gimp_palette_set_background</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set the current GIMP background color.
</para>
<para>
This procedure sets the current GIMP background color. After this is
set, operations which use background such as blending, filling
images, clearing, and erasing (in non-alpha images) will use the new
value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>background</parameter> :</term>
<listitem><simpara> The background color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-palette-set-default-colors" role="function" condition="deprecated:"/>gimp_palette_set_default_colors ()</title>
<indexterm role="deprecated"><primary>gimp_palette_set_default_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_set_default_colors (void);</programlisting>
<warning><para><literal>gimp_palette_set_default_colors</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set the current GIMP foreground and background colors to black and
white.
</para>
<para>
This procedure sets the current GIMP foreground and background
colors to their initial default values, black and white.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-palette-swap-colors" role="function" condition="deprecated:"/>gimp_palette_swap_colors ()</title>
<indexterm role="deprecated"><primary>gimp_palette_swap_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_palette_swap_colors (void);</programlisting>
<warning><para><literal>gimp_palette_swap_colors</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Swap the current GIMP foreground and background colors.
</para>
<para>
This procedure swaps the current GIMP foreground and background
colors, so that the new foreground color becomes the old background
color and vice versa.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|