| GIMP Widgets Library Reference Manual | |||
|---|---|---|---|
| <<< Previous Page | Home | Up | Next Page >>> |
enum GimpSizeEntryUpdatePolicy; struct GimpButton; struct GimpChainButton; struct GimpColorArea; struct GimpColorButton; struct GimpFileSelection; struct GimpOffsetArea; struct GimpPathEditor; struct GimpPixmap; struct GimpSizeEntry; struct GimpUnitMenu; void (*GimpHelpFunc) (const gchar *help_data); |
typedef enum
{
GIMP_SIZE_ENTRY_UPDATE_NONE = 0,
GIMP_SIZE_ENTRY_UPDATE_SIZE = 1,
GIMP_SIZE_ENTRY_UPDATE_RESOLUTION = 2
} GimpSizeEntryUpdatePolicy; |
struct GimpColorArea
{
GtkDrawingArea parent_instance;
/*< private >*/
guchar *buf;
guint width;
guint height;
guint rowstride;
GimpColorAreaType type;
GimpRGB color;
guint idle_id;
}; |
struct GimpOffsetArea
{
GtkDrawingArea parent_instance;
gint orig_width;
gint orig_height;
gint width;
gint height;
gint offset_x;
gint offset_y;
gdouble display_ratio_x;
gdouble display_ratio_y;
}; |
void (*GimpHelpFunc) (const gchar *help_data); |
This is the prototype for all functions you pass as help_func to the various GIMP dialog constructors like gimp_dialog_new(), gimp_query_int_box() etc.
Note that all help paths are relative to the root of the help system in the current language. So if your language is "C", a help path of "filters/foo_bar.html" will expand to "${gimp_data_dir}/help/C/filters/foo_bar.html".
All these functions finally call gimp_help_connect_help_accel() which does the work of installing the "F1" accelerator.
In most cases it will be ok to use gimp_plugin_help_func() which does nothing but passing the help_data string to gimp_help(). If your plug-in needs some more sophisticated help handling you can provide your own help_func which has to call gimp_help() to actually display the help.