gimpprocbrowserdialog.c 16.2 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/* 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
16
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
17 18
 */

19
/*
20 21 22 23 24
 * 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
 */
Elliot Lee's avatar
Elliot Lee committed
25

Sven Neumann's avatar
Sven Neumann committed
26
#include "config.h"
27

Daniel Egger's avatar
Daniel Egger committed
28
#include <string.h>
29

30 31 32 33 34
#include <gtk/gtk.h>

#include <libgimp/gimp.h>
#include <libgimp/gimpui.h>

35
#include "gimpprocbox.h"
36
#include "gimpprocbrowser.h"
37
#include "gimpprocview.h"
38

Sven Neumann's avatar
Sven Neumann committed
39
#include "libgimp/stdplugins-intl.h"
Elliot Lee's avatar
Elliot Lee committed
40

41

42 43 44 45
#define RESPONSE_SEARCH       1
#define RESPONSE_SEARCH_NAME  2
#define RESPONSE_SEARCH_BLURB 3

46
#define DBL_LIST_WIDTH 250
47
#define DBL_WIDTH      (DBL_LIST_WIDTH + 400)
48
#define DBL_HEIGHT     250
49

50 51 52 53 54 55
enum
{
  COLUMN_LABEL,
  COLUMN_PROC_NAME,
  N_COLUMNS
};
56 57 58

typedef struct
{
59
  GtkWidget        *dialog;
60

61
  GtkWidget        *count_label;
62
  GtkWidget        *search_entry;
63
  GtkWidget        *proc_box;
64

65 66 67
  GtkListStore     *store;
  GtkWidget        *tv;
  GtkTreeSelection *sel;
68 69

  /* the currently selected procedure */
70 71 72 73 74 75 76 77 78 79 80 81
  gchar            *proc_name;
  gchar            *proc_blurb;
  gchar            *proc_help;
  gchar            *proc_author;
  gchar            *proc_copyright;
  gchar            *proc_date;
  GimpPDBProcType   proc_type;
  gint              n_params;
  gint              n_return_vals;
  GimpParamDef     *params;
  GimpParamDef     *return_vals;

82
  gboolean                     scheme_names;
83
  GimpProcBrowserApplyCallback apply_callback;
84
  gpointer                     user_data;
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
} GimpDBBrowser;


/*  local function prototypes  */

static void   browser_response          (GtkWidget         *widget,
                                         gint               response_id,
                                         GimpDBBrowser     *browser);
static void   browser_selection_changed (GtkTreeSelection  *sel,
                                         GimpDBBrowser     *browser);
static void   browser_row_activated     (GtkTreeView       *treeview,
                                         GtkTreePath       *path,
                                         GtkTreeViewColumn *column,
                                         GimpDBBrowser     *browser);
static void   browser_show_procedure    (GimpDBBrowser     *browser,
                                         gchar             *proc_name);
static void   browser_convert_string    (gchar             *str);


/*  public functions  */

106
GtkWidget *
107
gimp_proc_browser_dialog_new (gboolean                     scheme_names,
108 109
                              GimpProcBrowserApplyCallback apply_callback,
                              gpointer                     user_data)
