Gimp/app/core/gimpdata.h
Jehan d931098d36 app, libgimp, pdb: new gimp_image_get_palette().
This is meant to replace gimp_image_get_colormap() (see also #9477).

We likely won't need a gimp_image_set_palette() because we can simply edit the
image's colormap/palette with GimpPalette API now and it is directly updated.

For instance, the following code changes the first entry in the image palette to
red, immediately:

```python
i = Gimp.list_images()[0]
p = i.get_palette()
c = Gimp.RGB()
c.r = 1.0
p.entry_set_color(0, c)
```

For this to work fine, I added a new concept to GimpData, which is that they can
be tied to a GimpImage (instead of a GFile). Image palettes are not considered
internals, they are just tied to their image, therefore they can be edited by
scripts/plug-ins.

Additionally with this commit, editing an image's colormap from libgimp API also
generates undo steps now.
2023-10-06 22:04:34 +02:00

149 lines
5.9 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpdata.h
* Copyright (C) 2001 Michael Natterer <mitch@gimp.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef __GIMP_DATA_H__
#define __GIMP_DATA_H__
#include "gimpresource.h"
typedef enum
{
GIMP_DATA_ERROR_OPEN, /* opening data file failed */
GIMP_DATA_ERROR_READ, /* reading data file failed */
GIMP_DATA_ERROR_WRITE, /* writing data file failed */
GIMP_DATA_ERROR_DELETE /* deleting data file failed */
} GimpDataError;
#define GIMP_TYPE_DATA (gimp_data_get_type ())
#define GIMP_DATA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_DATA, GimpData))
#define GIMP_DATA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_DATA, GimpDataClass))
#define GIMP_IS_DATA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_DATA))
#define GIMP_IS_DATA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_DATA))
#define GIMP_DATA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_DATA, GimpDataClass))
typedef struct _GimpDataPrivate GimpDataPrivate;
typedef struct _GimpDataClass GimpDataClass;
struct _GimpData
{
GimpResource parent_instance;
GimpDataPrivate *priv;
};
struct _GimpDataClass
{
GimpResourceClass parent_class;
/* signals */
void (* dirty) (GimpData *data);
/* virtual functions */
gboolean (* save) (GimpData *data,
GOutputStream *output,
GError **error);
const gchar * (* get_extension) (GimpData *data);
void (* copy) (GimpData *data,
GimpData *src_data);
GimpData * (* duplicate) (GimpData *data);
gint (* compare) (GimpData *data1,
GimpData *data2);
};
GType gimp_data_get_type (void) G_GNUC_CONST;
gint gimp_data_get_id (GimpData *data);
GimpData * gimp_data_get_by_id (gint id);
gboolean gimp_data_save (GimpData *data,
GError **error);
void gimp_data_dirty (GimpData *data);
void gimp_data_clean (GimpData *data);
gboolean gimp_data_is_dirty (GimpData *data);
void gimp_data_freeze (GimpData *data);
void gimp_data_thaw (GimpData *data);
gboolean gimp_data_is_frozen (GimpData *data);
gboolean gimp_data_delete_from_disk (GimpData *data,
GError **error);
const gchar * gimp_data_get_extension (GimpData *data);
void gimp_data_set_file (GimpData *data,
GFile *file,
gboolean writable,
gboolean deletable);
GFile * gimp_data_get_file (GimpData *data);
void gimp_data_set_image (GimpData *data,
GimpImage *image,
gboolean writable,
gboolean deletable);
GimpImage * gimp_data_get_image (GimpData *data);
void gimp_data_create_filename (GimpData *data,
GFile *dest_dir);
void gimp_data_set_folder_tags (GimpData *data,
GFile *top_directory);
const gchar * gimp_data_get_mime_type (GimpData *data);
gboolean gimp_data_is_writable (GimpData *data);
gboolean gimp_data_is_deletable (GimpData *data);
void gimp_data_set_mtime (GimpData *data,
gint64 mtime);
gint64 gimp_data_get_mtime (GimpData *data);
gboolean gimp_data_is_copyable (GimpData *data);
void gimp_data_copy (GimpData *data,
GimpData *src_data);
gboolean gimp_data_is_duplicatable (GimpData *data);
GimpData * gimp_data_duplicate (GimpData *data);
void gimp_data_make_internal (GimpData *data,
const gchar *collection);
gboolean gimp_data_is_internal (GimpData *data);
gint gimp_data_compare (GimpData *data1,
GimpData *data2);
gboolean gimp_data_identify (GimpData *data,
const gchar *name,
const gchar *collection_id,
gboolean is_internal);
void gimp_data_get_identifiers (GimpData *data,
gchar **name,
gchar **collection_id,
gboolean *is_internal);
#define GIMP_DATA_ERROR (gimp_data_error_quark ())
GQuark gimp_data_error_quark (void) G_GNUC_CONST;
#endif /* __GIMP_DATA_H__ */