2010-10-15 04:15:25 +08:00
|
|
|
/* LIBGIMP - The GIMP Library
|
|
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
2004-05-08 06:16:15 +08:00
|
|
|
*
|
|
|
|
* gimpunitstore.h
|
|
|
|
* Copyright (C) 2004 Sven Neumann <sven@gimp.org>
|
|
|
|
*
|
2010-10-15 04:15:25 +08:00
|
|
|
* 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.
|
2004-05-08 06:16:15 +08:00
|
|
|
*
|
2010-10-15 04:15:25 +08:00
|
|
|
* This library is distributed in the hope that it will be useful,
|
2004-05-08 06:16:15 +08:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2010-10-15 04:15:25 +08:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
2004-05-08 06:16:15 +08:00
|
|
|
*
|
2010-10-15 04:15:25 +08:00
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library. If not, see
|
2018-07-12 05:27:07 +08:00
|
|
|
* <https://www.gnu.org/licenses/>.
|
2004-05-08 06:16:15 +08:00
|
|
|
*/
|
|
|
|
|
2011-04-28 20:30:41 +08:00
|
|
|
#if !defined (__GIMP_WIDGETS_H_INSIDE__) && !defined (GIMP_WIDGETS_COMPILATION)
|
|
|
|
#error "Only <libgimpwidgets/gimpwidgets.h> can be included directly."
|
|
|
|
#endif
|
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
#ifndef __GIMP_UNIT_STORE_H__
|
|
|
|
#define __GIMP_UNIT_STORE_H__
|
|
|
|
|
2011-04-28 20:30:41 +08:00
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
|
|
|
|
enum
|
|
|
|
{
|
|
|
|
GIMP_UNIT_STORE_UNIT,
|
|
|
|
GIMP_UNIT_STORE_UNIT_FACTOR,
|
|
|
|
GIMP_UNIT_STORE_UNIT_DIGITS,
|
Issue #434: remove broken plural support for GimpUnit.
Rather than trying to implement full i18n plural support, we just remove
this failed attempt from the past. The fact is that to get proper
support, we'd basically need to reimplement a Gettext-like plural
definition syntax within our API, then ask people to write down this
plural definition for their language, then to write every plural form…
all this for custom units which only them will ever see!
Moreover code investigation shows that the singular form was simply
never used, and the plural form was always used (whatever the actual
unit value displayed).
As for the "identifier", this was a text which was never shown anywhere
(except in the unit editor) and for all built-in units, as well as
default unitrc units, it was equivalent to the English plural value.
So we now just have a unique name which is the "long label" to be used
everywhere in the GUI, and abbreviation will be basically the "short
label". That's it. No useless (or worse, not actually usable because it
was not generic internationalization) values anymore!
2024-08-05 22:02:47 +08:00
|
|
|
GIMP_UNIT_STORE_UNIT_NAME,
|
2004-05-08 06:16:15 +08:00
|
|
|
GIMP_UNIT_STORE_UNIT_SYMBOL,
|
|
|
|
GIMP_UNIT_STORE_UNIT_ABBREVIATION,
|
2010-11-05 23:26:58 +08:00
|
|
|
GIMP_UNIT_STORE_UNIT_SHORT_FORMAT,
|
|
|
|
GIMP_UNIT_STORE_UNIT_LONG_FORMAT,
|
2004-05-08 06:16:15 +08:00
|
|
|
GIMP_UNIT_STORE_UNIT_COLUMNS,
|
|
|
|
GIMP_UNIT_STORE_FIRST_VALUE = GIMP_UNIT_STORE_UNIT_COLUMNS
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2024-08-03 10:48:07 +08:00
|
|
|
#define GIMP_TYPE_UNIT_STORE (gimp_unit_store_get_type ())
|
|
|
|
G_DECLARE_DERIVABLE_TYPE (GimpUnitStore, gimp_unit_store, GIMP, UNIT_STORE, GObject)
|
2010-11-01 05:15:52 +08:00
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
struct _GimpUnitStoreClass
|
|
|
|
{
|
|
|
|
GObjectClass parent_class;
|
2010-10-15 04:15:25 +08:00
|
|
|
|
|
|
|
/* Padding for future expansion */
|
2018-05-03 18:51:36 +08:00
|
|
|
void (*_gimp_reserved1) (void);
|
|
|
|
void (*_gimp_reserved2) (void);
|
|
|
|
void (*_gimp_reserved3) (void);
|
|
|
|
void (*_gimp_reserved4) (void);
|
|
|
|
void (*_gimp_reserved5) (void);
|
|
|
|
void (*_gimp_reserved6) (void);
|
|
|
|
void (*_gimp_reserved7) (void);
|
|
|
|
void (*_gimp_reserved8) (void);
|
2004-05-08 06:16:15 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
GimpUnitStore * gimp_unit_store_new (gint num_values);
|
|
|
|
|
2010-10-15 06:15:48 +08:00
|
|
|
void gimp_unit_store_set_has_pixels (GimpUnitStore *store,
|
|
|
|
gboolean has_pixels);
|
|
|
|
gboolean gimp_unit_store_get_has_pixels (GimpUnitStore *store);
|
|
|
|
|
2010-10-15 07:27:02 +08:00
|
|
|
void gimp_unit_store_set_has_percent (GimpUnitStore *store,
|
|
|
|
gboolean has_percent);
|
|
|
|
gboolean gimp_unit_store_get_has_percent (GimpUnitStore *store);
|
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
void gimp_unit_store_set_pixel_value (GimpUnitStore *store,
|
|
|
|
gint index,
|
|
|
|
gdouble value);
|
|
|
|
void gimp_unit_store_set_pixel_values (GimpUnitStore *store,
|
|
|
|
gdouble first_value,
|
|
|
|
...);
|
|
|
|
void gimp_unit_store_set_resolution (GimpUnitStore *store,
|
|
|
|
gint index,
|
|
|
|
gdouble resolution);
|
|
|
|
void gimp_unit_store_set_resolutions (GimpUnitStore *store,
|
|
|
|
gdouble first_resolution,
|
|
|
|
...);
|
2019-08-21 00:21:45 +08:00
|
|
|
gdouble gimp_unit_store_get_nth_value (GimpUnitStore *store,
|
Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!
Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.
As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.
Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.
Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-07-26 02:55:21 +08:00
|
|
|
GimpUnit *unit,
|
2004-05-08 06:16:15 +08:00
|
|
|
gint index);
|
|
|
|
void gimp_unit_store_get_values (GimpUnitStore *store,
|
Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!
Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.
As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.
Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.
Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-07-26 02:55:21 +08:00
|
|
|
GimpUnit *unit,
|
2004-05-08 06:16:15 +08:00
|
|
|
gdouble *first_value,
|
|
|
|
...);
|
|
|
|
|
2014-03-10 07:12:31 +08:00
|
|
|
void _gimp_unit_store_sync_units (GimpUnitStore *store);
|
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
|
2011-04-28 20:30:41 +08:00
|
|
|
G_END_DECLS
|
|
|
|
|
2004-05-08 06:16:15 +08:00
|
|
|
#endif /* __GIMP_UNIT_STORE_H__ */
|