dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/libgimp/gimpfileprocedure.h

93 lines
4.0 KiB
C
Raw Normal View History

libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpfileprocedure.h
* Copyright (C) 2019 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_FILE_PROCEDURE_H__
#define __GIMP_FILE_PROCEDURE_H__
#include <libgimp/gimpprocedure.h>
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
#define GIMP_TYPE_FILE_PROCEDURE (gimp_file_procedure_get_type ())
#define GIMP_FILE_PROCEDURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_FILE_PROCEDURE, GimpFileProcedure))
#define GIMP_FILE_PROCEDURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_FILE_PROCEDURE, GimpFileProcedureClass))
#define GIMP_IS_FILE_PROCEDURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_FILE_PROCEDURE))
#define GIMP_IS_FILE_PROCEDURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_FILE_PROCEDURE))
#define GIMP_FILE_PROCEDURE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_FILE_PROCEDURE, GimpFileProcedureClass))
typedef struct _GimpFileProcedure GimpFileProcedure;
typedef struct _GimpFileProcedureClass GimpFileProcedureClass;
typedef struct _GimpFileProcedurePrivate GimpFileProcedurePrivate;
struct _GimpFileProcedure
{
GimpProcedure parent_instance;
GimpFileProcedurePrivate *priv;
};
struct _GimpFileProcedureClass
{
GimpProcedureClass parent_class;
};
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
GType gimp_file_procedure_get_type (void) G_GNUC_CONST;
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
libgimp, plug-ins: add a "format name" concept to GimpFileProcedure. This format name is a public facing name for a file format, such as "PNG", "JPEG", or "C-source". Since it is public facing, the function recommends to localize it too. This is an optional name, yet is made mandatory if you want to use GimpSaveProcedureDialog because it will be used for the dialog title (ensuring that all support format have a similar export dialog title). Following this change, gimp_save_procedure_dialog_new() does not ask for a title anymore (if anyone absolutely wants to set a custom title, setting the "title" property on the dialog is always possible anyway, but a generic and consistent title should be set as a default). Also updating the 3 plug-ins which were already using the now-changed API.
2020-12-17 09:02:14 +08:00
void gimp_file_procedure_set_format_name (GimpFileProcedure *procedure,
const gchar *format_name);
const gchar * gimp_file_procedure_get_format_name (GimpFileProcedure *procedure);
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
void gimp_file_procedure_set_mime_types (GimpFileProcedure *procedure,
const gchar *mime_types);
const gchar * gimp_file_procedure_get_mime_types (GimpFileProcedure *procedure);
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
void gimp_file_procedure_set_extensions (GimpFileProcedure *procedure,
const gchar *extensions);
const gchar * gimp_file_procedure_get_extensions (GimpFileProcedure *procedure);
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
void gimp_file_procedure_set_prefixes (GimpFileProcedure *procedure,
const gchar *prefixes);
const gchar * gimp_file_procedure_get_prefixes (GimpFileProcedure *procedure);
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
void gimp_file_procedure_set_magics (GimpFileProcedure *procedure,
const gchar *magics);
const gchar * gimp_file_procedure_get_magics (GimpFileProcedure *procedure);
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
libgimp: add gimp_file_procedure_set_handles_uri() Implementing a shiny new GimpFileProcedure doesn't mean the libraries we use to load/save files are automatically capable of handling remote files, so we still need this flag.
2019-08-11 18:46:48 +08:00
void gimp_file_procedure_set_priority (GimpFileProcedure *procedure,
gint priority);
gint gimp_file_procedure_get_priority (GimpFileProcedure *procedure);
Change the "handles uri" flag of file procedures to "handle remote" And always pass URIs to all file procedures, the ones what didn't register as "handles remove" will only ever get local file:// URIs. Change all file plug-ins (also legacy ones) to expect URIs instead of filenames, and convert to local paths in the plug-in. The wire protocol should now be almost 100% clean of non-UTF-8 strings.
2019-08-19 18:05:12 +08:00
void gimp_file_procedure_set_handles_remote
(GimpFileProcedure *procedure,
gboolean handles_remote);
gboolean gimp_file_procedure_get_handles_remote
(GimpFileProcedure *procedure);
libgimp: add GimpFileProcedure, GimpLoadProcedure and GimpSaveProcedure which are GimpProcedure subclasses with API to register as load/save handlers and their own kind of run functions that get their standard arguments passed directly instead of packed into a GimpValueArray. They also register their standard arguments themselves, which removes quite some boilerplate from load/save plug-ins. Remove gimpprocedure-private.[ch] because install() and uninstall() are now virtual functions of GimpProcedure.
2019-08-11 02:25:37 +08:00
G_END_DECLS
#endif /* __GIMP_FILE_PROCEDURE_H__ */