gimp/libgimp/gimpprocview.c

326 lines
11 KiB
C

/* The GIMP -- an image manipulation program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/*
* 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 <gtk/gtk.h>
#include <libgimp/gimp.h>
#include <libgimp/gimpui.h>
#include "gimpprocview.h"
#include "libgimp/stdplugins-intl.h"
/* local function prototypes */
static GtkWidget * gimp_proc_view_create_params (GimpParamDef *params,
gint n_params,
GtkSizeGroup *name_group,
GtkSizeGroup *type_group,
GtkSizeGroup *desc_group);
static const gchar * GimpPDBArgType_to_string (GimpPDBArgType type);
static const gchar * GimpPDBProcType_to_string (GimpPDBProcType type);
/* public functions */
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,
GimpParamDef *params,
GimpParamDef *return_vals)
{
GtkWidget *main_vbox;
GtkWidget *frame;
GtkWidget *vbox;
GtkWidget *table;
GtkWidget *label;
GtkSizeGroup *name_group;
GtkSizeGroup *type_group;
GtkSizeGroup *desc_group;
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_vbox_new (FALSE, 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_vbox_new (FALSE, 8);
gtk_container_add (GTK_CONTAINER (frame), vbox);
gtk_widget_show (vbox);
label = gtk_label_new (GimpPDBProcType_to_string (type));
gimp_label_set_attributes (GTK_LABEL (label),
PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
-1);
gtk_misc_set_alignment (GTK_MISC (label), 0.0, 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_misc_set_alignment (GTK_MISC (label), 0.0, 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_misc_set_alignment (GTK_MISC (label), 0.0, 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_vbox_new (FALSE, 8);
gtk_container_add (GTK_CONTAINER (frame), vbox);
gtk_widget_show (vbox);
/* show the help */
if (help)
{
label = gtk_label_new (help);
gtk_misc_set_alignment (GTK_MISC (label), 0.0, 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 ((author != 0) + (date != 0) + (copyright != 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_misc_set_alignment (GTK_MISC (label), 0.0, 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_misc_set_alignment (GTK_MISC (label), 0.0, 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_misc_set_alignment (GTK_MISC (label), 0.0, 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 (GimpParamDef *params,
gint n_params,
GtkSizeGroup *name_group,
GtkSizeGroup *type_group,
GtkSizeGroup *desc_group)
{
GtkWidget *table;
GtkWidget *label;
const gchar *type;
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++)
{
/* name */
label = gtk_label_new (params[i].name);
gtk_misc_set_alignment (GTK_MISC (label), 0.0, 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 */
type = GimpPDBArgType_to_string (params[i].type);
label = gtk_label_new (type);
gimp_label_set_attributes (GTK_LABEL (label),
PANGO_ATTR_FAMILY, "monospace",
PANGO_ATTR_STYLE, PANGO_STYLE_ITALIC,
-1);
gtk_misc_set_alignment (GTK_MISC (label), 0.0, 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_misc_set_alignment (GTK_MISC (label), 0.0, 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;
}
static const gchar *
GimpPDBArgType_to_string (GimpPDBArgType type)
{
switch (type)
{
case GIMP_PDB_INT32: return "INT32";
case GIMP_PDB_INT16: return "INT16";
case GIMP_PDB_INT8: return "INT8";
case GIMP_PDB_FLOAT: return "FLOAT";
case GIMP_PDB_STRING: return "STRING";
case GIMP_PDB_INT32ARRAY: return "INT32ARRAY";
case GIMP_PDB_INT16ARRAY: return "INT16ARRAY";
case GIMP_PDB_INT8ARRAY: return "INT8ARRAY";
case GIMP_PDB_FLOATARRAY: return "FLOATARRAY";
case GIMP_PDB_STRINGARRAY: return "STRINGARRAY";
case GIMP_PDB_COLOR: return "COLOR";
case GIMP_PDB_REGION: return "REGION";
case GIMP_PDB_DISPLAY: return "DISPLAY";
case GIMP_PDB_IMAGE: return "IMAGE";
case GIMP_PDB_LAYER: return "LAYER";
case GIMP_PDB_CHANNEL: return "CHANNEL";
case GIMP_PDB_DRAWABLE: return "DRAWABLE";
case GIMP_PDB_SELECTION: return "SELECTION";
case GIMP_PDB_BOUNDARY: return "BOUNDARY";
case GIMP_PDB_PATH: return "PATH";
case GIMP_PDB_PARASITE: return "PARASITE";
case GIMP_PDB_STATUS: return "STATUS";
case GIMP_PDB_END: return "END";
default: return "UNKNOWN?";
}
}
static const gchar *
GimpPDBProcType_to_string (GimpPDBProcType type)
{
switch (type)
{
case GIMP_INTERNAL: return _("Internal GIMP procedure");
case GIMP_PLUGIN: return _("GIMP Plug-In");
case GIMP_EXTENSION: return _("GIMP Extension");
case GIMP_TEMPORARY: return _("Temporary Procedure");
default: return "UNKNOWN";
}
}