summaryrefslogtreecommitdiffstats
path: root/libgimp/gimpprocview.c
diff options
context:
space:
mode:
Diffstat (limited to 'libgimp/gimpprocview.c')
-rw-r--r--libgimp/gimpprocview.c339
1 files changed, 339 insertions, 0 deletions
diff --git a/libgimp/gimpprocview.c b/libgimp/gimpprocview.c
new file mode 100644
index 0000000..fab2e6b
--- /dev/null
+++ b/libgimp/gimpprocview.c
@@ -0,0 +1,339 @@
+/* LIBGIMP - The GIMP Library
+ * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
+ *
+ * gimpprocview.c
+ *
+ * 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/>.
+ */
+
+/*
+ * dbbrowser_utils.c
+ * 0.08 26th sept 97 by Thomas NOEL <thomas@minet.net>
+ *
+ * 98/12/13 Sven Neumann <sven@gimp.org> : added help display
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include <gegl.h>
+#include <gtk/gtk.h>
+
+#include "libgimpwidgets/gimpwidgets.h"
+
+#include "gimp.h"
+
+#include "gimpuitypes.h"
+#include "gimpprocview.h"
+
+#include "libgimp-intl.h"
+
+
+/**
+ * SECTION: gimpprocview
+ * @title: GimpProcView
+ * @short_description: A widget showing information about a PDB procedure.
+ *
+ * A widget showing information about a PDB procedure, mainly for the
+ * procedure and plug-in browsers.
+ **/
+
+
+/* local function prototypes */
+
+static GtkWidget * gimp_proc_view_create_params (const GimpParamDef *params,
+ gint n_params,
+ GtkSizeGroup *name_group,
+ GtkSizeGroup *type_group,
+ GtkSizeGroup *desc_group);
+
+
+/* public functions */
+
+
+/**
+ * gimp_proc_view_new:
+ * @name:
+ * @menu_path:
+ * @blurb:
+ * @help:
+ * @author:
+ * @copyright:
+ * @date:
+ * @type:
+ * @n_params:
+ * @n_return_vals:
+ * @params:
+ * @return_vals:
+ *
+ * Return value: a new widget providing a view on a GIMP procedure
+ *
+ * Since: 2.4
+ **/
+GtkWidget *
+gimp_proc_view_new (const gchar *name,
+ const gchar *menu_path,
+ const gchar *blurb,
+ const gchar *help,
+ const gchar *author,
+ const gchar *copyright,
+ const gchar *date,
+ GimpPDBProcType type,
+ gint n_params,
+ gint n_return_vals,
+ const GimpParamDef *params,
+ const GimpParamDef *return_vals)
+{
+ GtkWidget *main_vbox;
+ GtkWidget *frame;
+ GtkWidget *vbox;
+ GtkWidget *table;
+ GtkWidget *label;
+ GtkSizeGroup *name_group;
+ GtkSizeGroup *type_group;
+ GtkSizeGroup *desc_group;
+ const gchar *type_str;
+ gint row;
+
+ if (blurb && strlen (blurb) < 2) blurb = NULL;
+ if (help && strlen (help) < 2) help = NULL;
+ if (author && strlen (author) < 2) author = NULL;
+ if (date && strlen (date) < 2) date = NULL;
+ if (copyright && strlen (copyright) < 2) copyright = NULL;
+
+ if (blurb && help && ! strcmp (blurb, help))
+ help = NULL;
+
+ main_vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);
+
+ /* show the name */
+
+ frame = gimp_frame_new (name);
+ label = gtk_frame_get_label_widget (GTK_FRAME (frame));
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_box_pack_start (GTK_BOX (main_vbox), frame, FALSE, FALSE, 0);
+ gtk_widget_show (frame);
+
+ vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 8);
+ gtk_container_add (GTK_CONTAINER (frame), vbox);
+ gtk_widget_show (vbox);
+
+ if (! gimp_enum_get_value (GIMP_TYPE_PDB_PROC_TYPE, type,
+ NULL, NULL, &type_str, NULL))
+ type_str = "UNKNOWN";
+
+ label = gtk_label_new (type_str);
+ gimp_label_set_attributes (GTK_LABEL (label),
+ PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
+ -1);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, FALSE, 0);
+ gtk_widget_show (label);
+
+ if (menu_path)
+ {
+ label = gtk_label_new_with_mnemonic (menu_path);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+ gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, FALSE, 0);
+ gtk_widget_show (label);
+ }
+
+ if (blurb)
+ {
+ label = gtk_label_new (blurb);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+ gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, FALSE, 0);
+ gtk_widget_show (label);
+ }
+
+ name_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
+ type_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
+ desc_group = gtk_size_group_new (GTK_SIZE_GROUP_HORIZONTAL);
+
+ /* in parameters */
+ if (n_params)
+ {
+ frame = gimp_frame_new (_("Parameters"));
+ gtk_box_pack_start (GTK_BOX (main_vbox), frame, FALSE, FALSE, 0);
+ gtk_widget_show (frame);
+
+ table = gimp_proc_view_create_params (params, n_params,
+ name_group, type_group, desc_group);
+ gtk_container_add (GTK_CONTAINER (frame), table);
+ gtk_widget_show (table);
+ }
+
+ /* out parameters */
+ if (n_return_vals)
+ {
+ frame = gimp_frame_new (_("Return Values"));
+ gtk_box_pack_start (GTK_BOX (main_vbox), frame, FALSE, FALSE, 0);
+ gtk_widget_show (frame);
+
+ table = gimp_proc_view_create_params (return_vals, n_return_vals,
+ name_group, type_group, desc_group);
+ gtk_container_add (GTK_CONTAINER (frame), table);
+ gtk_widget_show (table);
+ }
+
+ if (! help && ! author && ! date && ! copyright)
+ return main_vbox;
+
+ frame = gimp_frame_new (_("Additional Information"));
+ gtk_box_pack_start (GTK_BOX (main_vbox), frame, FALSE, FALSE, 0);
+ gtk_widget_show (frame);
+
+ vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 8);
+ gtk_container_add (GTK_CONTAINER (frame), vbox);
+ gtk_widget_show (vbox);
+
+ /* show the help */
+ if (help)
+ {
+ label = gtk_label_new (help);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+ gtk_box_pack_start (GTK_BOX (vbox), label, FALSE, FALSE, 0);
+ gtk_widget_show (label);
+ }
+
+ /* show the author & the copyright */
+
+ if (! author && ! date && ! copyright)
+ return main_vbox;
+
+ table = gtk_table_new (0, 2, FALSE);
+ gtk_table_set_col_spacings (GTK_TABLE (table), 6);
+ gtk_table_set_row_spacings (GTK_TABLE (table), 4);
+ gtk_box_pack_start (GTK_BOX (vbox), table, FALSE, FALSE, 0);
+ gtk_widget_show (table);
+
+ row = 0;
+
+ if (author)
+ {
+ label = gtk_label_new (author);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+
+ gimp_table_attach_aligned (GTK_TABLE (table), 0, row++,
+ _("Author:"), 0.0, 0.0,
+ label, 3, FALSE);
+ }
+
+ if (date)
+ {
+ label = gtk_label_new (date);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+
+ gimp_table_attach_aligned (GTK_TABLE (table), 0, row++,
+ _("Date:"), 0.0, 0.0,
+ label, 3, FALSE);
+ }
+
+ if (copyright)
+ {
+ label = gtk_label_new (copyright);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+
+ gimp_table_attach_aligned (GTK_TABLE (table), 0, row++,
+ _("Copyright:"), 0.0, 0.0,
+ label, 3, FALSE);
+ }
+
+ return main_vbox;
+}
+
+
+/* private functions */
+
+static GtkWidget *
+gimp_proc_view_create_params (const GimpParamDef *params,
+ gint n_params,
+ GtkSizeGroup *name_group,
+ GtkSizeGroup *type_group,
+ GtkSizeGroup *desc_group)
+{
+ GtkWidget *table;
+ gint i;
+
+ table = gtk_table_new (n_params, 3, FALSE);
+ gtk_table_set_col_spacings (GTK_TABLE (table), 6);
+ gtk_table_set_row_spacings (GTK_TABLE (table), 4);
+
+ for (i = 0; i < n_params; i++)
+ {
+ GtkWidget *label;
+ const gchar *type;
+ gchar *upper;
+
+ /* name */
+ label = gtk_label_new (params[i].name);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_size_group_add_widget (name_group, label);
+ gtk_table_attach (GTK_TABLE (table), label,
+ 0, 1, i, i + 1, GTK_FILL, GTK_FILL, 0, 0);
+ gtk_widget_show (label);
+
+ /* type */
+ if (! gimp_enum_get_value (GIMP_TYPE_PDB_ARG_TYPE, params[i].type,
+ NULL, &type, NULL, NULL))
+ upper = g_strdup ("UNKNOWN");
+ else
+ upper = g_ascii_strup (type, -1);
+
+ label = gtk_label_new (upper);
+ g_free (upper);
+
+ gimp_label_set_attributes (GTK_LABEL (label),
+ PANGO_ATTR_FAMILY, "monospace",
+ PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
+ -1);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_size_group_add_widget (type_group, label);
+ gtk_table_attach (GTK_TABLE (table), label,
+ 1, 2, i, i + 1, GTK_FILL, GTK_FILL, 0, 0);
+ gtk_widget_show (label);
+
+ /* description */
+ label = gtk_label_new (params[i].description);
+ gtk_label_set_selectable (GTK_LABEL (label), TRUE);
+ gtk_label_set_xalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_yalign (GTK_LABEL (label), 0.0);
+ gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
+ gtk_size_group_add_widget (desc_group, label);
+ gtk_table_attach (GTK_TABLE (table), label,
+ 2, 3, i, i + 1, GTK_SHRINK | GTK_FILL, GTK_FILL, 0, 0);
+ gtk_widget_show (label);
+ }
+
+ return table;
+}