src/ui_help.c

   1 /*
   2  * (SLIK) SimpLIstic sKin functions
   3  * (C) 2004 John Ellis
   4  * Copyright (C) 2008 - 2012 The Geeqie Team
   5  *
   6  * Author: John Ellis
   7  *
   8  * This software is released under the GNU General Public License (GNU GPL).
   9  * Please read the included file COPYING for more information.
  10  * This software comes with no warranty of any kind, use at your own risk!
  11  */
  12
  13 #ifdef HAVE_CONFIG_H
  14 #  include "config.h"
  15 #endif
  16 #include "intl.h"
  17
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <string.h>
  21
  22 #include <gtk/gtk.h>
  23
  24 #include "main.h"
  25 #include "ui_help.h"
  26
  27 #include "ui_fileops.h"
  28 #include "ui_misc.h"
  29 #include "window.h"
  30
  31
  32 #define HELP_WINDOW_WIDTH 650
  33 #define HELP_WINDOW_HEIGHT 350
  34
  35
  36 /*
  37  *-----------------------------------------------------------------------------
  38  * 'help' window
  39  *-----------------------------------------------------------------------------
  40  */
  41
  42 #define SCROLL_MARKNAME "scroll_point"
  43
  44 static void help_window_scroll(GtkWidget *text, const gchar *key)
  45 {
  46         gchar *needle;
  47         GtkTextBuffer *buffer;
  48         GtkTextIter iter;
  49         GtkTextIter start, end;
  50
  51         if (!text || !key) return;
  52
  53         needle = g_strdup_printf("[section:%s]", key);
  54
  55         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
  56         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
  57
  58         if (gtk_text_iter_forward_search(&iter, needle, GTK_TEXT_SEARCH_TEXT_ONLY,
  59                                          &start, &end, NULL))
  60                 {
  61                 gint line;
  62                 GtkTextMark *mark;
  63
  64                 line = gtk_text_iter_get_line(&start);
  65                 gtk_text_buffer_get_iter_at_line_offset(buffer, &iter, line, 0);
  66                 gtk_text_buffer_place_cursor(buffer, &iter);
  67
  68                 /* apparently only scroll_to_mark works when the textview is not visible yet */
  69
  70                 /* if mark exists, move it instead of creating one for every scroll */
  71                 mark = gtk_text_buffer_get_mark(buffer, SCROLL_MARKNAME);
  72                 if (mark)
  73                         {
  74                         gtk_text_buffer_move_mark(buffer, mark, &iter);
  75                         }
  76                 else
  77                         {
  78                         mark = gtk_text_buffer_create_mark(buffer, SCROLL_MARKNAME, &iter, FALSE);
  79                         }
  80                 gtk_text_view_scroll_to_mark(GTK_TEXT_VIEW(text), mark, 0.0, TRUE, 0, 0);
  81                 }
  82
  83         g_free(needle);
  84 }
  85
  86 static void help_window_load_text(GtkWidget *text, const gchar *path)
  87 {
  88         gchar *pathl;
  89         FILE *f;
  90         gchar s_buf[1024];
  91         GtkTextBuffer *buffer;
  92         GtkTextIter iter;
  93         GtkTextIter start, end;
  94
  95         if (!text || !path) return;
  96
  97         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
  98
  99         gtk_text_buffer_get_bounds(buffer, &start, &end);
 100         gtk_text_buffer_delete(buffer, &start, &end);
 101
 102         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 103
 104         pathl = path_from_utf8(path);
 105         f = fopen(pathl, "r");
 106         g_free(pathl);
 107         if (!f)
 108                 {
 109                 gchar *buf;
 110                 buf = g_strdup_printf(_("Unable to load:\n%s"), path);
 111                 gtk_text_buffer_insert(buffer, &iter, buf, -1);
 112                 g_free(buf);
 113                 }
 114         else
 115                 {
 116                 while (fgets(s_buf, sizeof(s_buf), f))
 117                         {
 118                         gchar *buf;
 119                         gint l;
 120
 121                         l = strlen(s_buf);
 122
 123                         if (!g_utf8_validate(s_buf, l, NULL))
 124                                 {
 125                                 buf = g_locale_to_utf8(s_buf, l, NULL, NULL, NULL);
 126                                 if (!buf) buf = g_strdup("\n");
 127                                 }
 128                         else
 129                                 {
 130                                 buf = NULL;
 131                                 }
 132                         gtk_text_buffer_insert_with_tags_by_name(buffer, &iter,
 133                                                                  (buf) ? buf : s_buf, -1,
 134                                                                  "monospace", NULL);
 135                         g_free(buf);
 136                         }
 137                 fclose(f);
 138                 }
 139
 140         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 141         gtk_text_buffer_place_cursor(buffer, &iter);
 142         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(text), &iter, 0.0, TRUE, 0, 0);
 143 }
 144
 145 static gboolean help_window_delete_cb(GtkWidget *widget, GdkEventAny *event, gpointer data)
 146 {
 147         gtk_widget_destroy(widget);
 148         return TRUE;
 149 }
 150
 151 static void help_window_close(GtkWidget *widget, gpointer data)
 152 {
 153         GtkWidget *window = data;
 154         gtk_widget_destroy(window);
 155 }
 156
 157 void help_window_set_key(GtkWidget *window, const gchar *key)
 158 {
 159         GtkWidget *text;
 160
 161         if (!window) return;
 162
 163         text = g_object_get_data(G_OBJECT(window), "text_widget");
 164         if (!text) return;
 165
 166         gdk_window_raise(gtk_widget_get_window(window));
 167
 168         if (key) help_window_scroll(text, key);
 169 }
 170
 171 void help_window_set_file(GtkWidget *window, const gchar *path, const gchar *key)
 172 {
 173         GtkWidget *text;
 174
 175         if (!window || !path) return;
 176
 177         text = g_object_get_data(G_OBJECT(window), "text_widget");
 178         if (!text) return;
 179
 180         gdk_window_raise(gtk_widget_get_window(window));
 181
 182         help_window_load_text(text, path);
 183         help_window_scroll(text, key);
 184 }
 185
 186 GtkWidget *help_window_new(const gchar *title,
 187                            const gchar *subclass,
 188                            const gchar *path, const gchar *key)
 189 {
 190         GtkWidget *window;
 191         GtkWidget *text;
 192         GtkTextBuffer *buffer;
 193         GtkWidget *vbox;
 194         GtkWidget *hbox;
 195         GtkWidget *button;
 196         GtkWidget *scrolled;
 197
 198         /* window */
 199
 200         window = window_new(GTK_WINDOW_TOPLEVEL, subclass, NULL, NULL, title);
 201         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 202         gtk_window_set_default_size(GTK_WINDOW(window), HELP_WINDOW_WIDTH, HELP_WINDOW_HEIGHT);
 203
 204         g_signal_connect(G_OBJECT(window), "delete_event",
 205                          G_CALLBACK(help_window_delete_cb), NULL);
 206
 207         vbox = gtk_vbox_new(FALSE, 0);
 208         gtk_container_add(GTK_CONTAINER(window), vbox);
 209         gtk_widget_show(vbox);
 210
 211         g_object_set_data(G_OBJECT(window), "text_vbox", vbox);
 212
 213         /* text window */
 214
 215         hbox = gtk_hbox_new(FALSE, 0);
 216         gtk_box_pack_start(GTK_BOX(vbox), hbox, TRUE, TRUE, 0);
 217         gtk_widget_show(hbox);
 218
 219         scrolled = gtk_scrolled_window_new(NULL, NULL);
 220         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
 221         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
 222                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 223         gtk_box_pack_start(GTK_BOX(hbox), scrolled, TRUE, TRUE, 0);
 224         gtk_widget_show(scrolled);
 225
 226         text = gtk_text_view_new();
 227         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 228         gtk_container_add(GTK_CONTAINER(scrolled), text);
 229         gtk_widget_show(text);
 230
 231         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 232         gtk_text_buffer_create_tag(buffer, "monospace",
 233                                    "family", "monospace", NULL);
 234
 235         hbox = gtk_hbutton_box_new();
 236         gtk_container_set_border_width(GTK_CONTAINER(hbox), PREF_PAD_BORDER);
 237         gtk_button_box_set_layout(GTK_BUTTON_BOX(hbox), GTK_BUTTONBOX_END);
 238         gtk_box_pack_end(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 239         gtk_widget_show(hbox);
 240
 241         button = gtk_button_new_from_stock(GTK_STOCK_CLOSE);
 242         g_signal_connect(G_OBJECT(button), "clicked",
 243                          G_CALLBACK(help_window_close), window);
 244         gtk_container_add(GTK_CONTAINER(hbox), button);
 245         gtk_widget_set_can_default(button, TRUE);
 246         gtk_widget_grab_default(button);
 247         gtk_widget_show(button);
 248
 249         g_object_set_data(G_OBJECT(window), "text_widget", text);
 250
 251         help_window_load_text(text, path);
 252
 253         gtk_widget_show(window);
 254
 255         help_window_scroll(text, key);
 256
 257         return window;
 258 }
 259
 260 GtkWidget *help_window_get_box(GtkWidget *window)
 261 {
 262         return g_object_get_data(G_OBJECT(window), "text_vbox");
 263 }
 264 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */