Commit 3dd12b44 authored by Michael Natterer's avatar Michael Natterer 😴 Committed by Michael Natterer

made the "GimpRGB *color" param const.

2003-10-15  Michael Natterer  <mitch@gimp.org>

	* app/widgets/gimpcolorframe.[ch] (gimp_color_frame_set_color):
	made the "GimpRGB *color" param const.

	Added API docs for all public functions.
parent 8f48a8a2
2003-10-15 Michael Natterer <mitch@gimp.org>
* app/widgets/gimpcolorframe.[ch] (gimp_color_frame_set_color):
made the "GimpRGB *color" param const.
Added API docs for all public functions.
2003-10-15 Sven Neumann <sven@gimp.org>
* app/config/gimpconfig-utils.c (gimp_config_diff_internal): minor
......@@ -27,7 +34,7 @@
* app/widgets/Makefile.am
* app/widgets/gimpcolorframe.[ch]: new widget GimpColorFrame which
shows a picked color in an optionmenu-selectable color space.
Helps getting rid in InfoDialog.
Helps getting rid of InfoDialog.
* app/gui/info-window.c: use it for the "extended" page. Cleaned
up that page a lot so it can be made dockable in the next step.
......@@ -123,6 +123,13 @@ gimp_color_frame_init (GimpColorFrame *frame)
}
}
/**
* gimp_color_frame_new:
*
* Creates a new #GimpColorFrame widget.
*
* Return value: The new #GimpColorFrame widget.
**/
GtkWidget *
gimp_color_frame_new (void)
{
......@@ -133,6 +140,14 @@ gimp_color_frame_new (void)
return GTK_WIDGET (frame);
}
/**
* gimp_color_frame_set_mode:
* @frame: The #GimpColorFrame.
* @mode: The new @mode.
*
* Sets the #GimpColorFrame's color @mode. Calling this function does
* the same as selecting the @mode from the frame's #GtkOptionMenu.
**/
void
gimp_color_frame_set_mode (GimpColorFrame *frame,
GimpColorFrameMode mode)
......@@ -146,10 +161,22 @@ gimp_color_frame_set_mode (GimpColorFrame *frame,
gimp_color_frame_update (frame);
}
/**
* gimp_color_frame_set_color:
* @frame: The #GimpColorFrame.
* @sample_type: The type of the #GimpDrawable or #GimpImage the @color
* was picked from.
* @color: The @color to set.
* @color_index: The @color's index. This value is ignored unless
* @sample_type equals to #GIMP_INDEXED_IMAGE or
* #GIMP_INDEXEDA_IMAGE.
*
* Sets the color sample to display in the #GimpColorFrame.
**/
void
gimp_color_frame_set_color (GimpColorFrame *frame,
GimpImageType sample_type,
GimpRGB *color,
const GimpRGB *color,
gint color_index)
{
g_return_if_fail (GIMP_IS_COLOR_FRAME (frame));
......@@ -163,6 +190,16 @@ gimp_color_frame_set_color (GimpColorFrame *frame,
gimp_color_frame_update (frame);
}
/**
* gimp_color_frame_set_invalid:
* @frame: The #GimpColorFrame.
*
* Tells the #GimpColorFrame that the current sample is invalid. All labels
* visible for the current color space will show "N/A" (not available).
*
* There is no special API for setting the frame to "valid" again because
* this happens automatically when calling gimp_color_frame_set_color().
**/
void
gimp_color_frame_set_invalid (GimpColorFrame *frame)
{
......
......@@ -20,7 +20,7 @@
#define __GIMP_COLOR_FRAME_H__
#include <gtk/gtk.h>
#include <gtk/gtkframe.h>
#define GIMP_COLOR_FRAME_ROWS 5
......@@ -67,7 +67,7 @@ void gimp_color_frame_set_mode (GimpColorFrame *frame,
GimpColorFrameMode mode);
void gimp_color_frame_set_color (GimpColorFrame *frame,
GimpImageType sample_type,
GimpRGB *color,
const GimpRGB *color,
gint color_index);
void gimp_color_frame_set_invalid (GimpColorFrame *frame);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment