gimpconfig-params.h 10.7 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2 3 4 5 6
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * ParamSpecs for config objects
 * Copyright (C) 2001  Sven Neumann <sven@gimp.org>
 *
7
 * This library is free software: you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 3 of the License, or (at your option) any later version.
11
 *
12
 * This library is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
16
 *
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_CONFIG_H_INSIDE__) && !defined (GIMP_CONFIG_COMPILATION)
#error "Only <libgimpconfig/gimpconfig.h> can be included directly."
#endif

26 27 28
#ifndef __GIMP_CONFIG_PARAMS_H__
#define __GIMP_CONFIG_PARAMS_H__

29 30 31 32
G_BEGIN_DECLS

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

33

34 35 36 37 38 39 40 41 42
/**
 * SECTION: gimpconfig-params
 * @title: GimpConfig-params
 * @short_description: Macros and defines to install config properties.
 *
 * Macros and defines to install config properties.
 **/


43
/*
44 45 46 47 48 49 50 51 52 53 54
 * GIMP_CONFIG_PARAM_SERIALIZE - A property that can and should be
 *                               serialized and deserialized.
 * GIMP_CONFIG_PARAM_AGGREGATE - The object property is to be treated as
 *                               part of the parent object.
 * GIMP_CONFIG_PARAM_RESTART   - Changes to this property take effect only
 *                               after a restart.
 * GIMP_CONFIG_PARAM_CONFIRM   - Changes to this property should be
 *                               confirmed by the user before being applied.
 * GIMP_CONFIG_PARAM_DEFAULTS  - Don't serialize this property if it has the
 *                               default value.
 * GIMP_CONFIG_PARAM_IGNORE    - This property exists for obscure reasons
55
 *                               or is needed for backward compatibility.
56
 *                               Ignore the value read and don't serialize it.
57 58
 */

59 60 61 62 63 64
#define GIMP_CONFIG_PARAM_SERIALIZE    (1 << (0 + G_PARAM_USER_SHIFT))
#define GIMP_CONFIG_PARAM_AGGREGATE    (1 << (1 + G_PARAM_USER_SHIFT))
#define GIMP_CONFIG_PARAM_RESTART      (1 << (2 + G_PARAM_USER_SHIFT))
#define GIMP_CONFIG_PARAM_CONFIRM      (1 << (3 + G_PARAM_USER_SHIFT))
#define GIMP_CONFIG_PARAM_DEFAULTS     (1 << (4 + G_PARAM_USER_SHIFT))
#define GIMP_CONFIG_PARAM_IGNORE       (1 << (5 + G_PARAM_USER_SHIFT))
65 66 67

#define GIMP_CONFIG_PARAM_FLAGS (G_PARAM_READWRITE | \
                                 G_PARAM_CONSTRUCT | \
68
                                 GIMP_CONFIG_PARAM_SERIALIZE)
69 70


71

72 73
/* some convenience macros to install object properties */

