gimp/devel-docs/libgimpwidgets/tmpl/gimpquerybox.sgml

180 lines
2.7 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
gimpquerybox
<!-- ##### SECTION Short_Description ##### -->
Some simple dialogs to enter a single int, double, string or boolean value.
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions provide simple dialogs for entering a single string,
integer, double, boolean or pixel size value.
</para>
<para>
They return a pointer to a #GtkDialog which has to be shown with
gtk_widget_show() by the caller.
</para>
<para>
The dialogs contain an entry widget for the kind of value they ask for
and "OK" and "Cancel" buttons. On "Cancel", all query boxes except the
boolean one silently destroy themselves. On "OK" the user defined
callback function is called and returns the entered value.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
GimpSizeEntry
</para>
<para>
GimpUnitMenu
</para>
<!-- ##### USER_FUNCTION GimpQueryStringCallback ##### -->
<para>
Note that you have to g_free() the returned string.
</para>
@query_box: The query box.
@string: The entered string.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryIntCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered integer value.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryDoubleCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered double value.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQuerySizeCallback ##### -->
<para>
</para>
@query_box: The query box.
@size: The entered size in pixels.
@unit: The selected unit from the #GimpUnitMenu.
@data: The user data.
<!-- ##### USER_FUNCTION GimpQueryBooleanCallback ##### -->
<para>
</para>
@query_box: The query box.
@value: The entered boolean value.
@data: The user data.
<!-- ##### FUNCTION gimp_query_string_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_int_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_double_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@digits:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_size_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@message:
@initial:
@lower:
@upper:
@digits:
@unit:
@resolution:
@dot_for_dot:
@object:
@signal:
@callback:
@data:
@Returns:
<!-- ##### FUNCTION gimp_query_boolean_box ##### -->
<para>
</para>
@title:
@help_func:
@help_data:
@eek:
@message:
@true_button:
@false_button:
@object:
@signal:
@callback:
@data:
@Returns: