gimp/libgimp/gimpproceduredialog.h
Jehan 5f4464445f libgimp*: keep 10 reserved spots for future virtual functions in every derivable class.
Hopefully this should be enough to add new features in the future
without breaking ABI, at least until GIMP 4!
2024-11-01 17:22:07 +01:00

185 lines
11 KiB
C

/* 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 */
#define GIMP_TYPE_PROCEDURE_DIALOG (gimp_procedure_dialog_get_type ())
G_DECLARE_DERIVABLE_TYPE (GimpProcedureDialog, gimp_procedure_dialog, GIMP, PROCEDURE_DIALOG, GimpDialog)
struct _GimpProcedureDialogClass
{
GimpDialogClass parent_class;
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);
/* Padding for future expansion */
void (*_gimp_reserved0) (void);
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);
void (*_gimp_reserved9) (void);
};
GtkWidget * gimp_procedure_dialog_new (GimpProcedure *procedure,
GimpProcedureConfig *config,
const gchar *title);
void gimp_procedure_dialog_set_ok_label (GimpProcedureDialog *dialog,
const gchar *ok_label);
GtkWidget * gimp_procedure_dialog_get_widget (GimpProcedureDialog *dialog,
const gchar *property,
GType widget_type);
GtkWidget * gimp_procedure_dialog_get_color_widget (GimpProcedureDialog *dialog,
const gchar *property,
gboolean editable,
GimpColorAreaType type);
GtkWidget * gimp_procedure_dialog_get_int_combo (GimpProcedureDialog *dialog,
const gchar *property,
GimpIntStore *store);
GtkWidget * gimp_procedure_dialog_get_int_radio (GimpProcedureDialog *dialog,
const gchar *property,
GimpIntStore *store);
GtkWidget * gimp_procedure_dialog_get_spin_scale (GimpProcedureDialog *dialog,
const gchar *property,
gdouble factor);
GtkWidget * gimp_procedure_dialog_get_scale_entry (GimpProcedureDialog *dialog,
const gchar *property,
gdouble factor);
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);
GtkWidget * gimp_procedure_dialog_get_label (GimpProcedureDialog *dialog,
const gchar *label_id,
const gchar *text,
gboolean is_markup,
gboolean with_mnemonic);
GtkWidget * gimp_procedure_dialog_get_file_chooser (GimpProcedureDialog *dialog,
const gchar *property,
GtkFileChooserAction action);
GtkWidget * gimp_procedure_dialog_get_drawable_preview
(GimpProcedureDialog *dialog,
const gchar *preview_id,
GimpDrawable *drawable);
GtkWidget * gimp_procedure_dialog_fill_box (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *first_property,
...) G_GNUC_NULL_TERMINATED;
GtkWidget * gimp_procedure_dialog_fill_box_list (GimpProcedureDialog *dialog,
const gchar *container_id,
GList *properties);
GtkWidget * gimp_procedure_dialog_fill_flowbox (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *first_property,
...) G_GNUC_NULL_TERMINATED;
GtkWidget * gimp_procedure_dialog_fill_flowbox_list (GimpProcedureDialog *dialog,
const gchar *container_id,
GList *properties);
GtkWidget * gimp_procedure_dialog_fill_frame (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *title_id,
gboolean invert_title,
const gchar *contents_id);
GtkWidget * gimp_procedure_dialog_fill_expander (GimpProcedureDialog *dialog,
const gchar *container_id,
const gchar *title_id,
gboolean invert_title,
const gchar *contents_id);
GtkWidget * gimp_procedure_dialog_fill_scrolled_window
(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);
GtkWidget * gimp_procedure_dialog_fill_paned (GimpProcedureDialog *dialog,
const gchar *container_id,
GtkOrientation orientation,
const gchar *child1_id,
const gchar *child2_id);
void gimp_procedure_dialog_fill (GimpProcedureDialog *dialog,
...) G_GNUC_NULL_TERMINATED;
void gimp_procedure_dialog_fill_list (GimpProcedureDialog *dialog,
GList *properties);
void gimp_procedure_dialog_set_sensitive (GimpProcedureDialog *dialog,
const gchar *property,
gboolean sensitive,
GObject *config,
const gchar *config_property,
gboolean config_invert);
void gimp_procedure_dialog_set_sensitive_if_in (GimpProcedureDialog *dialog,
const gchar *property,
GObject *config,
const gchar *config_property,
GimpValueArray *values,
gboolean in_values);
gboolean gimp_procedure_dialog_run (GimpProcedureDialog *dialog);
G_END_DECLS
#endif /* __GIMP_PROCEDURE_DIALOG_H__ */