gimp/libgimpbase/gimpunit.h
Sven Neumann 6a6dbd25fa Hopefully synced the work on real-world-units by applying (most of)
the patches Michael Natterer has provided.
Fixed a few minor and cosmetic bugs in those patches.


--Sven
1999-03-03 12:35:12 +00:00

113 lines
3.7 KiB
C

/* gimpunit.h
* Copyright (C) 1999 Michael Natterer <mitschel@cs.tu-berlin.de>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GIMPUNIT_H__
#define __GIMPUNIT_H__
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* I've put this here and not to libgimp/gimpenums.h, because if this
* file includes libgimp/gimpenums.h there is a name clash wherever
* someone includes libgimp/gimpunit.h and app/gimpimage.h
* (the constants RGB, GRAY and INDEXED are defined in both
* gimpenums.h and gimpimage.h) (is this a bug? don't know...)
*/
typedef enum
{
UNIT_PIXEL = 0,
UNIT_INCH = 1,
UNIT_CM = 2,
UNIT_POINT = 3,
UNIT_PICA = 4,
UNIT_END /* never use UNIT_END but gimp_unit_get_number_of_units() instead */
} GUnit;
gint gimp_unit_get_number_of_units (void);
gint gimp_unit_get_number_of_built_in_units (void);
/* create a new, empty user unit and returns it's ID
*/
GUnit gimp_unit_new (void);
/* the following functions fall back to inch (not pixel, as pixel is not
* a 'real' unit) if the value passed is out of range
*
* trying to change built-in units will be ignored
*/
/* if the deletion flag for a unit is TRUE on GIMP exit, this unit
* will not be saved in the user units database
*/
guint gimp_unit_get_deletion_flag (GUnit unit);
void gimp_unit_set_deletion_flag (GUnit unit,
guint deletion_flag);
/* the meaning of 'factor' is:
* distance_in_units == ( factor * distance_in_inches )
*
* returns 0 for unit == UNIT_PIXEL as we don't have resolution info here
*/
gfloat gimp_unit_get_factor (GUnit unit);
void gimp_unit_set_factor (GUnit unit,
gfloat factor);
/* the following function gives a hint how many digits a spinbutton
* should provide to get approximately the accuracy of an inch-spinbutton
* with two digits.
*
* returns 0 for unit == UNIT_PIXEL as we don't have resolution info here
*/
gint gimp_unit_get_digits (GUnit unit);
void gimp_unit_set_digits (GUnit unit,
gint digits);
/* this one is an untranslated string for gimprc */
const gchar * gimp_unit_get_identifier (GUnit unit);
void gimp_unit_set_identifier (GUnit unit,
gchar *identifier);
const gchar * gimp_unit_get_symbol (GUnit unit);
void gimp_unit_set_symbol (GUnit unit,
gchar *symbol);
const gchar * gimp_unit_get_abbreviation (GUnit unit);
void gimp_unit_set_abbreviation (GUnit unit,
gchar *abbreviation);
const gchar * gimp_unit_get_singular (GUnit unit);
void gimp_unit_set_singular (GUnit unit,
gchar *singular);
const gchar * gimp_unit_get_plural (GUnit unit);
void gimp_unit_set_plural (GUnit unit,
gchar *plural);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __GIMPUNIT_H__ */