app/* libgimp/* plug-ins/* did a global s/GUnit/GimpUnit/ and

2000-02-07  Michael Natterer  <mitch@gimp.org>

	* app/*
	* libgimp/*
	* plug-ins/*
	* tools/pdbgen/*: did a global s/GUnit/GimpUnit/ and
	s/GimpSizeEntryUP/GimpSizeEntryUpdatePolicy/

	* libgimp/gimpcolorspace.c: renamed the parameter names to match
	the names in the header.

	* libgimp/gimphelpui.h
	* libgimp/gimpimage.c
	* libgimp/gimpmatrix.h
	* libgimp/gimpsizeentry.[ch]
	* libgimp/gimpsizeentry.[ch]
	* libgimp/gimpunit.[ch]
	* libgimp/gimpunitmenu.[ch]
	* libgimp/gimpwidgets.[ch]: added documentation and use g* types
	all over the place (enables cross-referencing with the glib and
	gtk+ html documentation).

	* plug-ins/common/exchange.c
	* plug-ins/common/max_rgb.c: small cleanups.

	* plug-ins/common/mapcolor.c: the color buttons were attached in
	the wrong order.
This commit is contained in:
Michael Natterer
2000-02-07 20:35:13 +00:00
committed by Michael Natterer
parent 820c8f4109
commit ef17866973
138 changed files with 3876 additions and 3151 deletions

File diff suppressed because it is too large Load Diff

View File

@ -694,7 +694,7 @@ GIMP_IS_PATH_EDITOR_CLASS
<FILE>gimpsizeentry</FILE>
GimpSizeEntry
GIMP_SIZE_ENTRY
GimpSizeEntryUP
GimpSizeEntryUpdatePolicy
GimpSizeEntryField
<TITLE>GimpSizeEntry</TITLE>
gimp_size_entry_new
@ -795,7 +795,7 @@ gimp_gradient_close_popup
<SECTION>
<FILE>gimpunit</FILE>
GUnit
GimpUnit
gimp_unit_get_number_of_units
gimp_unit_get_number_of_built_in_units
gimp_unit_new

View File

@ -6,12 +6,17 @@ Widget for selecting a color.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget provides a simple button with a preview showing the color.
This widget provides a simple button with a preview showing the
color.
</para>
<para>
On click a GtkColorSelectionDialog is opened. Additionally the button
supports Drag and Drop and has a right-click menu that allows to choose
the color from the current FG or BG color. If the user changes the
color, the "color_changed" signal is emitted. Note that the color is
changed in place.
color, the "color_changed" signal is emitted.
</para>
<para>
Note that the color is changed in place.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -27,10 +32,11 @@ changed in place.
<!-- ##### MACRO GIMP_COLOR_BUTTON ##### -->
<para>
Checks if the passed pointer is a pointer to a #GimpColorButton and
performes the cast if valid.
</para>
@obj:
@obj: The pointer to cast.
<!-- ##### FUNCTION gimp_color_button_new ##### -->

View File

@ -11,7 +11,7 @@ GimpFileSelection
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpPathEditor
</para>
<!-- ##### STRUCT GimpFileSelection ##### -->
@ -25,7 +25,7 @@ GimpFileSelection
</para>
@obj:
@obj: The pointer to cast.
<!-- ##### FUNCTION gimp_file_selection_new ##### -->

View File

@ -19,6 +19,8 @@ gimphelpui
</para>
@help_data:
<!-- # Unused Parameters # -->
@Param1:

View File

@ -11,7 +11,7 @@ GimpPathEditor
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpFileSelection
</para>
<!-- ##### STRUCT GimpPathEditor ##### -->
@ -25,7 +25,7 @@ GimpPathEditor
</para>
@obj:
@obj: The pointer to cast.
<!-- ##### FUNCTION gimp_path_editor_new ##### -->

View File

@ -2,16 +2,41 @@
GimpSizeEntry
<!-- ##### SECTION Short_Description ##### -->
Widget for entering pixel values and resolutions.
<!-- ##### SECTION Long_Description ##### -->
<para>
This widget is used to enter pixel distances/sizes and resolutions.
</para>
<para>
You can specify the number of fields the widget should provide. For
each field automatic mappings are performed between the field's
"reference value" and it's "value".
</para>
<para>
There is a #GimpUnitMenu right of the entry fields which lets you
specify the #GimpUnit of the displayed values.
</para>
<para>
For each field, there can be one or two #GtkSpinButton's to enter
"value" and "reference value". If you specify @show_refval as #FALSE
in gimp_size_entry_new() there will be only one #GtkSpinButton and the
#GimpUnitMenu will contain an item for selecting GIMP_UNIT_PIXEL.
</para>
<para>
The "reference value" is either of GIMP_UNIT_PIXEL or dpi, depending
on which #GimpSizeEntryUpdatePolicy you specify in gimp_size_entry_new().
The "value" is either the size in pixels mapped to the size in a
real-world-unit (see #GimpUnit) or the dpi value mapped to pixels per
real-world-unit.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnit
</para>
<para>
#GimpUnitMenu
</para>
<!-- ##### STRUCT GimpSizeEntry ##### -->
@ -22,13 +47,14 @@ GimpSizeEntry
<!-- ##### MACRO GIMP_SIZE_ENTRY ##### -->
<para>
Checks if the passed pointer is a pointer to a #GimpSizeEntry and
performes the cast if valid.
</para>
@obj:
@obj: The pointer to cast.
<!-- ##### ENUM GimpSizeEntryUP ##### -->
<!-- ##### ENUM GimpSizeEntryUpdatePolicy ##### -->
<para>
</para>

View File

@ -1,8 +1,9 @@
<!-- ##### SECTION Title ##### -->
gimpunit
GimpUnit
<!-- ##### SECTION Short_Description ##### -->
Provides a collection of predefined units and functions for creating
user-defined units.
<!-- ##### SECTION Long_Description ##### -->
<para>
@ -11,21 +12,29 @@ gimpunit
<!-- ##### SECTION See_Also ##### -->
<para>
#GimpUnitMenu
</para>
<para>
#GimpSizeEntry
</para>
<!-- ##### ENUM GUnit ##### -->
<!-- ##### ENUM GimpUnit ##### -->
<para>
</para>
@UNIT_PIXEL:
@UNIT_INCH:
@UNIT_MM:
@UNIT_POINT:
@UNIT_PICA:
@UNIT_END:
@UNIT_PERCENT:
@GIMP_UNIT_PIXEL: This is a "pseudo unit" which needs a resolution to
be transformed into inches, millimeters etc.
@GIMP_UNIT_INCH: The GIMP base unit.
@GIMP_UNIT_MM: There are 25.4 millimeters in an inch.
@GIMP_UNIT_POINT: There are 72.0 points in an inch.
@GIMP_UNIT_PICA: There are 6.0 picas in an inch.
@GIMP_UNIT_END: This is an internal value. Please use
gimp_unit_get_number_of_built_in_units() instead.
@GIMP_UNIT_PERCENT: This is a "pseudo unit" which does not really
belong here. You can ask for it's strings but
asking for @factor, @digits or @deletion_flag fill
fail with an error.
<!-- ##### FUNCTION gimp_unit_get_number_of_units ##### -->
<para>

View File

@ -2,16 +2,32 @@
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>
<!-- ##### STRUCT GimpUnitMenu ##### -->
@ -22,15 +38,52 @@ GimpUnitMenu
<!-- ##### MACRO GIMP_UNIT_MENU ##### -->
<para>
Checks if the passed pointer is a pointer to a #GimpUnitMenu and
performes the cast if valid.
</para>
@obj:
@obj: The pointer to cast.
<!-- ##### 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:
@ -61,7 +114,8 @@ GimpUnitMenu
<!-- ##### 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.

View File

@ -0,0 +1,60 @@
<!-- ##### MACRO UNIT_MM ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### ENUM GimpSizeEntryUP ##### -->
<para>
The update policy determines how the #GimpSizeEntry will do the
automatic reference_value <-> value mapping.
</para>
@GIMP_SIZE_ENTRY_UPDATE_NONE: Don't do any automatic mapping.
@GIMP_SIZE_ENTRY_UPDATE_SIZE: Consider the values to be distances. The
reference value equals to pixels.
@GIMP_SIZE_ENTRY_UPDATE_RESOLUTION: Consider the values to be
resolutions. The reference value equals to dpi.
<!-- ##### MACRO UNIT_POINT ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO UNIT_PIXEL ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO UNIT_END ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO GUnit ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO UNIT_INCH ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO UNIT_PICA ##### -->
<para>
FIXME: Scheduled for removal.
</para>
<!-- ##### MACRO UNIT_PERCENT ##### -->
<para>
FIXME: Scheduled for removal.
</para>