Files
gimp/libgimpwidgets/gimpwidgets.h
Ell d928ed7252 libgimpwidgets: add GimpSpinButton
GimpSpinButton is a drop-in replacement for (and a subclass of)
GtkSpinButton.  Unlike GtkSpinButton, it avoids updating the
adjustment value when losing focus, unless the entry text has
changed.  This prevents accidental loss of precision, when the
adjustment value can't be accurately displayed in the entry.

Note that libgimpwidgets already defines a (deprecated)
gimp_spin_button_new() function.  This commit stays compatible with
the old function, by defining GimpSpinButton's _new() function as
gimp_spin_button_new_(), and defining a variadic
gimp_spin_button_new() macro, which expands to either the old or
the new function, based on the number of arguments, so that either
function can be used transparently as gimp_spin_button_new().  This
is all gone in master.
2018-11-10 06:57:54 -05:00

257 lines
10 KiB
C

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpwidgets.h
* Copyright (C) 2000 Michael Natterer <mitch@gimp.org>
*
* This library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* 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, see
* <https://www.gnu.org/licenses/>.
*/
#ifndef __GIMP_WIDGETS_H__
#define __GIMP_WIDGETS_H__
#define __GIMP_WIDGETS_H_INSIDE__
#include <libgimpwidgets/gimpwidgetstypes.h>
#include <libgimpwidgets/gimpbrowser.h>
#include <libgimpwidgets/gimpbusybox.h>
#include <libgimpwidgets/gimpbutton.h>
#include <libgimpwidgets/gimpcairo-utils.h>
#include <libgimpwidgets/gimpcellrenderercolor.h>
#include <libgimpwidgets/gimpcellrenderertoggle.h>
#include <libgimpwidgets/gimpchainbutton.h>
#include <libgimpwidgets/gimpcolorarea.h>
#include <libgimpwidgets/gimpcolorbutton.h>
#include <libgimpwidgets/gimpcolordisplay.h>
#include <libgimpwidgets/gimpcolordisplaystack.h>
#include <libgimpwidgets/gimpcolorhexentry.h>
#include <libgimpwidgets/gimpcolornotebook.h>
#include <libgimpwidgets/gimpcolorprofilechooserdialog.h>
#include <libgimpwidgets/gimpcolorprofilecombobox.h>
#include <libgimpwidgets/gimpcolorprofilestore.h>
#include <libgimpwidgets/gimpcolorprofileview.h>
#include <libgimpwidgets/gimpcolorscale.h>
#include <libgimpwidgets/gimpcolorscales.h>
#include <libgimpwidgets/gimpcolorselector.h>
#include <libgimpwidgets/gimpcolorselect.h>
#include <libgimpwidgets/gimpcolorselection.h>
#include <libgimpwidgets/gimpdialog.h>
#include <libgimpwidgets/gimpenumcombobox.h>
#include <libgimpwidgets/gimpenumlabel.h>
#include <libgimpwidgets/gimpenumstore.h>
#include <libgimpwidgets/gimpenumwidgets.h>
#include <libgimpwidgets/gimpfileentry.h>
#include <libgimpwidgets/gimpframe.h>
#include <libgimpwidgets/gimphelpui.h>
#include <libgimpwidgets/gimphintbox.h>
#include <libgimpwidgets/gimpicons.h>
#include <libgimpwidgets/gimpintcombobox.h>
#include <libgimpwidgets/gimpintstore.h>
#include <libgimpwidgets/gimpmemsizeentry.h>
#include <libgimpwidgets/gimpnumberpairentry.h>
#include <libgimpwidgets/gimpoffsetarea.h>
#include <libgimpwidgets/gimppageselector.h>
#include <libgimpwidgets/gimppatheditor.h>
#include <libgimpwidgets/gimppickbutton.h>
#include <libgimpwidgets/gimppixmap.h>
#include <libgimpwidgets/gimppreview.h>
#include <libgimpwidgets/gimppreviewarea.h>
#include <libgimpwidgets/gimppropwidgets.h>
#include <libgimpwidgets/gimpquerybox.h>
#include <libgimpwidgets/gimpruler.h>
#include <libgimpwidgets/gimpscaleentry.h>
#include <libgimpwidgets/gimpscrolledpreview.h>
#include <libgimpwidgets/gimpsizeentry.h>
#include <libgimpwidgets/gimpspinbutton.h>
#include <libgimpwidgets/gimpstringcombobox.h>
#include <libgimpwidgets/gimpunitcombobox.h>
#include <libgimpwidgets/gimpunitmenu.h>
#include <libgimpwidgets/gimpunitstore.h>
#include <libgimpwidgets/gimpwidgets-error.h>
#include <libgimpwidgets/gimpwidgetsutils.h>
#include <libgimpwidgets/gimpzoommodel.h>
#include <libgimpwidgets/gimp3migration.h>
#include <libgimpwidgets/gimpoldwidgets.h>
#undef __GIMP_WIDGETS_H_INSIDE__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/*
* Widget Constructors
*/
GtkWidget * gimp_int_radio_group_new (gboolean in_frame,
const gchar *frame_title,
GCallback radio_button_callback,
gpointer radio_button_callback_data,
gint initial, /* item_data */
/* specify radio buttons as va_list:
* const gchar *label,
* gint item_data,
* GtkWidget **widget_ptr,
*/
...) G_GNUC_NULL_TERMINATED;
void gimp_int_radio_group_set_active (GtkRadioButton *radio_button,
gint item_data);
GtkWidget * gimp_radio_group_new (gboolean in_frame,
const gchar *frame_title,
/* specify radio buttons as va_list:
* const gchar *label,
* GCallback callback,
* gpointer callback_data,
* gpointer item_data,
* GtkWidget **widget_ptr,
* gboolean active,
*/
...) G_GNUC_NULL_TERMINATED;
GtkWidget * gimp_radio_group_new2 (gboolean in_frame,
const gchar *frame_title,
GCallback radio_button_callback,
gpointer radio_button_callback_data,
gpointer initial, /* item_data */
/* specify radio buttons as va_list:
* const gchar *label,
* gpointer item_data,
* GtkWidget **widget_ptr,
*/
...) G_GNUC_NULL_TERMINATED;
void gimp_radio_group_set_active (GtkRadioButton *radio_button,
gpointer item_data);
GIMP_DEPRECATED_FOR(gtk_spin_button_new)
GtkWidget * gimp_spin_button_new (/* return value: */
GtkObject **adjustment,
gdouble value,
gdouble lower,
gdouble upper,
gdouble step_increment,
gdouble page_increment,
gdouble page_size,
gdouble climb_rate,
guint digits);
/**
* GIMP_RANDOM_SEED_SPINBUTTON:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
* Returns: the random_seed's #GtkSpinButton.
**/
#define GIMP_RANDOM_SEED_SPINBUTTON(hbox) \
(g_object_get_data (G_OBJECT (hbox), "spinbutton"))
/**
* GIMP_RANDOM_SEED_SPINBUTTON_ADJ:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
* Returns: the #GtkAdjustment of the random_seed's #GtkSpinButton.
**/
#define GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox) \
gtk_spin_button_get_adjustment \
(GTK_SPIN_BUTTON (g_object_get_data (G_OBJECT (hbox), "spinbutton")))
/**
* GIMP_RANDOM_SEED_TOGGLE:
* @hbox: The #GtkHBox returned by gimp_random_seed_new().
*
* Returns: the random_seed's #GtkToggleButton.
**/
#define GIMP_RANDOM_SEED_TOGGLE(hbox) \
(g_object_get_data (G_OBJECT(hbox), "toggle"))
GtkWidget * gimp_random_seed_new (guint32 *seed,
gboolean *random_seed);
/**
* GIMP_COORDINATES_CHAINBUTTON:
* @sizeentry: The #GimpSizeEntry returned by gimp_coordinates_new().
*
* Returns: the #GimpChainButton which is attached to the
* #GimpSizeEntry.
**/
#define GIMP_COORDINATES_CHAINBUTTON(sizeentry) \
(g_object_get_data (G_OBJECT (sizeentry), "chainbutton"))
GtkWidget * gimp_coordinates_new (GimpUnit unit,
const gchar *unit_format,
gboolean menu_show_pixels,
gboolean menu_show_percent,
gint spinbutton_width,
GimpSizeEntryUpdatePolicy update_policy,
gboolean chainbutton_active,
gboolean chain_constrains_ratio,
const gchar *xlabel,
gdouble x,
gdouble xres,
gdouble lower_boundary_x,
gdouble upper_boundary_x,
gdouble xsize_0, /* % */
gdouble xsize_100, /* % */
const gchar *ylabel,
gdouble y,
gdouble yres,
gdouble lower_boundary_y,
gdouble upper_boundary_y,
gdouble ysize_0, /* % */
gdouble ysize_100 /* % */);
/*
* Standard Callbacks
*/
void gimp_toggle_button_update (GtkWidget *widget,
gpointer data);
void gimp_radio_button_update (GtkWidget *widget,
gpointer data);
void gimp_int_adjustment_update (GtkAdjustment *adjustment,
gpointer data);
void gimp_uint_adjustment_update (GtkAdjustment *adjustment,
gpointer data);
void gimp_float_adjustment_update (GtkAdjustment *adjustment,
gpointer data);
void gimp_double_adjustment_update (GtkAdjustment *adjustment,
gpointer data);
G_END_DECLS
#endif /* __GIMP_WIDGETS_H__ */