Files
gimp/devel-docs/libgimpwidgets/tmpl/gimpunitmenu.sgml
Michael Natterer b4ad2ab05b configure.in devel-docs/Makefile.am devel-docs/libgimpcolor/*
2001-05-04  Michael Natterer  <mitch@gimp.org>

	* configure.in
	* devel-docs/Makefile.am
	* devel-docs/libgimpcolor/*
	* devel-docs/libgimpmath/*
	* devel-docs/libgimpwidgets/*: added new gtk-doc modules for
	libgimpcolor, libgimpmath and libgimpwidgets. Moved existing
	documentation from the old files to the new templates.

	* devel-docs/libgimp/*: regenerated all files and removed the
	stuff which is in the new modules now.

	* libgimpwidgets/gimpcolorarea.c
	* libgimpwidgets/gimpcolorbutton.[ch]: some documentation fixes.

	* po-libgimp/Makefile.in.in
	* po-plug-ins/Makefile.in.in
	* po-script-fu/Makefile.in.in: updated.
2001-05-04 20:39:29 +00:00

111 lines
1.9 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GimpUnitMenu
<!-- ##### SECTION Short_Description ##### -->
Widget for selecting a #GimpUnit.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget provides a #GtkOptionMenu which contains a list of #GimpUnit's.
</para>
<para>
You can specify the string that will be displayed for each unit by
passing a printf-like @format string to gimp_unit_menu_new().
</para>
<para>
The constructor also lets you choose if the menu should contain items
for GIMP_UNIT_PIXEL, GIMP_UNIT_PERCENT and a "More..." item which will
pop up a dialog for selecting user-defined units.
</para>
<para>
Whenever the user selects a unit from the menu or the dialog, the
"unit_changed" signal will be emitted.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnit
</para>
<para>
#GimpSizeEntry
</para>
<para>
gimp_coordinates_new()
</para>
<!-- ##### FUNCTION gimp_unit_menu_new ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="1*"><colspec colwidth="8*">
<tbody>
<row>
<entry>% f</entry>
<entry>Factor (how many units make up an inch)</entry>
</row>
<row>
<entry>% y</entry>
<entry>Symbol (e.g. "''" for GIMP_UNIT_INCH)</entry>
</row>
<row>
<entry>% a</entry>
<entry>Abbreviation</entry>
</row>
<row>
<entry>% s</entry>
<entry>Singular</entry>
</row>
<row>
<entry>% p</entry>
<entry>Plural</entry>
</row>
<row>
<entry>%%</entry>
<entry>Literal percent</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@format:
@unit:
@show_pixels:
@show_percent:
@show_custom:
@Returns:
<!-- ##### FUNCTION gimp_unit_menu_set_unit ##### -->
<para>
</para>
@gum:
@unit:
<!-- ##### FUNCTION gimp_unit_menu_get_unit ##### -->
<para>
</para>
@gum:
@Returns:
<!-- ##### SIGNAL GimpUnitMenu::unit-changed ##### -->
<para>
This signal is emitted whenever the user selects a #GimpUnit from the
#GimpUnitMenu.
</para>
@gimpunitmenu: the object which received the signal.