gimp/libgimpwidgets/gimphelpui.h

/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimphelpui.h
 * Copyright (C) 2000-2003 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 3 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, see
 * <http://www.gnu.org/licenses/>.
 */

#if !defined (__GIMP_WIDGETS_H_INSIDE__) && !defined (GIMP_WIDGETS_COMPILATION)
#error "Only <libgimpwidgets/gimpwidgets.h> can be included directly."
#endif

#ifndef __GIMP_HELP_UI_H__
#define __GIMP_HELP_UI_H__

G_BEGIN_DECLS

/* For information look into the C source or the html documentation */


void   gimp_help_enable_tooltips           (void);
void   gimp_help_disable_tooltips          (void);

/*  the standard gimp help function
 */
void   gimp_standard_help_func             (const gchar  *help_id,
                                            gpointer      help_data);

/*  connect the help callback of a window  */
void   gimp_help_connect                   (GtkWidget    *widget,
                                            GimpHelpFunc  help_func,
                                            const gchar  *help_id,
                                            gpointer      help_data);

/*  set help data for non-window widgets  */
void   gimp_help_set_help_data             (GtkWidget    *widget,
                                            const gchar  *tooltip,
                                            const gchar  *help_id);

/*  set help data with markup for non-window widgets  */
void   gimp_help_set_help_data_with_markup (GtkWidget   *widget,
                                            const gchar *tooltip,
                                            const gchar *help_id);

/*  activate the context help inspector  */
void   gimp_context_help                   (GtkWidget    *widget);


/**
 * GIMP_HELP_ID:
 *
 * The #GQuark used to attach GIMP help IDs to widgets.
 *
 * Since: GIMP 2.2
 **/
#define GIMP_HELP_ID (gimp_help_id_quark ())

GQuark gimp_help_id_quark           (void) G_GNUC_CONST;


G_END_DECLS

#endif /* __GIMP_HELP_UI_H__ */