Elliot Lee's avatar
Elliot Lee committed
110
{
111 112 113
  GimpDBBrowser   *browser;
  GtkWidget       *paned;
  GtkWidget       *hbox;
114 115 116 117
  GtkWidget       *vbox;
  GtkWidget       *label;
  GtkWidget       *scrolled_window;
  GtkCellRenderer *renderer;
118

119
  browser = g_new0 (GimpDBBrowser, 1);
120

121
  browser->scheme_names   = scheme_names ? TRUE : FALSE;
122
  browser->apply_callback = apply_callback;
123
  browser->user_data      = user_data;
124

Sven Neumann's avatar
Sven Neumann committed
125 126 127 128 129 130 131 132 133 134
  browser->dialog =
    gimp_dialog_new (_("Procedure Browser"), "dbbrowser",
                     NULL, 0,
                     gimp_standard_help_func, "plug-in-db-browser",

                     _("Search by _Name"),        RESPONSE_SEARCH_NAME,
                     _("Search by _Description"), RESPONSE_SEARCH_BLURB,

                     NULL);

135
  if (apply_callback)
Sven Neumann's avatar
Sven Neumann committed
136 137 138 139 140
    gtk_dialog_add_button (GTK_DIALOG (browser->dialog),
                           GTK_STOCK_APPLY, GTK_RESPONSE_APPLY);

  gtk_dialog_add_button (GTK_DIALOG (browser->dialog),
                         GTK_STOCK_CLOSE, GTK_RESPONSE_CLOSE);
141

142
  gtk_dialog_set_default_response (GTK_DIALOG (browser->dialog),
143 144
                                   RESPONSE_SEARCH_NAME);

145 146 147
  g_signal_connect (browser->dialog, "response",
                    G_CALLBACK (browser_response),
                    browser);
148

149
  /* paned : left=list ; right=description */
150

151 152 153 154 155
  paned = gtk_hpaned_new ();
  gtk_container_set_border_width (GTK_CONTAINER (paned), 12);
  gtk_container_add (GTK_CONTAINER (GTK_DIALOG (browser->dialog)->vbox),
                     paned);
  gtk_widget_show (paned);
156

Elliot Lee's avatar
Elliot Lee committed
157
  /* left = vbox : the list and the search entry */
158

159
  vbox = gtk_vbox_new (FALSE, 6);
160
  gtk_paned_pack1 (GTK_PANED (paned), vbox, FALSE, TRUE);
161 162
  gtk_widget_show (vbox);

163 164 165 166 167
  browser->count_label = gtk_label_new ("0 Procedures");
  gtk_misc_set_alignment (GTK_MISC (browser->count_label), 0.0, 0.5);
  gtk_box_pack_start (GTK_BOX (vbox), browser->count_label, FALSE, FALSE, 0);
  gtk_widget_show (browser->count_label);

Elliot Lee's avatar
Elliot Lee committed
168
  /* list : list in a scrolled_win */
169

170
  scrolled_window = gtk_scrolled_window_new (NULL, NULL);
171
  gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (scrolled_window),
172
                                       GTK_SHADOW_IN);
173
  gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled_window),
174 175
                                  GTK_POLICY_AUTOMATIC,
                                  GTK_POLICY_ALWAYS);
176 177
  gtk_box_pack_start (GTK_BOX (vbox), scrolled_window, TRUE, TRUE, 0);
  gtk_widget_show (scrolled_window);
178

179
  browser->tv = gtk_tree_view_new ();
180

181 182 183 184
  renderer = gtk_cell_renderer_text_new ();
  gtk_cell_renderer_text_set_fixed_height_from_font
    (GTK_CELL_RENDERER_TEXT (renderer), 1);

185
  gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (browser->tv),
186 187 188 189
                                               -1, NULL,
                                               renderer,
                                               "text", 0,
                                               NULL);
190
  gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (browser->tv), FALSE);
191

192
  if (apply_callback)
193 194 195 196 197 198 199
    g_signal_connect (browser->tv, "row_activated",
                      G_CALLBACK (browser_row_activated),
                      browser);

  gtk_widget_set_size_request (browser->tv, DBL_LIST_WIDTH, DBL_HEIGHT);
  gtk_container_add (GTK_CONTAINER (scrolled_window), browser->tv);
  gtk_widget_show (browser->tv);
200

201
  browser->sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (browser->tv));
202

203 204 205
  g_signal_connect (browser->sel, "changed",
                    G_CALLBACK (browser_selection_changed),
                    browser);
Elliot Lee's avatar
Elliot Lee committed
206 207 208

  /* search entry */

209 210 211
  hbox = gtk_hbox_new (FALSE, 6);
  gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
  gtk_widget_show (hbox);
Elliot Lee's avatar
Elliot Lee committed
212

213
  label = gtk_label_new_with_mnemonic (_("_Search:"));
214
  gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
215
  gtk_widget_show (label);
Elliot Lee's avatar
Elliot Lee committed
216

217 218 219 220
  browser->search_entry = gtk_entry_new ();
  gtk_entry_set_activates_default (GTK_ENTRY (browser->search_entry), TRUE);
  gtk_box_pack_start (GTK_BOX (hbox), browser->search_entry, TRUE, TRUE, 0);
  gtk_widget_show (browser->search_entry);
Elliot Lee's avatar
Elliot Lee committed
221

222
  gtk_label_set_mnemonic_widget (GTK_LABEL (label), browser->search_entry);
223

Elliot Lee's avatar
Elliot Lee committed
224 225
  /* right = description */

226 227
  browser->proc_box = gimp_proc_box_new ();
  gtk_widget_set_size_request (browser->proc_box,
228
                               DBL_WIDTH - DBL_LIST_WIDTH, -1);
229 230
  gtk_paned_pack2 (GTK_PANED (paned), browser->proc_box, TRUE, TRUE);
  gtk_widget_show (browser->proc_box);
Elliot Lee's avatar
Elliot Lee committed
231 232 233

  /* now build the list */

234
  gtk_widget_show (browser->dialog);
Elliot Lee's avatar
Elliot Lee committed
235 236 237

  /* initialize the "return" value (for "apply") */

