summaryrefslogtreecommitdiffstats
path: root/app/dialogs/tips-dialog.c
diff options
context:
space:
mode:
Diffstat (limited to 'app/dialogs/tips-dialog.c')
-rw-r--r--app/dialogs/tips-dialog.c289
1 files changed, 289 insertions, 0 deletions
diff --git a/app/dialogs/tips-dialog.c b/app/dialogs/tips-dialog.c
new file mode 100644
index 0000000..610938c
--- /dev/null
+++ b/app/dialogs/tips-dialog.c
@@ -0,0 +1,289 @@
+/* GIMP - The GNU 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 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/>.
+ */
+
+#include "config.h"
+
+#include <gegl.h>
+#include <gtk/gtk.h>
+
+#include "libgimpbase/gimpbase.h"
+#include "libgimpwidgets/gimpwidgets.h"
+
+#include "dialogs-types.h"
+
+#include "config/gimpguiconfig.h"
+
+#include "core/gimp.h"
+
+#include "widgets/gimphelp-ids.h"
+
+#include "tips-dialog.h"
+#include "tips-parser.h"
+
+#include "gimp-intl.h"
+
+enum
+{
+ RESPONSE_PREVIOUS = 1,
+ RESPONSE_NEXT = 2
+};
+
+
+/* eek, see bug 762279 */
+GtkLinkButtonUriFunc
+gtk_link_button_set_uri_hook (GtkLinkButtonUriFunc func,
+ gpointer data,
+ GDestroyNotify destroy);
+static void tips_uri_hook (GtkLinkButton *button,
+ const gchar *link_,
+ gpointer user_data);
+
+
+static void tips_dialog_set_tip (GimpTip *tip);
+static void tips_dialog_response (GtkWidget *dialog,
+ gint response);
+static void tips_dialog_destroy (GtkWidget *widget,
+ GimpGuiConfig *config);
+static void more_button_clicked (GtkWidget *button,
+ Gimp *gimp);
+
+
+static GtkWidget *tips_dialog = NULL;
+static GtkWidget *tip_label = NULL;
+static GtkWidget *more_button = NULL;
+static GList *tips = NULL;
+static GList *current_tip = NULL;
+
+
+GtkWidget *
+tips_dialog_create (Gimp *gimp)
+{
+ GimpGuiConfig *config;
+ GtkWidget *vbox;
+ GtkWidget *hbox;
+ GtkWidget *button;
+ GtkWidget *image;
+ gint tips_count;
+
+ g_return_val_if_fail (GIMP_IS_GIMP (gimp), NULL);
+
+ if (!tips)
+ {
+ GError *error = NULL;
+ GFile *file;
+
+ file = gimp_data_directory_file ("tips", "gimp-tips.xml", NULL);
+
+ tips = gimp_tips_from_file (file, &error);
+
+ if (! tips)
+ {
+ GimpTip *tip;
+
+ if (! error)
+ {
+ tip = gimp_tip_new (_("The GIMP tips file is empty!"), NULL);
+ }
+ else if (error->code == G_FILE_ERROR_NOENT)
+ {
+ tip = gimp_tip_new (_("The GIMP tips file appears to be "
+ "missing!"),
+ _("There should be a file called '%s'. "
+ "Please check your installation."),
+ gimp_file_get_utf8_name (file));
+ }
+ else
+ {
+ tip = gimp_tip_new (_("The GIMP tips file could not be parsed!"),
+ "%s", error->message);
+ }
+
+ tips = g_list_prepend (tips, tip);
+ }
+ else if (error)
+ {
+ g_printerr ("Error while parsing '%s': %s\n",
+ gimp_file_get_utf8_name (file), error->message);
+ }
+
+ g_clear_error (&error);
+ g_object_unref (file);
+ }
+
+ tips_count = g_list_length (tips);
+
+ config = GIMP_GUI_CONFIG (gimp->config);
+
+ if (config->last_tip_shown >= tips_count || config->last_tip_shown < 0)
+ config->last_tip_shown = 0;
+
+ current_tip = g_list_nth (tips, config->last_tip_shown);
+
+ if (tips_dialog)
+ return tips_dialog;
+
+ tips_dialog = gimp_dialog_new (_("GIMP Tip of the Day"),
+ "gimp-tip-of-the-day",
+ NULL, 0, NULL, NULL,
+ NULL);
+
+ button = gtk_dialog_add_button (GTK_DIALOG (tips_dialog),
+ _("_Previous Tip"), RESPONSE_PREVIOUS);
+ gtk_button_set_image (GTK_BUTTON (button),
+ gtk_image_new_from_icon_name (GIMP_ICON_GO_PREVIOUS,
+ GTK_ICON_SIZE_BUTTON));
+
+ button = gtk_dialog_add_button (GTK_DIALOG (tips_dialog),
+ _("_Next Tip"), RESPONSE_NEXT);
+ gtk_button_set_image (GTK_BUTTON (button),
+ gtk_image_new_from_icon_name (GIMP_ICON_GO_NEXT,
+ GTK_ICON_SIZE_BUTTON));
+
+ gtk_dialog_set_response_sensitive (GTK_DIALOG (tips_dialog),
+ RESPONSE_NEXT, tips_count > 1);
+ gtk_dialog_set_response_sensitive (GTK_DIALOG (tips_dialog),
+ RESPONSE_PREVIOUS, tips_count > 1);
+
+ g_signal_connect (tips_dialog, "response",
+ G_CALLBACK (tips_dialog_response),
+ NULL);
+ g_signal_connect (tips_dialog, "destroy",
+ G_CALLBACK (tips_dialog_destroy),
+ config);
+
+ vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);
+ gtk_container_set_border_width (GTK_CONTAINER (vbox), 12);
+ gtk_box_pack_start (GTK_BOX (gtk_dialog_get_content_area (GTK_DIALOG (tips_dialog))),
+ vbox, TRUE, TRUE, 0);
+ gtk_widget_show (vbox);
+
+ hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
+ gtk_container_set_border_width (GTK_CONTAINER (hbox), 6);
+ gtk_box_pack_start (GTK_BOX (vbox), hbox, TRUE, TRUE, 0);
+ gtk_widget_show (hbox);
+
+ vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 6);
+ gtk_box_pack_start (GTK_BOX (hbox), vbox, TRUE, TRUE, 0);
+ gtk_widget_show (vbox);
+
+ image = gtk_image_new_from_icon_name (GIMP_ICON_DIALOG_INFORMATION,
+ GTK_ICON_SIZE_DIALOG);
+ gtk_misc_set_alignment (GTK_MISC (image), 0.5, 0.0);
+ gtk_box_pack_start (GTK_BOX (hbox), image, FALSE, FALSE, 0);
+ gtk_widget_show (image);
+
+ gtk_container_set_focus_chain (GTK_CONTAINER (hbox), NULL);
+
+ tip_label = gtk_label_new (NULL);
+ gtk_label_set_selectable (GTK_LABEL (tip_label), TRUE);
+ gtk_label_set_justify (GTK_LABEL (tip_label), GTK_JUSTIFY_LEFT);
+ gtk_label_set_line_wrap (GTK_LABEL (tip_label), TRUE);
+ gtk_label_set_yalign (GTK_LABEL (tip_label), 0.0);
+ gtk_box_pack_start (GTK_BOX (vbox), tip_label, TRUE, TRUE, 0);
+ gtk_widget_show (tip_label);
+
+ hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
+ gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);
+ gtk_widget_show (hbox);
+
+ more_button = gtk_link_button_new_with_label ("https://docs.gimp.org/",
+ /* a link to the related section in the user manual */
+ _("Learn more"));
+ gtk_widget_show (more_button);
+ gtk_box_pack_start (GTK_BOX (hbox), more_button, FALSE, FALSE, 0);
+
+ /* this is deprecated but better than showing two URIs, see bug #762279 */
+ gtk_link_button_set_uri_hook (tips_uri_hook, NULL, NULL);
+
+ g_signal_connect (more_button, "clicked",
+ G_CALLBACK (more_button_clicked),
+ gimp);
+
+ tips_dialog_set_tip (current_tip->data);
+
+ return tips_dialog;
+}
+
+static void
+tips_dialog_destroy (GtkWidget *widget,
+ GimpGuiConfig *config)
+{
+ /* the last-shown-tip is saved in sessionrc */
+ config->last_tip_shown = g_list_position (tips, current_tip);
+
+ tips_dialog = NULL;
+ current_tip = NULL;
+
+ gimp_tips_free (tips);
+ tips = NULL;
+}
+
+static void
+tips_dialog_response (GtkWidget *dialog,
+ gint response)
+{
+ switch (response)
+ {
+ case RESPONSE_PREVIOUS:
+ current_tip = current_tip->prev ? current_tip->prev : g_list_last (tips);
+ tips_dialog_set_tip (current_tip->data);
+ break;
+
+ case RESPONSE_NEXT:
+ current_tip = current_tip->next ? current_tip->next : tips;
+ tips_dialog_set_tip (current_tip->data);
+ break;
+
+ default:
+ gtk_widget_destroy (dialog);
+ break;
+ }
+}
+
+static void
+tips_dialog_set_tip (GimpTip *tip)
+{
+ g_return_if_fail (tip != NULL);
+
+ gtk_label_set_markup (GTK_LABEL (tip_label), tip->text);
+
+ /* set the URI to unset the "visited" state */
+ gtk_link_button_set_uri (GTK_LINK_BUTTON (more_button),
+ "https://docs.gimp.org/");
+
+ gtk_widget_set_sensitive (more_button, tip->help_id != NULL);
+}
+
+static void
+more_button_clicked (GtkWidget *button,
+ Gimp *gimp)
+{
+ GimpTip *tip = current_tip->data;
+
+ g_signal_stop_emission_by_name (button, "clicked");
+
+ if (tip->help_id)
+ gimp_help (gimp, NULL, NULL, tip->help_id);
+}
+
+static void
+tips_uri_hook (GtkLinkButton *button,
+ const gchar *link_,
+ gpointer user_data)
+{
+ /* do nothing */
+}