mirror of https://github.com/GNOME/gimp.git
libgimp/gimphelpui.[ch] added some not-yet-complete documentation.
2000-02-26 Michael Natterer <mitch@gimp.org> * libgimp/gimphelpui.[ch] * libgimp/gimpdialog.c: added some not-yet-complete documentation. 2000-02-26 Michael Natterer <mitch@gimp.org> * libgimp/libgimp-decl.txt * libgimp/libgimp-docs.sgml * libgimp/libgimp-sections.txt * libgimp/tmpl/gimp.sgml * libgimp/tmpl/gimpdialog.sgml * libgimp/tmpl/gimphelpui.sgml * libgimp/tmpl/gimpunit.sgml * libgimp/tmpl/gimpwidgets.sgml: updated.
This commit is contained in:
Michael Natterer
Michael Natterer
parent
6d92091fef
commit
882c240a38
|
|
@ -1,3 +1,8 @@
|
|||
2000-02-26 Michael Natterer <mitch@gimp.org>
|
||||
|
||||
* libgimp/gimphelpui.[ch]
|
||||
* libgimp/gimpdialog.c: added some not-yet-complete documentation.
|
||||
|
||||
Sat Feb 26 14:56:15 CET 2000 Sven Neumann <sven@gimp.org>
|
||||
|
||||
* plug-ins/common/exchange.c: implemented locking of threshold
|
||||
|
|
|
|||
|
|
@ -1,3 +1,14 @@
|
|||
2000-02-26 Michael Natterer <mitch@gimp.org>
|
||||
|
||||
* libgimp/libgimp-decl.txt
|
||||
* libgimp/libgimp-docs.sgml
|
||||
* libgimp/libgimp-sections.txt
|
||||
* libgimp/tmpl/gimp.sgml
|
||||
* libgimp/tmpl/gimpdialog.sgml
|
||||
* libgimp/tmpl/gimphelpui.sgml
|
||||
* libgimp/tmpl/gimpunit.sgml
|
||||
* libgimp/tmpl/gimpwidgets.sgml: updated.
|
||||
|
||||
Fri Feb 25 19:47:35 CET 2000 Sven Neumann <sven@gimp.org>
|
||||
|
||||
* libgimp/Makefile.am
|
||||
|
|
|
|||
|
|
@ -1438,6 +1438,16 @@ gchar *help_data
|
|||
<RETURNS>void </RETURNS>
|
||||
gchar *help_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>gimp_plugin_domain_add</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
gchar *domain_name
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>gimp_plugin_domain_add_with_path</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
gchar *domain_name,gchar *domain_path
|
||||
</FUNCTION>
|
||||
<MACRO>
|
||||
<NAME>GIMP_MAJOR_VERSION</NAME>
|
||||
#define GIMP_MAJOR_VERSION (1)
|
||||
|
|
@ -1538,7 +1548,7 @@ typedef enum
|
|||
<NAME>GimpChainButton</NAME>
|
||||
struct GimpChainButton
|
||||
{
|
||||
GtkTable table;
|
||||
GtkTable table;
|
||||
|
||||
GimpChainPosition position;
|
||||
GtkWidget *button;
|
||||
|
|
@ -3878,7 +3888,7 @@ GtkWidget *widget,GimpHelpFunc help_func,gchar *help_data
|
|||
<FUNCTION>
|
||||
<NAME>gimp_help_set_help_data</NAME>
|
||||
<RETURNS>void </RETURNS>
|
||||
GtkWidget *widget,const gchar *tool_tip,gchar *help_data
|
||||
GtkWidget *widget,const gchar *tooltip,gchar *help_data
|
||||
</FUNCTION>
|
||||
<FUNCTION>
|
||||
<NAME>gimp_context_help</NAME>
|
||||
|
|
|
|||
|
|
@ -54,6 +54,7 @@
|
|||
&libgimp-gimpenv;
|
||||
&libgimp-gimpmatrix;
|
||||
&libgimp-gimpprotocol;
|
||||
&libgimp-gimpunit;
|
||||
&libgimp-gimpvector;
|
||||
&libgimp-gimpwire;
|
||||
&libgimp-parasite;
|
||||
|
|
@ -76,7 +77,6 @@
|
|||
&libgimp-gimphelpui;
|
||||
&libgimp-gimpmenu;
|
||||
&libgimp-gimpquerybox;
|
||||
&libgimp-gimpunit;
|
||||
&libgimp-gimpwidgets;
|
||||
</chapter>
|
||||
|
||||
|
|
|
|||
|
|
@ -227,6 +227,8 @@ gimp_attach_new_parasite
|
|||
gimp_parasite_detach
|
||||
gimp_plugin_help_func
|
||||
gimp_help
|
||||
gimp_plugin_domain_add_with_path
|
||||
gimp_plugin_domain_add
|
||||
</SECTION>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2215,3 +2215,20 @@ gimp
|
|||
@help_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_plugin_domain_add_with_path ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@domain_name:
|
||||
@domain_path:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_plugin_domain_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@domain_name:
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -69,6 +69,61 @@ dialog-related stuff.
|
|||
<!-- ##### FUNCTION gimp_dialog_create_action_areav ##### -->
|
||||
<para>
|
||||
|
||||
The @va_list describing the action_area #GtkButton's has the following format:
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="4*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gchar *label,</entry>
|
||||
<entry>The button's label.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkSignalFunc callback,</entry>
|
||||
<entry>The callback which will be connected to the button's
|
||||
"clicked" signal</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gpointer data,</entry>
|
||||
<entry>The callback data which will be used in
|
||||
gtk_signal_connect(). If you pass #NULL, then the dialog itself will
|
||||
by passed as @data.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkObject *slot_object,</entry>
|
||||
<entry>If you pass a pointer other than #NULL, then the button's "clicked"
|
||||
signal will be connected with gtk_signal_connect_object() instead of
|
||||
gtk_signal_connect(). If you want the dialog itself to be the
|
||||
@slot_object, pass "1".</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget **widget_ptr,</entry>
|
||||
<entry>A pointer to store the created button in.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gboolean default_action,</entry>
|
||||
<entry>#TRUE if this button should grab the default dialog action with
|
||||
gtk_widget_grab_default().</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gboolean connect_delete,</entry>
|
||||
<entry>#TRUE if the dialog's "delete_event" should be connected to
|
||||
this button's callback. Usually you will connect to the dialog's
|
||||
"Cancel" callback. Note that the callback will be called indirectly,
|
||||
so you don't habe to worry about the #GdkEvent pointer which comes
|
||||
with the "delete_event", as it will be stripped away before your
|
||||
"Cancel" callback is called.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
|
||||
</para>
|
||||
|
||||
@dialog:
|
||||
|
|
|
|||
|
|
@ -75,8 +75,10 @@ system.
|
|||
</para>
|
||||
|
||||
@widget:
|
||||
@tool_tip:
|
||||
@tooltip:
|
||||
@help_data:
|
||||
<!-- # Unused Parameters # -->
|
||||
@tool_tip:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_context_help ##### -->
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GimpUnit
|
||||
gimpunit
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Provides a collection of predefined units and functions for creating
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ The @va_list describing the #GtkMenuItem's has the following format:
|
|||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gchar label,</entry>
|
||||
<entry>#gchar *label,</entry>
|
||||
<entry>The menu item's label.</entry>
|
||||
</row>
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ The @va_list describing the #GtkMenuItem's has the following format:
|
|||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gchar label,</entry>
|
||||
<entry>#gchar *label,</entry>
|
||||
<entry>The menu item's label.</entry>
|
||||
</row>
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ The @va_list describing the #GtkRadioButton's has the following format:
|
|||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gchar label,</entry>
|
||||
<entry>#gchar *label,</entry>
|
||||
<entry>The radio button's label.</entry>
|
||||
</row>
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ The @va_list describing the #GtkRadioButton's has the following format:
|
|||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gchar label,</entry>
|
||||
<entry>#gchar *label,</entry>
|
||||
<entry>The radio button's label.</entry>
|
||||
</row>
|
||||
|
||||
|
|
|
|||
|
|
@ -67,6 +67,31 @@ gimp_dialog_realize_callback (GtkWidget *widget,
|
|||
wilber_pixmap, wilber_mask);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_new:
|
||||
* @title: The dialog's title which will be set with gtk_window_set_title().
|
||||
* @wmclass_name: The dialog's @wmclass_name which will be set with
|
||||
* gtk_window_set_wmclass(). The @wmclass_class will be
|
||||
* automatically set to "Gimp".
|
||||
* @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.
|
||||
* @position: The dialog's initial position which will be set with
|
||||
* gtk_window_set_position().
|
||||
* @allow_shrink: The dialog's @allow_shrink flag, ...
|
||||
* @allow_grow: ... it't @allow_grow flag and ...
|
||||
* @auto_shrink: ... it's @auto_shrink flag which will all be set with
|
||||
* gtk_window_set_policy().
|
||||
* @...: A #NULL terminated @va_list destribing the action_area buttons.
|
||||
*
|
||||
* This function simply packs the action_area arguments passed in "..."
|
||||
* into a @va_list variable and passes everything to gimp_dialog_newv().
|
||||
*
|
||||
* For a description of the format of the @va_list describing the
|
||||
* action_area buttons see gimp_dialog_create_action_areav().
|
||||
*
|
||||
* Returns: A #GtkDialog.
|
||||
*
|
||||
*/
|
||||
GtkWidget *
|
||||
gimp_dialog_new (const gchar *title,
|
||||
const gchar *wmclass_name,
|
||||
|
|
@ -109,6 +134,32 @@ gimp_dialog_new (const gchar *title,
|
|||
return dialog;
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_newv:
|
||||
* @title: The dialog's title which will be set with gtk_window_set_title().
|
||||
* @wmclass_name: The dialog's @wmclass_name which will be set with
|
||||
* gtk_window_set_wmclass(). The @wmclass_class will be
|
||||
* automatically set to "Gimp".
|
||||
* @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.
|
||||
* @position: The dialog's initial position which will be set with
|
||||
* gtk_window_set_position().
|
||||
* @allow_shrink: The dialog's @allow_shrink flag, ...
|
||||
* @allow_grow: ... it't @allow_grow flag and ...
|
||||
* @auto_shrink: ... it's @auto_shrink flag which will all be set with
|
||||
* gtk_window_set_policy().
|
||||
* @args: A @va_list as obtained with va_start() describing the action_area
|
||||
* buttons.
|
||||
*
|
||||
* This function performs all neccessary setps to set up a standard GIMP
|
||||
* dialog.
|
||||
*
|
||||
* The @va_list describing the action_area buttons will be passed to
|
||||
* gimp_dialog_create_action_areav().
|
||||
*
|
||||
* Returns: A #GtkDialog.
|
||||
*
|
||||
*/
|
||||
GtkWidget *
|
||||
gimp_dialog_newv (const gchar *title,
|
||||
const gchar *wmclass_name,
|
||||
|
|
@ -126,8 +177,8 @@ gimp_dialog_newv (const gchar *title,
|
|||
g_return_val_if_fail (wmclass_name != NULL, NULL);
|
||||
|
||||
dialog = gtk_dialog_new ();
|
||||
gtk_window_set_wmclass (GTK_WINDOW (dialog), wmclass_name, "Gimp");
|
||||
gtk_window_set_title (GTK_WINDOW (dialog), title);
|
||||
gtk_window_set_wmclass (GTK_WINDOW (dialog), wmclass_name, "Gimp");
|
||||
gtk_window_set_position (GTK_WINDOW (dialog), position);
|
||||
gtk_window_set_policy (GTK_WINDOW (dialog),
|
||||
allow_shrink, allow_grow, auto_shrink);
|
||||
|
|
@ -142,6 +193,19 @@ gimp_dialog_newv (const gchar *title,
|
|||
return dialog;
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_set_icon:
|
||||
* @dialog: The #GtkWindow you want to set the pixmap icon for.
|
||||
*
|
||||
* This function sets the WM pixmap icon for the dialog which will appear
|
||||
* e.g. in GNOME's or KDE's window list.
|
||||
*
|
||||
* Note that this function is automatically called by
|
||||
* gimp_help_connect_help_accel() which in turn is called by
|
||||
* gimp_dialog_newv(), so you only have to call it for #GtkWindow's which
|
||||
* have no help page (like tear-off menus).
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_set_icon (GtkWindow *dialog)
|
||||
{
|
||||
|
|
@ -156,6 +220,16 @@ gimp_dialog_set_icon (GtkWindow *dialog)
|
|||
NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_create_action_area:
|
||||
* @dialog: The #GtkDialog you want to create the action_area for.
|
||||
* @...: A #NULL terminated @va_list destribing the action_area buttons.
|
||||
*
|
||||
* This function simply packs the action_area arguments passed in "..."
|
||||
* into a @va_list variable and passes everything to
|
||||
* gimp_dialog_create_action_areav().
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_create_action_area (GtkDialog *dialog,
|
||||
|
||||
|
|
@ -180,6 +254,13 @@ gimp_dialog_create_action_area (GtkDialog *dialog,
|
|||
va_end (args);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_create_action_areav:
|
||||
* @dialog: The #GtkDialog you want to create the action_area for.
|
||||
* @args: A @va_list as obtained with va_start() describing the action_area
|
||||
* buttons.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_create_action_areav (GtkDialog *dialog,
|
||||
va_list args)
|
||||
|
|
|
|||
|
|
@ -50,12 +50,28 @@ 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 menory used by the #GtkTooltips created by
|
||||
* gimp_help_init().
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_free (void)
|
||||
{
|
||||
|
|
@ -63,18 +79,38 @@ gimp_help_free (void)
|
|||
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.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_connect_help_accel (GtkWidget *widget,
|
||||
GimpHelpFunc help_func,
|
||||
|
|
@ -162,6 +198,13 @@ gimp_help_connect_help_accel (GtkWidget *widget,
|
|||
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.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_set_help_data (GtkWidget *widget,
|
||||
const gchar *tooltip,
|
||||
|
|
@ -176,6 +219,12 @@ gimp_help_set_help_data (GtkWidget *widget,
|
|||
gtk_object_set_data (GTK_OBJECT (widget), "gimp_help_data", help_data);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_context_help:
|
||||
*
|
||||
* This function invokes the #GtkTipsQuery tooltips inspector.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_context_help (void)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ void gimp_help_connect_help_accel (GtkWidget *widget,
|
|||
|
||||
/* set help data for non-window widgets */
|
||||
void gimp_help_set_help_data (GtkWidget *widget,
|
||||
const gchar *tool_tip,
|
||||
const gchar *tooltip,
|
||||
gchar *help_data);
|
||||
|
||||
/* activate the context help inspector */
|
||||
|
|
|
|||
|
|
@ -67,6 +67,31 @@ gimp_dialog_realize_callback (GtkWidget *widget,
|
|||
wilber_pixmap, wilber_mask);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_new:
|
||||
* @title: The dialog's title which will be set with gtk_window_set_title().
|
||||
* @wmclass_name: The dialog's @wmclass_name which will be set with
|
||||
* gtk_window_set_wmclass(). The @wmclass_class will be
|
||||
* automatically set to "Gimp".
|
||||
* @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.
|
||||
* @position: The dialog's initial position which will be set with
|
||||
* gtk_window_set_position().
|
||||
* @allow_shrink: The dialog's @allow_shrink flag, ...
|
||||
* @allow_grow: ... it't @allow_grow flag and ...
|
||||
* @auto_shrink: ... it's @auto_shrink flag which will all be set with
|
||||
* gtk_window_set_policy().
|
||||
* @...: A #NULL terminated @va_list destribing the action_area buttons.
|
||||
*
|
||||
* This function simply packs the action_area arguments passed in "..."
|
||||
* into a @va_list variable and passes everything to gimp_dialog_newv().
|
||||
*
|
||||
* For a description of the format of the @va_list describing the
|
||||
* action_area buttons see gimp_dialog_create_action_areav().
|
||||
*
|
||||
* Returns: A #GtkDialog.
|
||||
*
|
||||
*/
|
||||
GtkWidget *
|
||||
gimp_dialog_new (const gchar *title,
|
||||
const gchar *wmclass_name,
|
||||
|
|
@ -109,6 +134,32 @@ gimp_dialog_new (const gchar *title,
|
|||
return dialog;
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_newv:
|
||||
* @title: The dialog's title which will be set with gtk_window_set_title().
|
||||
* @wmclass_name: The dialog's @wmclass_name which will be set with
|
||||
* gtk_window_set_wmclass(). The @wmclass_class will be
|
||||
* automatically set to "Gimp".
|
||||
* @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.
|
||||
* @position: The dialog's initial position which will be set with
|
||||
* gtk_window_set_position().
|
||||
* @allow_shrink: The dialog's @allow_shrink flag, ...
|
||||
* @allow_grow: ... it't @allow_grow flag and ...
|
||||
* @auto_shrink: ... it's @auto_shrink flag which will all be set with
|
||||
* gtk_window_set_policy().
|
||||
* @args: A @va_list as obtained with va_start() describing the action_area
|
||||
* buttons.
|
||||
*
|
||||
* This function performs all neccessary setps to set up a standard GIMP
|
||||
* dialog.
|
||||
*
|
||||
* The @va_list describing the action_area buttons will be passed to
|
||||
* gimp_dialog_create_action_areav().
|
||||
*
|
||||
* Returns: A #GtkDialog.
|
||||
*
|
||||
*/
|
||||
GtkWidget *
|
||||
gimp_dialog_newv (const gchar *title,
|
||||
const gchar *wmclass_name,
|
||||
|
|
@ -126,8 +177,8 @@ gimp_dialog_newv (const gchar *title,
|
|||
g_return_val_if_fail (wmclass_name != NULL, NULL);
|
||||
|
||||
dialog = gtk_dialog_new ();
|
||||
gtk_window_set_wmclass (GTK_WINDOW (dialog), wmclass_name, "Gimp");
|
||||
gtk_window_set_title (GTK_WINDOW (dialog), title);
|
||||
gtk_window_set_wmclass (GTK_WINDOW (dialog), wmclass_name, "Gimp");
|
||||
gtk_window_set_position (GTK_WINDOW (dialog), position);
|
||||
gtk_window_set_policy (GTK_WINDOW (dialog),
|
||||
allow_shrink, allow_grow, auto_shrink);
|
||||
|
|
@ -142,6 +193,19 @@ gimp_dialog_newv (const gchar *title,
|
|||
return dialog;
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_set_icon:
|
||||
* @dialog: The #GtkWindow you want to set the pixmap icon for.
|
||||
*
|
||||
* This function sets the WM pixmap icon for the dialog which will appear
|
||||
* e.g. in GNOME's or KDE's window list.
|
||||
*
|
||||
* Note that this function is automatically called by
|
||||
* gimp_help_connect_help_accel() which in turn is called by
|
||||
* gimp_dialog_newv(), so you only have to call it for #GtkWindow's which
|
||||
* have no help page (like tear-off menus).
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_set_icon (GtkWindow *dialog)
|
||||
{
|
||||
|
|
@ -156,6 +220,16 @@ gimp_dialog_set_icon (GtkWindow *dialog)
|
|||
NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_create_action_area:
|
||||
* @dialog: The #GtkDialog you want to create the action_area for.
|
||||
* @...: A #NULL terminated @va_list destribing the action_area buttons.
|
||||
*
|
||||
* This function simply packs the action_area arguments passed in "..."
|
||||
* into a @va_list variable and passes everything to
|
||||
* gimp_dialog_create_action_areav().
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_create_action_area (GtkDialog *dialog,
|
||||
|
||||
|
|
@ -180,6 +254,13 @@ gimp_dialog_create_action_area (GtkDialog *dialog,
|
|||
va_end (args);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_dialog_create_action_areav:
|
||||
* @dialog: The #GtkDialog you want to create the action_area for.
|
||||
* @args: A @va_list as obtained with va_start() describing the action_area
|
||||
* buttons.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_dialog_create_action_areav (GtkDialog *dialog,
|
||||
va_list args)
|
||||
|
|
|
|||
|
|
@ -50,12 +50,28 @@ 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 menory used by the #GtkTooltips created by
|
||||
* gimp_help_init().
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_free (void)
|
||||
{
|
||||
|
|
@ -63,18 +79,38 @@ gimp_help_free (void)
|
|||
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.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_connect_help_accel (GtkWidget *widget,
|
||||
GimpHelpFunc help_func,
|
||||
|
|
@ -162,6 +198,13 @@ gimp_help_connect_help_accel (GtkWidget *widget,
|
|||
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.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_help_set_help_data (GtkWidget *widget,
|
||||
const gchar *tooltip,
|
||||
|
|
@ -176,6 +219,12 @@ gimp_help_set_help_data (GtkWidget *widget,
|
|||
gtk_object_set_data (GTK_OBJECT (widget), "gimp_help_data", help_data);
|
||||
}
|
||||
|
||||
/**
|
||||
* gimp_context_help:
|
||||
*
|
||||
* This function invokes the #GtkTipsQuery tooltips inspector.
|
||||
*
|
||||
*/
|
||||
void
|
||||
gimp_context_help (void)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ void gimp_help_connect_help_accel (GtkWidget *widget,
|
|||
|
||||
/* set help data for non-window widgets */
|
||||
void gimp_help_set_help_data (GtkWidget *widget,
|
||||
const gchar *tool_tip,
|
||||
const gchar *tooltip,
|
||||
gchar *help_data);
|
||||
|
||||
/* activate the context help inspector */
|
||||
|
|
|
|||
Loading…
Reference in New Issue