* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
+/**
+ * SECTION:gtkcolorchooser
+ * @Short_description: Interface implemented by widgets for choosing colors
+ * @Title: GtkColorChooser
+ * @See_also: #GtkColorChooserDialog, #GtkColorChooserWidget, #GtkColorButton
+ *
+ * #GtkColorChooser is an interface that is implemented by widgets
+ * for choosing colors. Depending on the situation, colors may be
+ * allowed to have alpha (translucency).
+ *
+ * In GTK+, the main widgets that implement this interface are
+ * #GtkColorChooserWidget, #GtkColorChooserDialog and #GtkColorButton.
+ *
+ * Since: 3.4
+ */
+
enum
{
COLOR_ACTIVATED,
static void
gtk_color_chooser_default_init (GtkColorChooserInterface *iface)
{
+ /**
+ * GtkColorChooser:rgba:
+ *
+ * The ::rgba property contains the currently selected color,
+ * as a #GdkRGBA struct. The property can be set to change
+ * the current selection programmatically.
+ *
+ * Since: 3.4
+ */
g_object_interface_install_property (iface,
g_param_spec_boxed ("rgba",
P_("Color"),
GDK_TYPE_RGBA,
GTK_PARAM_READWRITE));
+ /**
+ * GtkColorChooser:use-alpha:
+ *
+ * When ::use-alpha is %TRUE, colors may have alpha (translucency)
+ * information. When it is %FALSE, the #GdkRGBA struct obtained
+ * via the #GtkColorChooser:rgba property will be forced to have
+ * alpha == 1.
+ *
+ * Implementations are expected to show alpha by rendering the color
+ * over a non-uniform background (like a checkerboard pattern).
+ *
+ * Since: 3.4
+ */
g_object_interface_install_property (iface,
g_param_spec_boolean ("use-alpha",
P_("Use alpha"),
/**
* GtkColorChooser::color-activated:
- * @self: the object which received the signal
+ * @chooser: the object which received the signal
* @color: the color
*
* Emitted when a color is activated from the color chooser.
* This usually happens when the user clicks a color swatch,
* or a color is selected and the user presses one of the keys
* Space, Shift+Space, Return or Enter.
- */
+ *
+ * Since: 3.4
+ */
signals[COLOR_ACTIVATED] =
g_signal_new ("color-activated",
GTK_TYPE_COLOR_CHOOSER,
NULL, NULL,
NULL,
G_TYPE_NONE,
- 1, G_TYPE_STRING);
+ 1, GDK_TYPE_RGBA);
+}
+
+void
+_gtk_color_chooser_color_activated (GtkColorChooser *chooser,
+ const GdkRGBA *color)
+{
+ g_signal_emit (chooser, signals[COLOR_ACTIVATED], 0, color);
}
/**
* gtk_color_chooser_get_rgba:
* @chooser: a #GtkColorChooser
- * @color: return location for the color
+ * @color: (out): a #GdkRGBA to fill in with the current color
*
* Gets the currently-selected color.
+ *
+ * Since: 3.4
*/
void
gtk_color_chooser_get_rgba (GtkColorChooser *chooser,
* @chooser: a #GtkColorChooser
* @color: the new color
*
- * Sets the currently-selected color.
+ * Sets the color.
+ *
+ * Since: 3.4
*/
void
gtk_color_chooser_set_rgba (GtkColorChooser *chooser,
GTK_COLOR_CHOOSER_GET_IFACE (chooser)->set_rgba (chooser, color);
}
-void
-_gtk_color_chooser_color_activated (GtkColorChooser *chooser,
- const GdkRGBA *color)
-{
- g_return_if_fail (GTK_IS_COLOR_CHOOSER (chooser));
-
- g_signal_emit (chooser, signals[COLOR_ACTIVATED], 0, color);
-}
-
+/**
+ * gtk_color_chooser_get_use_alpha:
+ * @chooser: a #GtkColorChooser
+ *
+ * Returns whether the color chooser shows the alpha channel.
+ *
+ * Returns: %TRUE if the color chooser uses the alpha channel,
+ * %FALSE if not
+ *
+ * Since: 3.4
+ */
gboolean
gtk_color_chooser_get_use_alpha (GtkColorChooser *chooser)
{
return use_alpha;
}
+/**
+ * gtk_color_chooser_set_use_alpha:
+ * @chooser: a #GtkColorChooser
+ * @use_alpha: %TRUE if color chooser should use alpha channel, %FALSE if not
+ *
+ * Sets whether or not the color chooser should use the alpha channel.
+ *
+ * Since: 3.4
+ */
void
gtk_color_chooser_set_use_alpha (GtkColorChooser *chooser,
gboolean use_alpha)
g_object_set (chooser, "use-alpha", use_alpha, NULL);
}
+
+/**
+ * gtk_color_chooser_add_palette:
+ * @chooser: a #GtkColorChooser
+ * @orientation: %GTK_ORIENTATION_HORIZONTAL if the palette should
+ * be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
+ * @colors_per_line: the number of colors to show in each row/column
+ * @n_colors: the total number of elements in @colors
+ * @colors: (allow-none) (array length=n_colors): the colors of the palette, or %NULL
+ *
+ * Adds a palette to the color chooser. If @orientation is horizontal,
+ * the colors are grouped in rows, with @colors_per_line colors
+ * in each row. If @horizontal is %FALSE, the colors are grouped
+ * in columns instead.
+ *
+ * The default color palette of #GtkColorChooserWidget has
+ * 27 colors, organized in columns of 3 colors. The default gray
+ * palette has 9 grays in a single row.
+ *
+ * The layout of the color chooser widget works best when the
+ * palettes have 9-10 columns.
+ *
+ * Calling this function for the first time has the
+ * side effect of removing the default color and gray palettes
+ * from the color chooser.
+ *
+ * If @colors is %NULL, removes all previously added palettes.
+ *
+ * Since: 3.4
+ */
+void
+gtk_color_chooser_add_palette (GtkColorChooser *chooser,
+ GtkOrientation orientation,
+ gint colors_per_line,
+ gint n_colors,
+ GdkRGBA *colors)
+{
+ g_return_if_fail (GTK_IS_COLOR_CHOOSER (chooser));
+
+ if (GTK_COLOR_CHOOSER_GET_IFACE (chooser)->add_palette)
+ GTK_COLOR_CHOOSER_GET_IFACE (chooser)->add_palette (chooser, orientation, colors_per_line, n_colors, colors);
+}
+
+cairo_pattern_t *
+_gtk_color_chooser_get_checkered_pattern (void)
+{
+ /* need to respect pixman's stride being a multiple of 4 */
+ static unsigned char data[8] = { 0xFF, 0x00, 0x00, 0x00,
+ 0x00, 0xFF, 0x00, 0x00 };
+ static cairo_surface_t *checkered = NULL;
+ cairo_pattern_t *pattern;
+
+ if (checkered == NULL)
+ checkered = cairo_image_surface_create_for_data (data,
+ CAIRO_FORMAT_A8,
+ 2, 2, 4);
+
+ pattern = cairo_pattern_create_for_surface (checkered);
+ cairo_pattern_set_extend (pattern, CAIRO_EXTEND_REPEAT);
+ cairo_pattern_set_filter (pattern, CAIRO_FILTER_NEAREST);
+
+ return pattern;
+}
projects / ~andy / gtk / blobdiff