238 239 240 241 242 243 244 245 246 247 248
  browser->proc_name        = NULL;
  browser->proc_blurb       = NULL;
  browser->proc_help        = NULL;
  browser->proc_author      = NULL;
  browser->proc_copyright   = NULL;
  browser->proc_date        = NULL;
  browser->proc_type        = 0;
  browser->n_params         = 0;
  browser->n_return_vals    = 0;
  browser->params           = NULL;
  browser->return_vals      = NULL;
Elliot Lee's avatar
Elliot Lee committed
249 250

  /* first search (all procedures) */
251
  browser_response (browser->dialog, RESPONSE_SEARCH, browser);
252

253
  gtk_widget_grab_focus (browser->search_entry);
Elliot Lee's avatar
Elliot Lee committed
254

255
  return browser->dialog;
256 257
}

258 259 260

/*  private functions  */

261
static void
262 263
browser_selection_changed (GtkTreeSelection *sel,
                           GimpDBBrowser    *browser)
Elliot Lee's avatar
Elliot Lee committed
264
{
265
  GtkTreeIter iter;
266

267 268
  if (gtk_tree_selection_get_selected (sel, NULL, &iter))
    {
269 270 271 272
      gchar *proc_name;

      gtk_tree_model_get (GTK_TREE_MODEL (browser->store), &iter,
                          COLUMN_PROC_NAME, &proc_name,
273
                          -1);
274 275
      browser_show_procedure (browser, proc_name);
      g_free (proc_name);
276
    }
Elliot Lee's avatar
Elliot Lee committed
277 278
}

279
static void
280 281 282 283
browser_row_activated (GtkTreeView       *treeview,
                       GtkTreePath       *path,
                       GtkTreeViewColumn *column,
                       GimpDBBrowser     *browser)
Elliot Lee's avatar
Elliot Lee committed
284
{
285 286
  browser_response (browser->dialog, GTK_RESPONSE_APPLY, browser);
}
Elliot Lee's avatar
Elliot Lee committed
287

288 289 290 291 292 293
static void
browser_show_procedure (GimpDBBrowser *browser,
                        gchar         *proc_name)
{
  g_free (browser->proc_name);
  browser->proc_name = g_strdup (proc_name);
Elliot Lee's avatar
Elliot Lee committed
294

295 296
  if (browser->scheme_names)
    browser_convert_string (browser->proc_name);
Elliot Lee's avatar
Elliot Lee committed
297

298 299 300 301 302
  g_free (browser->proc_blurb);
  g_free (browser->proc_help);
  g_free (browser->proc_author);
  g_free (browser->proc_copyright);
  g_free (browser->proc_date);
303 304 305

  gimp_destroy_paramdefs (browser->params,      browser->n_params);
  gimp_destroy_paramdefs (browser->return_vals, browser->n_return_vals);
306

307 308 309 310 311 312 313 314 315 316 317 318
  gimp_procedural_db_proc_info (proc_name,
                                &browser->proc_blurb,
                                &browser->proc_help,
                                &browser->proc_author,
                                &browser->proc_copyright,
                                &browser->proc_date,
                                &browser->proc_type,
                                &browser->n_params,
                                &browser->n_return_vals,
                                &browser->params,
                                &browser->return_vals);

319
  gimp_proc_box_set_widget (browser->proc_box,
320
                            gimp_proc_view_new (browser->proc_name,
321 322 323 324 325 326 327 328 329 330 331
                                                NULL,
                                                browser->proc_blurb,
                                                browser->proc_help,
                                                browser->proc_author,
                                                browser->proc_copyright,
                                                browser->proc_date,
                                                browser->proc_type,
                                                browser->n_params,
                                                browser->n_return_vals,
                                                browser->params,
                                                browser->return_vals));
Elliot Lee's avatar
Elliot Lee committed
332 333 334
}

static void
335 336 337
browser_response (GtkWidget     *widget,
                  gint           response_id,
                  GimpDBBrowser *browser)