74
#define GIMP_CONFIG_PROP_BOOLEAN(class, id, name, nick, blurb, default, flags) \
75
  g_object_class_install_property (class, id,\
76
                                   g_param_spec_boolean (name, nick, blurb,\
77
                                   default,\
78
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
79

80
#define GIMP_CONFIG_PROP_INT(class, id, name, nick, blurb, min, max, default, flags) \
81
  g_object_class_install_property (class, id,\
82 83
                                   g_param_spec_int (name, nick, blurb,\
                                   min, max, default,\
84
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
85

86
#define GIMP_CONFIG_PROP_UINT(class, id, name, nick, blurb, min, max, default, flags) \
87
  g_object_class_install_property (class, id,\
88
                                   g_param_spec_uint (name, nick, blurb,\
89
                                   min, max, default,\
90
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
91

92
#define GIMP_CONFIG_PROP_UNIT(class, id, name, nick, blurb, pixels, percent, default, flags) \
93
  g_object_class_install_property (class, id,\
94 95
                                   gimp_param_spec_unit (name, nick, blurb,\
                                   pixels, percent, default,\
96
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
97

98
#define GIMP_CONFIG_PROP_MEMSIZE(class, id, name, nick, blurb, min, max, default, flags) \
99
  g_object_class_install_property (class, id,\
100 101
                                   gimp_param_spec_memsize (name, nick, blurb,\
                                   min, max, default,\
102
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
103

104
#define GIMP_CONFIG_PROP_DOUBLE(class, id, name, nick, blurb, min, max, default, flags) \
105
  g_object_class_install_property (class, id,\
106
                                   g_param_spec_double (name, nick, blurb,\
107
                                   min, max, default,\
108
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
109

110
#define GIMP_CONFIG_PROP_RESOLUTION(class, id, name, nick, blurb, default, flags) \
111
  g_object_class_install_property (class, id,\
112 113
                                   g_param_spec_double (name, nick, blurb,\
                                   GIMP_MIN_RESOLUTION, GIMP_MAX_RESOLUTION, \
114 115
                                   default,\
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
116

117
#define GIMP_CONFIG_PROP_ENUM(class, id, name, nick, blurb, enum_type, default, flags) \
118
  g_object_class_install_property (class, id,\
119 120
                                   g_param_spec_enum (name, nick, blurb,\
                                   enum_type, default,\
121
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
122

123
#define GIMP_CONFIG_PROP_STRING(class, id, name, nick, blurb, default, flags) \
124
  g_object_class_install_property (class, id,\
125 126
                                   g_param_spec_string (name, nick, blurb,\
                                   default,\
127
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
128

129
#define GIMP_CONFIG_PROP_PATH(class, id, name, nick, blurb, path_type, default, flags) \
130
  g_object_class_install_property (class, id,\
131 132
                                   gimp_param_spec_config_path (name, nick, blurb,\
                                   path_type, default,\
133
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
134

135
#define GIMP_CONFIG_PROP_RGB(class, id, name, nick, blurb, has_alpha, default, flags) \
136
  g_object_class_install_property (class, id,\
137 138
                                   gimp_param_spec_rgb (name, nick, blurb,\
                                   has_alpha, default, \
139
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
140

141
#define GIMP_CONFIG_PROP_MATRIX2(class, id, name, nick, blurb, default, flags) \
142
  g_object_class_install_property (class, id,\
143 144
                                   gimp_param_spec_matrix2 (name, nick, blurb,\
                                   default,\
145
                                   flags | GIMP_CONFIG_PARAM_FLAGS))
146 147


148
/*  object, boxed and pointer properties are _not_ G_PARAM_CONSTRUCT  */
149

150
#define GIMP_CONFIG_PROP_OBJECT(class, id, name, nick, blurb, object_type, flags) \
151
  g_object_class_install_property (class, id,\
152
                                   g_param_spec_object (name, nick, blurb,\
153 154
                                   object_type,\
                                   flags |\
155 156
                                   G_PARAM_READWRITE |\
                                   GIMP_CONFIG_PARAM_SERIALIZE))
157

158
#define GIMP_CONFIG_PROP_BOXED(class, id, name, nick, blurb, boxed_type, flags) \
159
  g_object_class_install_property (class, id,\
160
                                   g_param_spec_boxed (name, nick, blurb,\
161 162 163 164 165
                                   boxed_type,\
                                   flags |\
                                   G_PARAM_READWRITE |\
                                   GIMP_CONFIG_PARAM_SERIALIZE))

166
#define GIMP_CONFIG_PROP_POINTER(class, id, name, nick, blurb, flags)    \
167
  g_object_class_install_property (class, id,\
168
                                   g_param_spec_pointer (name, nick, blurb,\
169
                                   flags |\
170 171
                                   G_PARAM_READWRITE |\
                                   GIMP_CONFIG_PARAM_SERIALIZE))
172

173

174 175
/*  deprecated macros, they all lack the "nick" parameter  */

176 177
#ifndef GIMP_DISABLE_DEPRECATED

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
#define GIMP_CONFIG_INSTALL_PROP_BOOLEAN(class, id, name, blurb, default, flags) \
  GIMP_CONFIG_PROP_BOOLEAN(class, id, name, NULL, blurb, default, flags);

#define GIMP_CONFIG_INSTALL_PROP_INT(class, id, name, blurb, min, max, default, flags) \
  GIMP_CONFIG_PROP_INT(class, id, name, NULL, blurb, min, max, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_UINT(class, id, name, blurb, min, max, default, flags) \
  GIMP_CONFIG_PROP_UINT(class, id, name, NULL, blurb, min, max, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_UNIT(class, id, name, blurb, pixels, percent, default, flags) \
  GIMP_CONFIG_PROP_UNIT(class, id, name, NULL, blurb, pixels, percent, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_MEMSIZE(class, id, name, blurb, min, max, default, flags) \
  GIMP_CONFIG_PROP_MEMSIZE(class, id, name, NULL, blurb, min, max, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_DOUBLE(class, id, name, blurb, min, max, default, flags) \
  GIMP_CONFIG_PROP_DOUBLE(class, id, name, NULL, blurb, min, max, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_RESOLUTION(class, id, name, blurb, default, flags) \
  GIMP_CONFIG_PROP_RESOLUTION(class, id, name, NULL, blurb, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_ENUM(class, id, name, blurb, enum_type, default, flags) \
  GIMP_CONFIG_PROP_ENUM(class, id, name, NULL, blurb, enum_type, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_STRING(class, id, name, blurb, default, flags) \
  GIMP_CONFIG_PROP_STRING(class, id, name, NULL, blurb, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_PATH(class, id, name, blurb, path_type, default, flags) \
  GIMP_CONFIG_PROP_PATH(class, id, name, NULL, blurb, path_type, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_RGB(class, id, name, blurb, has_alpha, default, flags) \
  GIMP_CONFIG_PROP_RGB(class, id, name, NULL, blurb, has_alpha, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_MATRIX2(class, id, name, blurb, default, flags) \
  GIMP_CONFIG_PROP_MATRIX2(class, id, name, NULL, blurb, default, flags)

#define GIMP_CONFIG_INSTALL_PROP_OBJECT(class, id, name, blurb, object_type, flags) \
  GIMP_CONFIG_PROP_OBJECT(class, id, name, NULL, blurb, object_type, flags)

#define GIMP_CONFIG_INSTALL_PROP_BOXED(class, id, name, blurb, boxed_type, flags) \
  GIMP_CONFIG_PROP_BOXED(class, id, name, NULL, blurb, boxed_type, flags)

#define GIMP_CONFIG_INSTALL_PROP_POINTER(class, id, name, blurb, flags) \
  GIMP_CONFIG_PROP_POINTER(class, id, name, NULL, blurb, flags)

223 224
#endif /* GIMP_DISABLE_DEPRECATED */

225

226 227
G_END_DECLS

228
#endif /* __GIMP_CONFIG_PARAMS_H__ */