gimpunit.h 4.13 KB
Newer Older
1 2
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
3 4
 *
 * gimpunit.h
5
 * Copyright (C) 1999-2003 Michael Natterer <mitch@gimp.org>
6
 *
7
 * This library is free software: you can redistribute it and/or
Marc Lehmann's avatar
Marc Lehmann committed
8
 * modify it under the terms of the GNU Lesser General Public
9
 * License as published by the Free Software Foundation; either
10
 * version 3 of the License, or (at your option) any later version.
11 12 13 14
 *
 * 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
15
 * Lesser General Public License for more details.
16
 *
Marc Lehmann's avatar
Marc Lehmann committed
17
 * You should have received a copy of the GNU Lesser General Public
18 19
 * License along with this library.  If not, see
 * <http://www.gnu.org/licenses/>.
20 21
 */

22 23 24 25
#if !defined (__GIMP_BASE_H_INSIDE__) && !defined (GIMP_BASE_COMPILATION)
#error "Only <libgimpbase/gimpbase.h> can be included directly."
#endif

26 27
#ifndef __GIMP_UNIT_H__
#define __GIMP_UNIT_H__
28

29
G_BEGIN_DECLS
30

31 32
/* For information look into the C source or the html documentation */

33 34 35 36 37
/**
 * GIMP_TYPE_UNIT:
 *
 * #GIMP_TYPE_UNIT is a #GType derived from #G_TYPE_INT.
 **/
38

39 40 41
#define GIMP_TYPE_UNIT               (gimp_unit_get_type ())
#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))

42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
GType        gimp_unit_get_type      (void) G_GNUC_CONST;


/*
 * GIMP_TYPE_PARAM_UNIT
 */

#define GIMP_TYPE_PARAM_UNIT              (gimp_param_unit_get_type ())
#define GIMP_IS_PARAM_SPEC_UNIT(pspec)    (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))

GType        gimp_param_unit_get_type     (void) G_GNUC_CONST;

GParamSpec * gimp_param_spec_unit         (const gchar  *name,
                                           const gchar  *nick,
                                           const gchar  *blurb,
                                           gboolean      allow_pixels,
                                           gboolean      allow_percent,
                                           GimpUnit      default_value,
                                           GParamFlags   flags);

62

63

64 65
gint          gimp_unit_get_number_of_units          (void);
gint          gimp_unit_get_number_of_built_in_units (void) G_GNUC_CONST;
66

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
GimpUnit      gimp_unit_new                 (gchar       *identifier,
                                             gdouble      factor,
                                             gint         digits,
                                             gchar       *symbol,
                                             gchar       *abbreviation,
                                             gchar       *singular,
                                             gchar       *plural);

gboolean      gimp_unit_get_deletion_flag   (GimpUnit     unit);
void          gimp_unit_set_deletion_flag   (GimpUnit     unit,
                                             gboolean     deletion_flag);

gdouble       gimp_unit_get_factor          (GimpUnit     unit);

gint          gimp_unit_get_digits          (GimpUnit     unit);

const gchar * gimp_unit_get_identifier      (GimpUnit     unit);

const gchar * gimp_unit_get_symbol          (GimpUnit     unit);
const gchar * gimp_unit_get_abbreviation    (GimpUnit     unit);
const gchar * gimp_unit_get_singular        (GimpUnit     unit);
const gchar * gimp_unit_get_plural          (GimpUnit     unit);

gchar       * gimp_unit_format_string       (const gchar *format,
                                             GimpUnit     unit);

gdouble       gimp_pixels_to_units          (gdouble      pixels,
                                             GimpUnit     unit,
                                             gdouble      resolution);
gdouble       gimp_units_to_pixels          (gdouble      value,
                                             GimpUnit     unit,
                                             gdouble      resolution);
99 100 101
gdouble       gimp_units_to_points          (gdouble      value,
                                             GimpUnit     unit,
                                             gdouble      resolution);
102

103

104
G_END_DECLS
105

106
#endif /* __GIMP_UNIT_H__ */