/usr/share/gtk-doc/html/libgimp/libgimp-gimppalette.html is in libgimp2.0-doc 2.6.12-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimppalette</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-gimpgradients.html" title="gimpgradients">
<link rel="next" href="libgimp-gimppalettes.html" title="gimppalettes">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpgradients.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppalettes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimppalette.synopsis" class="shortcut">Top</a>
|
<a href="#libgimp-gimppalette.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgimp-gimppalette"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimppalette.top_of_page"></a>gimppalette</span></h2>
<p>gimppalette — Functions operating on a single palette.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimp-gimppalette.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimppalette.html#gimp-palette-new" title="gimp_palette_new ()">gimp_palette_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimppalette.html#gimp-palette-duplicate" title="gimp_palette_duplicate ()">gimp_palette_duplicate</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimppalette.html#gimp-palette-rename" title="gimp_palette_rename ()">gimp_palette_rename</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-delete" title="gimp_palette_delete ()">gimp_palette_delete</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-get-info" title="gimp_palette_get_info ()">gimp_palette_get_info</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);
<a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="returnvalue">GimpRGB</span></a> * <a class="link" href="libgimp-gimppalette.html#gimp-palette-get-colors" title="gimp_palette_get_colors ()">gimp_palette_get_colors</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-get-columns" title="gimp_palette_get_columns ()">gimp_palette_get_columns</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-set-columns" title="gimp_palette_set_columns ()">gimp_palette_set_columns</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> columns</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-add-entry" title="gimp_palette_add_entry ()">gimp_palette_add_entry</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *entry_name</code></em>,
<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
<em class="parameter"><code><span class="type">gint</span> *entry_num</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-delete-entry" title="gimp_palette_delete_entry ()">gimp_palette_delete_entry</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-entry-get-color" title="gimp_palette_entry_get_color ()">gimp_palette_entry_get_color</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-entry-set-color" title="gimp_palette_entry_set_color ()">gimp_palette_entry_set_color</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-entry-get-name" title="gimp_palette_entry_get_name ()">gimp_palette_entry_get_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **entry_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-entry-set-name" title="gimp_palette_entry_set_name ()">gimp_palette_entry_set_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *entry_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-get-foreground" title="gimp_palette_get_foreground ()">gimp_palette_get_foreground</a> (<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *foreground</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-get-background" title="gimp_palette_get_background ()">gimp_palette_get_background</a> (<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *background</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-set-foreground" title="gimp_palette_set_foreground ()">gimp_palette_set_foreground</a> (<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *foreground</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-set-background" title="gimp_palette_set_background ()">gimp_palette_set_background</a> (<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *background</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-set-default-colors" title="gimp_palette_set_default_colors ()">gimp_palette_set_default_colors</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-swap-colors" title="gimp_palette_swap_colors ()">gimp_palette_swap_colors</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimppalette.html#gimp-palette-is-editable" title="gimp_palette_is_editable ()">gimp_palette_is_editable</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgimp-gimppalette.description"></a><h2>Description</h2>
<p>
Functions operating on a single palette.
</p>
</div>
<div class="refsect1">
<a name="libgimp-gimppalette.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gimp-palette-new"></a><h3>gimp_palette_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_palette_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Creates a new palette
</p>
<p>
This procedure creates a new, uninitialized palette
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The requested name of the new palette.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The actual new palette name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-duplicate"></a><h3>gimp_palette_duplicate ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_palette_duplicate (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Duplicates a palette
</p>
<p>
This procedure creates an identical palette by a different name
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the palette's copy.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-rename"></a><h3>gimp_palette_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gimp_palette_rename (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);</pre>
<p>
Rename a palette
</p>
<p>
This procedure renames a palette
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_name</code></em> :</span></p></td>
<td>The new name of the palette.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The actual new name of the palette.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-delete"></a><h3>gimp_palette_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_delete (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Deletes a palette
</p>
<p>
This procedure deletes a palette
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-get-info"></a><h3>gimp_palette_get_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_get_info (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);</pre>
<p>
Retrieve information about the specified palette.
</p>
<p>
This procedure retrieves information about the specified palette.
This includes the name, and the number of colors.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
<td>The number of colors in the palette.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-get-colors"></a><h3>gimp_palette_get_colors ()</h3>
<pre class="programlisting"><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="returnvalue">GimpRGB</span></a> * gimp_palette_get_colors (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);</pre>
<p>
Gets all colors from the specified palette.
</p>
<p>
This procedure retrieves all color entries of the specified palette.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
<td>Length of the colors array.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The colors in the palette.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-get-columns"></a><h3>gimp_palette_get_columns ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> gimp_palette_get_columns (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Retrieves the number of columns to use to display this palette
</p>
<p>
This procedures retrieves the prefered number of columns to use when
the palette is being displayed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of columns used to display this palette.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-set-columns"></a><h3>gimp_palette_set_columns ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_set_columns (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> columns</code></em>);</pre>
<p>
Sets the number of columns to use when displaying the palette
</p>
<p>
This procedures allows to control how many colors are shown per row
when the palette is being displayed. This value can only be changed
if the palette is writable. The maximum allowed value is 64.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>columns</code></em> :</span></p></td>
<td>The new number of columns.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-add-entry"></a><h3>gimp_palette_add_entry ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_add_entry (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *entry_name</code></em>,
<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>,
<em class="parameter"><code><span class="type">gint</span> *entry_num</code></em>);</pre>
<p>
Adds a palette entry to the specified palette.
</p>
<p>
This procedure adds an entry to the specifed palette. It returns an
error if the entry palette does not exist.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_name</code></em> :</span></p></td>
<td>The name of the entry.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>The new entry's color color.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The index of the added entry.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-delete-entry"></a><h3>gimp_palette_delete_entry ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_delete_entry (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>);</pre>
<p>
Deletes a palette entry from the specified palette.
</p>
<p>
This procedure deletes an entry from the specifed palette. It
returns an error if the entry palette does not exist.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The index of the added entry.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-entry-get-color"></a><h3>gimp_palette_entry_get_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_entry_get_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);</pre>
<p>
Gets the specified palette entry from the specified palette.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The entry to retrieve.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>The color requested.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-entry-set-color"></a><h3>gimp_palette_entry_set_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_entry_set_color (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);</pre>
<p>
Sets the specified palette entry in the specified palette.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The entry to retrieve.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>The new color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-entry-get-name"></a><h3>gimp_palette_entry_get_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_entry_get_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **entry_name</code></em>);</pre>
<p>
Gets the specified palette entry from the specified palette.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The entry to retrieve.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_name</code></em> :</span></p></td>
<td>The name requested.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-entry-set-name"></a><h3>gimp_palette_entry_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_entry_set_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gint</span> entry_num</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *entry_name</code></em>);</pre>
<p>
Sets the specified palette entry in the specified palette.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_num</code></em> :</span></p></td>
<td>The entry to retrieve.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry_name</code></em> :</span></p></td>
<td>The new name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-get-foreground"></a><h3>gimp_palette_get_foreground ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_get_foreground (<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *foreground</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_get_foreground</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Get the current GIMP foreground color.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>foreground</code></em> :</span></p></td>
<td>The foreground color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-get-background"></a><h3>gimp_palette_get_background ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_get_background (<em class="parameter"><code><a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *background</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_get_background</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Get the current GIMP background color.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>background</code></em> :</span></p></td>
<td>The background color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-set-foreground"></a><h3>gimp_palette_set_foreground ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_set_foreground (<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *foreground</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_set_foreground</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Set the current GIMP foreground color.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>foreground</code></em> :</span></p></td>
<td>The foreground color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-set-background"></a><h3>gimp_palette_set_background ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_set_background (<em class="parameter"><code>const <a href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *background</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_set_background</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Set the current GIMP background color.
</p>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>background</code></em> :</span></p></td>
<td>The background color.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-set-default-colors"></a><h3>gimp_palette_set_default_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_set_default_colors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_set_default_colors</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Set the current GIMP foreground and background colors to black and
white.
</p>
<p>
This procedure sets the current GIMP foreground and background
colors to their initial default values, black and white.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-swap-colors"></a><h3>gimp_palette_swap_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_swap_colors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_palette_swap_colors</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Swap the current GIMP foreground and background colors.
</p>
<p>
This procedure swaps the current GIMP foreground and background
colors, so that the new foreground color becomes the old background
color and vice versa.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-palette-is-editable"></a><h3>gimp_palette_is_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_palette_is_editable (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Tests if palette can be edited
</p>
<p>
Returns TRUE if you have permission to change the palette
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The palette name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the palette can be edited.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|