Elliot Lee's avatar
Elliot Lee committed
338
{
339
  switch (response_id)
340
    {
341
    case GTK_RESPONSE_APPLY:
342 343 344 345 346 347 348 349 350 351
      browser->apply_callback (browser->proc_name,
                               browser->proc_blurb,
                               browser->proc_help,
                               browser->proc_author,
                               browser->proc_copyright,
                               browser->proc_date,
                               browser->proc_type,
                               browser->n_params,
                               browser->n_return_vals,
                               browser->params,
352 353
                               browser->return_vals,
                               browser->user_data);
354 355 356 357 358 359 360 361
      break;

    case RESPONSE_SEARCH:
    case RESPONSE_SEARCH_NAME:
    case RESPONSE_SEARCH_BLURB:
      {
        gchar       **proc_list;
        gint          num_procs;
362
        gchar        *str;
363 364 365 366 367
        gint          i;
        const gchar  *query_text;
        GString      *query;
        GtkTreeIter   iter;

368
        gtk_tree_view_set_model (GTK_TREE_VIEW (browser->tv), NULL);
369 370 371 372 373

        /* search */

        if (response_id == RESPONSE_SEARCH_NAME)
          {
374 375
            gimp_proc_box_show_message (browser->proc_box,
                                        _("Searching by name - please wait"));
376 377

            query = g_string_new ("");
378
            query_text = gtk_entry_get_text (GTK_ENTRY (browser->search_entry));
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

            while (*query_text)
              {
                if ((*query_text == '_') || (*query_text == '-'))
                  g_string_append (query, "[-_]");
                else
                  g_string_append_c (query, *query_text);

                query_text++;
              }

            gimp_procedural_db_query (query->str,
                                      ".*", ".*", ".*", ".*", ".*", ".*",
                                      &num_procs, &proc_list);

            g_string_free (query, TRUE);
          }
        else if (response_id == RESPONSE_SEARCH_BLURB)
          {
398 399
            gimp_proc_box_show_message (browser->proc_box,
                                        _("Searching by blurb - please wait"));
400 401 402

            gimp_procedural_db_query (".*",
                                      (gchar *) gtk_entry_get_text
403
                                      (GTK_ENTRY (browser->search_entry)),
404 405 406 407 408
                                      ".*", ".*", ".*", ".*", ".*",
                                      &num_procs, &proc_list);
          }
        else
          {
409 410
            gimp_proc_box_show_message (browser->proc_box,
                                        _("Searching - please wait"));
411 412 413 414 415

            gimp_procedural_db_query (".*", ".*", ".*", ".*", ".*", ".*", ".*",
                                      &num_procs, &proc_list);
          }

416 417 418 419 420
        if (num_procs == 1)
          str = g_strdup (_("1 Procedure"));
        else
          str = g_strdup_printf (_("%d Procedures"), num_procs);

421 422 423 424 425 426 427 428 429
        gtk_label_set_text (GTK_LABEL (browser->count_label), str);
        g_free (str);

        browser->store = gtk_list_store_new (N_COLUMNS,
                                             G_TYPE_STRING,
                                             G_TYPE_STRING);
        gtk_tree_view_set_model (GTK_TREE_VIEW (browser->tv),
                                 GTK_TREE_MODEL (browser->store));
        g_object_unref (browser->store);
430 431 432

        for (i = 0; i < num_procs; i++)
          {
433 434
            gchar *label;

435
            label = g_strdup (proc_list[i]);
436 437 438

            if (browser->scheme_names)
              browser_convert_string (label);
439 440 441 442 443

            gtk_list_store_append (browser->store, &iter);
            gtk_list_store_set (browser->store, &iter,
                                COLUMN_LABEL,     label,
                                COLUMN_PROC_NAME, proc_list[i],
444
                                -1);
445

446 447 448 449 450 451
            g_free (label);
            g_free (proc_list[i]);
          }

        g_free (proc_list);

452 453
        gtk_tree_view_columns_autosize (GTK_TREE_VIEW (browser->tv));

454
        gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (browser->store),
455
                                              COLUMN_LABEL, GTK_SORT_ASCENDING);
456 457 458

        if (num_procs > 0)
          {
459 460
            gtk_tree_model_get_iter_first (GTK_TREE_MODEL (browser->store),
                                           &iter);
461
            gtk_tree_selection_select_iter (browser->sel, &iter);
462 463 464
          }
        else
          {
465
            gimp_proc_box_show_message (browser->proc_box, _("No matches"));
466 467 468 469 470
          }
      }
      break;

    default:
471
      if (browser->apply_callback)
472
        {
473 474 475 476
          /* we are called by another application:
           * just destroy the dialog box
           */
          gtk_widget_destroy (browser->dialog);
477 478 479
        }
      else
        {
480 481 482
          /* we are in the plug_in:
           * quit the gtk application
           */
483 484 485
          gtk_main_quit ();
        }
      break;
486
    }
Elliot Lee's avatar
Elliot Lee committed
487 488
}

489
static void
490
browser_convert_string (gchar *str)
Elliot Lee's avatar
Elliot Lee committed
491 492 493
{
  while (*str)
    {
494
      if (*str == '_')
495
        *str = '-';
496

Elliot Lee's avatar
Elliot Lee committed
497 498 499
      str++;
    }
}