mirror of https://github.com/GNOME/gimp.git
407 lines
11 KiB
C
407 lines
11 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* gimphelpui.c
|
|
* Copyright (C) 2000 Michael Natterer <mitch@gimp.org>
|
|
*
|
|
* 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 2 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
|
|
* Library 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, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
#include <gdk/gdkkeysyms.h>
|
|
#include <gtk/gtk.h>
|
|
|
|
#include "gimpdialog.h"
|
|
#include "gimphelpui.h"
|
|
|
|
/* external functions */
|
|
void gimp_help (gchar *help_data);
|
|
|
|
/* local function prototypes */
|
|
static void gimp_help_callback (GtkWidget *widget,
|
|
gpointer data);
|
|
static gint gimp_help_tips_query_idle_show_help (gpointer data);
|
|
static gint gimp_help_tips_query_widget_selected (GtkWidget *tips_query,
|
|
GtkWidget *widget,
|
|
const gchar *tip_text,
|
|
const gchar *tip_private,
|
|
GdkEventButton *event,
|
|
gpointer func_data);
|
|
static gint gimp_help_tips_query_idle_start (gpointer tips_query);
|
|
static void gimp_help_tips_query_start (GtkWidget *widget,
|
|
gpointer tips_query);
|
|
|
|
/* local variables */
|
|
static GtkTooltips * tool_tips = NULL;
|
|
static GtkWidget * tips_query = NULL;
|
|
|
|
/**********************/
|
|
/* public functions */
|
|
/**********************/
|
|
|
|
/**
|
|
* gimp_help_init:
|
|
*
|
|
* This function initializes GIMP's help system.
|
|
*
|
|
* Currently it only creates a #GtkTooltips object with gtk_tooltips_new()
|
|
* which will be used by gimp_help_set_help_data().
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_init (void)
|
|
{
|
|
tool_tips = gtk_tooltips_new ();
|
|
}
|
|
|
|
/**
|
|
* gimp_help_free:
|
|
*
|
|
* This function frees the memory used by the #GtkTooltips created by
|
|
* gimp_help_init().
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_free (void)
|
|
{
|
|
gtk_object_destroy (GTK_OBJECT (tool_tips));
|
|
gtk_object_unref (GTK_OBJECT (tool_tips));
|
|
}
|
|
|
|
/**
|
|
* gimp_help_enable_tooltips:
|
|
*
|
|
* This function calls gtk_tooltips_enable().
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_enable_tooltips (void)
|
|
{
|
|
gtk_tooltips_enable (tool_tips);
|
|
}
|
|
|
|
/**
|
|
* gimp_help_disable_tooltips:
|
|
*
|
|
* This function calls gtk_tooltips_disable().
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_disable_tooltips (void)
|
|
{
|
|
gtk_tooltips_disable (tool_tips);
|
|
}
|
|
|
|
/**
|
|
* gimp_help_connect_help_accel:
|
|
* @widget: The widget you want to connect the help accelerator for. Will
|
|
* be a #GtkWindow in most cases.
|
|
* @help_func: The function which will be called if the user presses "F1".
|
|
* @help_data: The data pointer which will be passed to @help_func.
|
|
*
|
|
* Note that this function is automatically called by all libgimp dialog
|
|
* constructors. You only have to call it for windows/dialogs you created
|
|
* "manually".
|
|
*
|
|
* For convenience, gimp_help_connect_help_accel() calls
|
|
* gimp_dialog_set_icon() if the passed widget is a #GtkWindow, so you
|
|
* don't have to worry about this.
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_connect_help_accel (GtkWidget *widget,
|
|
GimpHelpFunc help_func,
|
|
gchar *help_data)
|
|
{
|
|
GtkAccelGroup *accel_group;
|
|
|
|
if (!help_func)
|
|
return;
|
|
|
|
/* for convenience we set the wm icon here because
|
|
* this function is called for almost all gimp windows
|
|
*/
|
|
if (GTK_IS_WINDOW (widget))
|
|
gimp_dialog_set_icon (GTK_WINDOW (widget));
|
|
|
|
/* set up the help signals and tips query widget */
|
|
if (!tips_query)
|
|
{
|
|
tips_query = gtk_tips_query_new ();
|
|
|
|
gtk_widget_set (tips_query,
|
|
"GtkTipsQuery::emit_always", TRUE,
|
|
NULL);
|
|
|
|
gtk_signal_connect (GTK_OBJECT (tips_query), "widget_selected",
|
|
GTK_SIGNAL_FUNC (gimp_help_tips_query_widget_selected),
|
|
NULL);
|
|
|
|
/* FIXME: EEEEEEEEEEEEEEEEEEEEK, this is very ugly and forbidden...
|
|
* does anyone know a way to do this tips query stuff without
|
|
* having to attach to some parent widget???
|
|
*/
|
|
tips_query->parent = widget;
|
|
gtk_widget_realize (tips_query);
|
|
}
|
|
|
|
if (! gtk_signal_lookup ("tips_query", GTK_OBJECT (widget)->klass->type))
|
|
{
|
|
gtk_object_class_user_signal_new (GTK_OBJECT (widget)->klass,
|
|
"tips_query",
|
|
GTK_RUN_LAST,
|
|
gtk_signal_default_marshaller,
|
|
GTK_TYPE_NONE,
|
|
0,
|
|
NULL);
|
|
|
|
gtk_object_class_user_signal_new (GTK_OBJECT (widget)->klass,
|
|
"help",
|
|
GTK_RUN_LAST,
|
|
gtk_signal_default_marshaller,
|
|
GTK_TYPE_NONE,
|
|
0,
|
|
NULL);
|
|
}
|
|
|
|
gimp_help_set_help_data (widget, NULL, help_data);
|
|
|
|
gtk_signal_connect (GTK_OBJECT (widget), "help",
|
|
GTK_SIGNAL_FUNC (gimp_help_callback),
|
|
(gpointer) help_func);
|
|
|
|
gtk_signal_connect (GTK_OBJECT (widget), "tips_query",
|
|
GTK_SIGNAL_FUNC (gimp_help_tips_query_start),
|
|
(gpointer) tips_query);
|
|
|
|
gtk_widget_add_events (widget, GDK_BUTTON_PRESS_MASK);
|
|
|
|
/* a new accelerator group for this widget */
|
|
accel_group = gtk_accel_group_new ();
|
|
|
|
/* FIXME: does not work for some reason...
|
|
gtk_widget_add_accelerator (widget, "help", accel_group,
|
|
GDK_F1, 0, GTK_ACCEL_LOCKED);
|
|
gtk_widget_add_accelerator (widget, "tips_query", accel_group,
|
|
GDK_F1, GDK_SHIFT_MASK, GTK_ACCEL_LOCKED);
|
|
*/
|
|
|
|
/* ...while using this internal stuff works */
|
|
gtk_accel_group_add (accel_group, GDK_F1, 0, 0,
|
|
GTK_OBJECT (widget), "help");
|
|
gtk_accel_group_add (accel_group, GDK_F1, GDK_SHIFT_MASK, 0,
|
|
GTK_OBJECT (widget), "tips_query");
|
|
|
|
gtk_accel_group_attach (accel_group, GTK_OBJECT (widget));
|
|
}
|
|
|
|
/**
|
|
* gimp_help_set_help_data:
|
|
* @widget: The #GtkWidget you want to set a @tooltip and/or @help_data for.
|
|
* @tooltip: The text for this widget's tooltip.
|
|
* @help_data: The @help_data for the #GtkTipsQuery tooltips inspector.
|
|
*
|
|
* The reason why we don't use gtk_tooltips_set_tip() is that it's
|
|
* impossible to set a @private_tip (aka @help_data) without a visible
|
|
* @tooltip.
|
|
*
|
|
* This function can be called with @tooltip == #NULL. Use this feature
|
|
* if you want to set a HTML help link for a widget which shouldn't have
|
|
* a visible tooltip.
|
|
*
|
|
* You can e.g. set a @help_data string to a complete HTML page for a
|
|
* container widget (e.g. a #GtkBox). For the widgets inside the box
|
|
* you can set HTML anchors which point inside the container widget's
|
|
* help page by setting @help_data strings starting with "#".
|
|
*
|
|
* If the tooltips inspector (Shift + "F1") is invoked and the user
|
|
* clicks on one of the widgets which only contain a "#" link, the
|
|
* help system will automatically ascend the widget hierarchy until it
|
|
* finds another widget with @help_data attached and concatenates both
|
|
* to a complete help path.
|
|
*
|
|
*/
|
|
void
|
|
gimp_help_set_help_data (GtkWidget *widget,
|
|
const gchar *tooltip,
|
|
gchar *help_data)
|
|
{
|
|
g_return_if_fail (widget != NULL);
|
|
g_return_if_fail (GTK_IS_WIDGET (widget));
|
|
|
|
if (tooltip)
|
|
gtk_tooltips_set_tip (tool_tips, widget, tooltip, help_data);
|
|
else if (help_data)
|
|
gtk_object_set_data (GTK_OBJECT (widget), "gimp_help_data", help_data);
|
|
}
|
|
|
|
/**
|
|
* gimp_context_help:
|
|
*
|
|
* This function invokes the #GtkTipsQuery tooltips inspector.
|
|
*
|
|
* The mouse cursor will turn turn into a question mark and the user can
|
|
* click on any widget of the application which started the inspector.
|
|
*
|
|
* If the widget the user clicked on has a @help_data string attached
|
|
* (see gimp_help_set_help_data()), the corresponding HTML page will
|
|
* be displayed. Otherwise the help system will ascend the widget hierarchy
|
|
* until it finds an attached @help_data string (which should be the
|
|
* case at least for every window/dialog).
|
|
*
|
|
*/
|
|
void
|
|
gimp_context_help (void)
|
|
{
|
|
if (tips_query)
|
|
gimp_help_tips_query_start (NULL, tips_query);
|
|
}
|
|
|
|
/*********************/
|
|
/* local functions */
|
|
/*********************/
|
|
|
|
static void
|
|
gimp_help_callback (GtkWidget *widget,
|
|
gpointer data)
|
|
{
|
|
GimpHelpFunc help_function;
|
|
gchar *help_data;
|
|
|
|
help_function = (GimpHelpFunc) data;
|
|
help_data = (gchar *) gtk_object_get_data (GTK_OBJECT (widget),
|
|
"gimp_help_data");
|
|
|
|
if (help_function)
|
|
(* help_function) (help_data);
|
|
}
|
|
|
|
/* Do all the actual GtkTipsQuery calls in idle functions and check for
|
|
* some widget holding a grab before starting the query because strange
|
|
* things happen if (1) the help browser pops up while the query has
|
|
* grabbed the pointer or (2) the query grabs the pointer while some
|
|
* other part of the gimp has grabbed it (e.g. a tool, eek)
|
|
*/
|
|
|
|
static gint
|
|
gimp_help_tips_query_idle_show_help (gpointer data)
|
|
{
|
|
GtkWidget *event_widget;
|
|
GtkWidget *toplevel_widget;
|
|
GtkWidget *widget;
|
|
|
|
GtkTooltipsData *tooltips_data;
|
|
|
|
gchar *help_data = NULL;
|
|
|
|
event_widget = GTK_WIDGET (data);
|
|
toplevel_widget = gtk_widget_get_toplevel (event_widget);
|
|
|
|
/* search for help_data in this widget's parent containers */
|
|
for (widget = event_widget; widget; widget = widget->parent)
|
|
{
|
|
if ((tooltips_data = gtk_tooltips_data_get (widget)) &&
|
|
tooltips_data->tip_private)
|
|
{
|
|
help_data = tooltips_data->tip_private;
|
|
}
|
|
else
|
|
{
|
|
help_data = (gchar *) gtk_object_get_data (GTK_OBJECT (widget),
|
|
"gimp_help_data");
|
|
}
|
|
|
|
if (help_data || widget == toplevel_widget)
|
|
break;
|
|
}
|
|
|
|
if (! help_data)
|
|
return FALSE;
|
|
|
|
if (help_data[0] == '#')
|
|
{
|
|
gchar *help_index;
|
|
|
|
if (widget == toplevel_widget)
|
|
return FALSE;
|
|
|
|
help_index = help_data;
|
|
help_data = NULL;
|
|
|
|
for (widget = widget->parent; widget; widget = widget->parent)
|
|
{
|
|
if ((tooltips_data = gtk_tooltips_data_get (widget)) &&
|
|
tooltips_data->tip_private)
|
|
{
|
|
help_data = tooltips_data->tip_private;
|
|
}
|
|
else
|
|
{
|
|
help_data = (gchar *) gtk_object_get_data (GTK_OBJECT (widget),
|
|
"gimp_help_data");
|
|
}
|
|
|
|
if (help_data)
|
|
break;
|
|
}
|
|
|
|
if (help_data)
|
|
{
|
|
gchar *help_text;
|
|
|
|
help_text = g_strconcat (help_data, help_index, NULL);
|
|
gimp_help (help_text);
|
|
g_free (help_text);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
gimp_help (help_data);
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
static gint
|
|
gimp_help_tips_query_widget_selected (GtkWidget *tips_query,
|
|
GtkWidget *widget,
|
|
const gchar *tip_text,
|
|
const gchar *tip_private,
|
|
GdkEventButton *event,
|
|
gpointer func_data)
|
|
{
|
|
if (widget)
|
|
gtk_idle_add ((GtkFunction) gimp_help_tips_query_idle_show_help,
|
|
(gpointer) widget);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gint
|
|
gimp_help_tips_query_idle_start (gpointer tips_query)
|
|
{
|
|
if (! gtk_grab_get_current ())
|
|
gtk_tips_query_start_query (GTK_TIPS_QUERY (tips_query));
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
static void
|
|
gimp_help_tips_query_start (GtkWidget *widget,
|
|
gpointer tips_query)
|
|
{
|
|
if (! GTK_TIPS_QUERY (tips_query)->in_query)
|
|
gtk_idle_add ((GtkFunction) gimp_help_tips_query_idle_start, tips_query);
|
|
}
|