procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-04 17:59:37 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions
gimp/app/widgets/gimphelp.h

50 lines
1.7 KiB
C
Raw Normal View History

app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
/* The GIMP -- an image manipulation program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimphelp.h
* Copyright (C) 1999 Michael Natterer <mitch@gimp.org>
*
* 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.
*/
#ifndef __GIMP_HELP_H__
#define __GIMP_HELP_H__
app/brush_select.[ch] app/gradient.c app/gradient_select.[ch] 1999-11-03 Michael Natterer <mitch@gimp.org> * app/brush_select.[ch] * app/gradient.c * app/gradient_select.[ch] * app/interface.[ch] * app/palette.c * app/pattern_select.[ch]: allow dragging a brush/pattern/... from the selections with mouse2 without changing the active element in the dialog. * app/channels_dialog.c * app/color_area.c * app/color_panel.c * app/color_select.c * app/colormap_dialog.i.c * app/devices.c * app/gimpcontextpreview.[ch] * app/gimphelp.[ch] * app/gimpui.[ch] * app/indicator_area.c * app/interface.[ch] * app/layers_dialog.c * app/lc_dialog.c * app/ops_buttons.[ch] * app/paths_dialog.c * app/preferences_dialog.c * app/tools.[ch]: wrapped gtk_tooltips_set_tip() with gimp_help_set_help_data() and moved it to gimphelp.[ch]. This should (hopefully) be the final state of the help system. The New function allows a "private tip" to be set without a visible tooltip. This way the tooltips inspector (shift+F1) can search for help data in the parent containers of the clicked widget. E.g. the ops buttons in the layers dialog have private tips like "#new_layer" which gets composed with the help data of the layers dialog notebook page resulting in a complete help path. Allow mouse2 for all dnd operations. Mouse1 still works like before.
1999-11-03 09:58:46 +00:00
typedef void (* GimpHelpFunc) (gchar *);
app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
app/brush_select.[ch] app/gradient.c app/gradient_select.[ch] 1999-11-03 Michael Natterer <mitch@gimp.org> * app/brush_select.[ch] * app/gradient.c * app/gradient_select.[ch] * app/interface.[ch] * app/palette.c * app/pattern_select.[ch]: allow dragging a brush/pattern/... from the selections with mouse2 without changing the active element in the dialog. * app/channels_dialog.c * app/color_area.c * app/color_panel.c * app/color_select.c * app/colormap_dialog.i.c * app/devices.c * app/gimpcontextpreview.[ch] * app/gimphelp.[ch] * app/gimpui.[ch] * app/indicator_area.c * app/interface.[ch] * app/layers_dialog.c * app/lc_dialog.c * app/ops_buttons.[ch] * app/paths_dialog.c * app/preferences_dialog.c * app/tools.[ch]: wrapped gtk_tooltips_set_tip() with gimp_help_set_help_data() and moved it to gimphelp.[ch]. This should (hopefully) be the final state of the help system. The New function allows a "private tip" to be set without a visible tooltip. This way the tooltips inspector (shift+F1) can search for help data in the parent containers of the clicked widget. E.g. the ops buttons in the layers dialog have private tips like "#new_layer" which gets composed with the help data of the layers dialog notebook page resulting in a complete help path. Allow mouse2 for all dnd operations. Mouse1 still works like before.
1999-11-03 09:58:46 +00:00
void gimp_help_init (void);
void gimp_help_free (void);
void gimp_help_enable_tooltips (void);
void gimp_help_disable_tooltips (void);
app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
/* the standard help function */
app/brush_select.[ch] app/gradient.c app/gradient_select.[ch] 1999-11-03 Michael Natterer <mitch@gimp.org> * app/brush_select.[ch] * app/gradient.c * app/gradient_select.[ch] * app/interface.[ch] * app/palette.c * app/pattern_select.[ch]: allow dragging a brush/pattern/... from the selections with mouse2 without changing the active element in the dialog. * app/channels_dialog.c * app/color_area.c * app/color_panel.c * app/color_select.c * app/colormap_dialog.i.c * app/devices.c * app/gimpcontextpreview.[ch] * app/gimphelp.[ch] * app/gimpui.[ch] * app/indicator_area.c * app/interface.[ch] * app/layers_dialog.c * app/lc_dialog.c * app/ops_buttons.[ch] * app/paths_dialog.c * app/preferences_dialog.c * app/tools.[ch]: wrapped gtk_tooltips_set_tip() with gimp_help_set_help_data() and moved it to gimphelp.[ch]. This should (hopefully) be the final state of the help system. The New function allows a "private tip" to be set without a visible tooltip. This way the tooltips inspector (shift+F1) can search for help data in the parent containers of the clicked widget. E.g. the ops buttons in the layers dialog have private tips like "#new_layer" which gets composed with the help data of the layers dialog notebook page resulting in a complete help path. Allow mouse2 for all dnd operations. Mouse1 still works like before.
1999-11-03 09:58:46 +00:00
void gimp_standard_help_func (gchar *help_data);
app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
/* connect the "F1" accelerator of a window */
void gimp_help_connect_help_accel (GtkWidget *widget,
GimpHelpFunc help_func,
app/brush_select.[ch] app/gradient.c app/gradient_select.[ch] 1999-11-03 Michael Natterer <mitch@gimp.org> * app/brush_select.[ch] * app/gradient.c * app/gradient_select.[ch] * app/interface.[ch] * app/palette.c * app/pattern_select.[ch]: allow dragging a brush/pattern/... from the selections with mouse2 without changing the active element in the dialog. * app/channels_dialog.c * app/color_area.c * app/color_panel.c * app/color_select.c * app/colormap_dialog.i.c * app/devices.c * app/gimpcontextpreview.[ch] * app/gimphelp.[ch] * app/gimpui.[ch] * app/indicator_area.c * app/interface.[ch] * app/layers_dialog.c * app/lc_dialog.c * app/ops_buttons.[ch] * app/paths_dialog.c * app/preferences_dialog.c * app/tools.[ch]: wrapped gtk_tooltips_set_tip() with gimp_help_set_help_data() and moved it to gimphelp.[ch]. This should (hopefully) be the final state of the help system. The New function allows a "private tip" to be set without a visible tooltip. This way the tooltips inspector (shift+F1) can search for help data in the parent containers of the clicked widget. E.g. the ops buttons in the layers dialog have private tips like "#new_layer" which gets composed with the help data of the layers dialog notebook page resulting in a complete help path. Allow mouse2 for all dnd operations. Mouse1 still works like before.
1999-11-03 09:58:46 +00:00
gchar *help_data);
/* set help data for non-window widgets */
void gimp_help_set_help_data (GtkWidget *widget,
gchar *tool_tip,
gchar *help_data);
app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
/* the main help function */
app/brush_select.[ch] app/gradient.c app/gradient_select.[ch] 1999-11-03 Michael Natterer <mitch@gimp.org> * app/brush_select.[ch] * app/gradient.c * app/gradient_select.[ch] * app/interface.[ch] * app/palette.c * app/pattern_select.[ch]: allow dragging a brush/pattern/... from the selections with mouse2 without changing the active element in the dialog. * app/channels_dialog.c * app/color_area.c * app/color_panel.c * app/color_select.c * app/colormap_dialog.i.c * app/devices.c * app/gimpcontextpreview.[ch] * app/gimphelp.[ch] * app/gimpui.[ch] * app/indicator_area.c * app/interface.[ch] * app/layers_dialog.c * app/lc_dialog.c * app/ops_buttons.[ch] * app/paths_dialog.c * app/preferences_dialog.c * app/tools.[ch]: wrapped gtk_tooltips_set_tip() with gimp_help_set_help_data() and moved it to gimphelp.[ch]. This should (hopefully) be the final state of the help system. The New function allows a "private tip" to be set without a visible tooltip. This way the tooltips inspector (shift+F1) can search for help data in the parent containers of the clicked widget. E.g. the ops buttons in the layers dialog have private tips like "#new_layer" which gets composed with the help data of the layers dialog notebook page resulting in a complete help path. Allow mouse2 for all dnd operations. Mouse1 still works like before.
1999-11-03 09:58:46 +00:00
void gimp_help (gchar *help_data);
app/Makefile.am app/gimphelp.[ch] new files 1999-09-27 Michael Natterer <mitch@gimp.org> * app/Makefile.am * app/gimphelp.[ch] * app/gimpui.[ch]: new files * app/interface.[ch] * app/preferences_dialog.[ch] The GIMP Help System part 1: Press "F1" in any dialog to pop up the help page for this dialog. Moved the widget constructors from preferences_dialog.[ch] and the query boxes from interface.[ch] to gimpui.[ch]. The dialog constructors take a help_func and a help_data parameter and install the "F1" accelerator which emits the new "help" signal. The "help" signal callback calls help_func(help_data) which finally has to call gimp_help() which in turn invokes the help browser. Still have to find a proper way to (1) prevent "F1" being assigned to some menu item and (2) to catch "F1" while browsing the menu trees in order to pop up the help for the selected item. * app/menus.c: a <Toolbox>/File/Help... menu item. * app/commands.[ch]: a command callback for the "Help..." menu item. * app/gimprc.[ch]: new boolean gimprc variable "use_help". * app/info_dialog.[ch]: pass a help function and data to the info dialog constructor. * app/tools.[ch]: store the tools help page names in the tool info structure. Export a special tools_help_func() which shows the help page for the active tool. * app/[all files calling a dialog constructor]: pass the dialog's help page to the constructor. Most dialogs are now created by gimp_dialog_new() which also sets up the action_area and the WM delete event callback, so I removed the resp. code from these files. Fixed some minor bugs and did some other stuff but didn't change any logic except dialog creation. * plug-ins/helpbrowser/helpbrowser.c: don't try to call a running help browser and don't install any menu path (all done in app/gimphelp.[ch] now).
1999-09-27 17:58:10 +00:00
#endif /* __GIMP_HELP_H__ */
Reference in a new issue Copy permalink