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

184 lines
11 KiB
C
Raw Normal View History

libgimp: add GimpProcedureDialog, the new dialog class for plug-ins It knows about the procedure and its config, and so far implements the entire construction boilerplate and "Reset" on its own.
2019-09-21 01:24:40 +08:00
/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpproceduredialog.h
* Copyright (C) 2019 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/>.
*/
#if !defined (__GIMP_UI_H_INSIDE__) && !defined (GIMP_COMPILATION)
#error "Only <libgimp/gimpui.h> can be included directly."
#endif
#ifndef __GIMP_PROCEDURE_DIALOG_H__
#define __GIMP_PROCEDURE_DIALOG_H__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
libgimp, libgimpwidgets: use G_DECLARE_(DERIVABLE|FINAL)_TYPE macros for GimpProcedureDialog… … and its subclasses, as well as for GimpDialog.
2024-07-13 17:36:05 +08:00
#define GIMP_TYPE_PROCEDURE_DIALOG (gimp_procedure_dialog_get_type ())
G_DECLARE_DERIVABLE_TYPE (GimpProcedureDialog, gimp_procedure_dialog, GIMP, PROCEDURE_DIALOG, GimpDialog)
libgimp: add GimpProcedureDialog, the new dialog class for plug-ins It knows about the procedure and its config, and so far implements the entire construction boilerplate and "Reset" on its own.
2019-09-21 01:24:40 +08:00
struct _GimpProcedureDialogClass
{
GimpDialogClass parent_class;
libgimp: new fill_start() and fill_end() class method for GimpProcedureDialog. Instead of filling default GUI for a specific type of plug-in procedure in fill_list(), we add 2 methods: * fill_start() is ensured to run once (and only once) before any fill_list() code runs. * fill_end() is ensured to run once (and only once) after all fill_list() ran. This takes care of 2 kind of GUI bugs which we could have: 1. First if no explicit fill were run (i.e. neither gimp_procedure_dialog_fill() nor gimp_procedure_dialog_fill_list() were ever run), then the default interface would not be added to the dialog. Yet this case could happen when we don't want anything else but the default GUI (this will be the case in the upcoming file-wmf-load GUI). 2. Second if at the opposite, you fill several times fill functions (I hadn't thought of this, but noticed some already started to do this in our ported plug-ins), we obviously don't want the default GUI to be added several times either.
2024-04-24 20:00:54 +08:00
void (* fill_start) (GimpProcedureDialog *dialog,
GimpProcedure *procedure,
GimpProcedureConfig *config);
void (* fill_end) (GimpProcedureDialog *dialog,
GimpProcedure *procedure,
GimpProcedureConfig *config);
void (* fill_list) (GimpProcedureDialog *dialog,
GimpProcedure *procedure,
GimpProcedureConfig *config,
GList *properties);
libgimp: new metadata support concept in GimpSaveProcedure and new… … class GimpSaveProcedureDialog. The idea is that we have basically the same code in most file format plug-ins to handle various generic metadata, yet usually with slight differences here and there. Even behavior is sometimes a bit different even though there is no reason for the logics to be different from one format to another. So I move the metadata support logics into GimpSaveProcedure (and GimpProcedureConfig still keeps the main export logics). The GUI logics is now in a new GimpSaveProcedureDialog. So export plug-ins will now get the creation of generic metadata nearly for free. All they have to do is to tell what kind of metadata the GimpSaveProcedure supports with the gimp_save_procedure_set_support_*() functions. Then consistency will apply: - If a format supports a given metadata, they will always have an auxiliary argument with the same name across plug-ins. - The label and tooltips will also be always the same in the GUI. - Order of metadata widgets will also stay consistent. - The widgets will work the same (no more "Comment" text view missing in one plug-in but present in another, or with an entry here, and a text view there, and so on). Also adding gimp_save_procedure_dialog_add_metadata() to allow plug-ins to "declare" one of their options as a metadata option, and therefore have it packed within the "Metadata" block which is now created (for instance for PNG/TIFF/JPEG specific metadata). This allows a nicer organization of dialogs.
2020-11-21 08:15:15 +08:00
libgimp: add GimpProcedureDialog, the new dialog class for plug-ins It knows about the procedure and its config, and so far implements the entire construction boilerplate and "Reset" on its own.
2019-09-21 01:24:40 +08:00
/* Padding for future expansion */
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);
};
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
GtkWidget * gimp_procedure_dialog_new (GimpProcedure *procedure,
GimpProcedureConfig *config,
const gchar *title);
libgimp: new gimp_procedure_dialog_set_ok_label() function. This allows to set a custom label for the OK button.
2023-06-15 09:56:00 +08:00
void gimp_procedure_dialog_set_ok_label (GimpProcedureDialog *dialog,
const gchar *ok_label);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
GtkWidget * gimp_procedure_dialog_get_widget (GimpProcedureDialog *dialog,
const gchar *property,
GType widget_type);
libgimp, libgimpwidgets: support of GimpRGB properties in… … GimpProcedureDialog. Technically I added: - New gimp_prop_color_select_new() property widget to create a GimpColorButton for a given GimpRGB property. - gimp_procedure_dialog_get_widget() now supports a GimpRGB property and will create a GimpColorArea by default. - When the default doesn't suit you, a new function gimp_procedure_dialog_get_color_widget() allows to create either a GimpColorArea or a GimpColorButton (editable = TRUE), as well as choose the area type (small or large checks, as well as flat area, i.e. no alpha support).
2021-04-20 22:40:18 +08:00
GtkWidget * gimp_procedure_dialog_get_color_widget (GimpProcedureDialog *dialog,
const gchar *property,
gboolean editable,
GimpColorAreaType type);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
GtkWidget * gimp_procedure_dialog_get_int_combo (GimpProcedureDialog *dialog,
const gchar *property,
GimpIntStore *store);
libgimp: new gimp_procedure_dialog_get_int_radio(). This allows to create a GimpIntRadioFrame from an int property.
2022-06-11 05:12:55 +08:00
GtkWidget * gimp_procedure_dialog_get_int_radio (GimpProcedureDialog *dialog,
const gchar *property,
GimpIntStore *store);
libgimp: new gimp_procedure_dialog_get_spin_scale() and support of… … %GIMP_TYPE_SPIN_SCALE in gimp_procedure_dialog_get_widget(). The dedicated function is for when a plug-in wants to use a scale range multiplied by a factor. Otherwise using the generic function is fine.
2022-02-19 08:22:48 +08:00
GtkWidget * gimp_procedure_dialog_get_spin_scale (GimpProcedureDialog *dialog,
const gchar *property,
gdouble factor);
libgimp: new gimp_procedure_dialog_get_scale_entry() function. Though a GimpScaleEntry could already be created with gimp_procedure_dialog_get_widget(), this specific function allows to add a factor to the property range.
2020-11-25 19:25:59 +08:00
GtkWidget * gimp_procedure_dialog_get_scale_entry (GimpProcedureDialog *dialog,
const gchar *property,
gdouble factor);
libgimp: new gimp_procedure_get_size_entry () This allows plug-in developers to create GimpSizeEntry widgets with the procedure dialog API.
2023-04-06 11:35:19 +08:00
GtkWidget * gimp_procedure_dialog_get_size_entry (GimpProcedureDialog *dialog,
const gchar *property,
gboolean property_is_pixel,
const gchar *unit_property,
const gchar *unit_format,
GimpSizeEntryUpdatePolicy
update_policy,
gdouble resolution);
libgimp: some more functions to GimpProcedureDialog. gimp_procedure_dialog_fill_frame() allows creating a GtkFrame, in particular with a boolean widget which can therefore control sensitivity of the frame contents. gimp_procedure_dialog_get_label() creates a simple text label.
2020-11-14 07:21:46 +08:00
GtkWidget * gimp_procedure_dialog_get_label (GimpProcedureDialog *dialog,
const gchar *label_id,
libgimp, plug-ins: enhance gimp_procedure_dialog_get_label() with markup and… … mnemonic abilities.
2023-07-18 06:06:26 +08:00
const gchar *text,
gboolean is_markup,
gboolean with_mnemonic);
libgimp, libgimpwidgets: supporting GFile properties in… … GimpProcedureDialog. - gimp_prop_file_chooser_button_new() now works also with properties G_PARAM_SPEC_OBJECT having a value_type == G_TYPE_FILE (additionally to GIMP_PARAM_SPEC_CONFIG_PATH properties). - gimp_procedure_dialog_get_widget() will now create a GtkFileChooserButton in open mode for such a GFile property. - New gimp_procedure_dialog_get_file_chooser() API to create GtkFileChooserButton for GFile properties in other modes. Current limitation: GtkFileChooserButton doesn't have a label. This should be fixed, probably by creating another custom widget with would be a labelized file chooser button.
2022-06-17 21:08:16 +08:00
GtkWidget * gimp_procedure_dialog_get_file_chooser (GimpProcedureDialog *dialog,
const gchar *property,
GtkFileChooserAction action);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
libgimp: new gimp_procedure_dialog_get_preview_from_drawable() function. This allows plug-in developers to create GimpPreviewDrawable widgets with the procedure dialog API.
2024-02-03 20:03:32 +08:00
GtkWidget * gimp_procedure_dialog_get_drawable_preview
(GimpProcedureDialog *dialog,
const gchar *preview_id,
GimpDrawable *drawable);
libgimp: improvements to GimpProcedureDialog API. - New gimp_procedure_dialog_fill_box(_list)() functions to create a GtkBox in the layout. - Generating widgets for parameters of type double (and computing appropriate "ok defaults" digits for these, depending on the min-max range of the property).
2020-11-24 22:00:34 +08:00
GtkWidget * gimp_procedure_dialog_fill_box (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *first_property,
libgimp: Add compiler hints to gimpproceduredialog Add `G_GNUC_NULL_TERMINATED` to help the compiler point out if someone forgets to add a `NULL` at the end of their varargs when calling this function.
2021-01-08 21:31:15 +08:00
...) G_GNUC_NULL_TERMINATED;
libgimp: improvements to GimpProcedureDialog API. - New gimp_procedure_dialog_fill_box(_list)() functions to create a GtkBox in the layout. - Generating widgets for parameters of type double (and computing appropriate "ok defaults" digits for these, depending on the min-max range of the property).
2020-11-24 22:00:34 +08:00
GtkWidget * gimp_procedure_dialog_fill_box_list (GimpProcedureDialog *dialog,
const gchar *container_id,
GList *properties);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
GtkWidget * gimp_procedure_dialog_fill_flowbox (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *first_property,
libgimp: Add compiler hints to gimpproceduredialog Add `G_GNUC_NULL_TERMINATED` to help the compiler point out if someone forgets to add a `NULL` at the end of their varargs when calling this function.
2021-01-08 21:31:15 +08:00
...) G_GNUC_NULL_TERMINATED;
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
GtkWidget * gimp_procedure_dialog_fill_flowbox_list (GimpProcedureDialog *dialog,
const gchar *container_id,
GList *properties);
libgimp: some more functions to GimpProcedureDialog. gimp_procedure_dialog_fill_frame() allows creating a GtkFrame, in particular with a boolean widget which can therefore control sensitivity of the frame contents. gimp_procedure_dialog_get_label() creates a simple text label.
2020-11-14 07:21:46 +08:00
GtkWidget * gimp_procedure_dialog_fill_frame (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *title_id,
gboolean invert_title,
const gchar *contents_id);
plug-in, libgimp: Fixes #6753: redesign of WebP Export dialog Added an option for exporting thumbnail in WebP Export dialogbox. Additionally, introduced a function gimp_procedure_dialog_fill_expander. The function is similar to gimp_procedure_dialog_fill_frame but allows adding GtkExpander instead of GtkFrame.
2021-06-18 01:38:56 +08:00
GtkWidget * gimp_procedure_dialog_fill_expander (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *title_id,
gboolean invert_title,
const gchar *contents_id);
libgimp: some more functions to GimpProcedureDialog. gimp_procedure_dialog_fill_frame() allows creating a GtkFrame, in particular with a boolean widget which can therefore control sensitivity of the frame contents. gimp_procedure_dialog_get_label() creates a simple text label.
2020-11-14 07:21:46 +08:00
libgimp: new gimp_procedure_dialog_fill_scrolled_window() This allows plug-in developers to create GTKScrolledWindow with the procedure dialog API.
2023-03-31 21:55:59 +08:00
GtkWidget * gimp_procedure_dialog_fill_scrolled_window
libgimp: new gimp_procedure_dialog_fill_notebook*() functions.
2023-07-18 05:37:50 +08:00
(GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *contents_id);
GtkWidget * gimp_procedure_dialog_fill_notebook (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *label_id,
const gchar *page_id,
...) G_GNUC_NULL_TERMINATED;
GtkWidget * gimp_procedure_dialog_fill_notebook_list
(GimpProcedureDialog *dialog,
const gchar *container_id,
GList *label_list,
GList *page_list);
libgimp: new gimp_procedure_dialog_fill_scrolled_window() This allows plug-in developers to create GTKScrolledWindow with the procedure dialog API.
2023-03-31 21:55:59 +08:00
libgimp: new gimp_procedure_dialog_fill_paned() function.
2023-07-18 05:40:04 +08:00
GtkWidget * gimp_procedure_dialog_fill_paned (GimpProcedureDialog *dialog,
const gchar *container_id,
GtkOrientation orientation,
const gchar *child1_id,
const gchar *child2_id);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
void gimp_procedure_dialog_fill (GimpProcedureDialog *dialog,
libgimp: Add compiler hints to gimpproceduredialog Add `G_GNUC_NULL_TERMINATED` to help the compiler point out if someone forgets to add a `NULL` at the end of their varargs when calling this function.
2021-01-08 21:31:15 +08:00
...) G_GNUC_NULL_TERMINATED;
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
void gimp_procedure_dialog_fill_list (GimpProcedureDialog *dialog,
GList *properties);
libgimp: new gimp_procedure_dialog_set_sensitive(). New function to set some procedure dialog's widget sensitive, either with a constant value, or by binding it to a boolean property (or its inverse) of a config object.
2021-04-07 02:10:46 +08:00
void gimp_procedure_dialog_set_sensitive (GimpProcedureDialog *dialog,
const gchar *property,
gboolean sensitive,
GObject *config,
const gchar *config_property,
gboolean config_invert);
libgimp: new function gimp_procedure_dialog_set_sensitive_if_in(). This function allows to change the sensitivity of a widget depending on the value of another property. We already had gimp_procedure_dialog_set_sensitive() except it was only syncing with a boolean property, whereas the new function can compare with any property type.
2023-06-15 09:31:42 +08:00
void gimp_procedure_dialog_set_sensitive_if_in (GimpProcedureDialog *dialog,
const gchar *property,
GObject *config,
const gchar *config_property,
GimpValueArray *values,
gboolean in_values);
libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API. - New GimpLabelIntWidget which is a label associated to any widget with an integer "value" property. - New gimp_procedure_dialog_get_int_combo() which creates a labeled combo box from an integer property of the GimpProcedureConfig. - Renamed gimp_procedure_dialog_populate*() with gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using _pack() as well (similarly to GtkBox API). - New gimp_procedure_dialog_fill_flowbox*() functions to create a GtkFlowBox filled with property widgets (or other container widgets as we can pack them one in another). This is an alternative way to build your GUI with sane defaults, with list of property names.
2020-11-14 04:26:14 +08:00
gboolean gimp_procedure_dialog_run (GimpProcedureDialog *dialog);
libgimp: add GimpProcedureDialog, the new dialog class for plug-ins It knows about the procedure and its config, and so far implements the entire construction boilerplate and "Reset" on its own.
2019-09-21 01:24:40 +08:00
G_END_DECLS
#endif /* __GIMP_PROCEDURE_DIALOG_H__ */