glib-2.0/gobject/glib-types.h

0001 /* GObject - GLib Type, Object, Parameter and Signal Library
0002  * Copyright (C) 2000-2001 Red Hat, Inc.
0003  *
0004  * SPDX-License-Identifier: LGPL-2.1-or-later
0005  *
0006  * This library is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU Lesser General Public
0008  * License as published by the Free Software Foundation; either
0009  * version 2.1 of the License, or (at your option) any later version.
0010  *
0011  * This library is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0014  * Lesser General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU Lesser General
0017  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0018  */
0019 #ifndef __GLIB_TYPES_H__
0020 #define __GLIB_TYPES_H__
0021
0022 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION) && !defined(GLIB_COMPILATION)
0023 #error "Only <glib-object.h> can be included directly."
0024 #endif
0025
0026 #include <glib.h>
0027 #include <gobject/gobject-visibility.h>
0028
0029 G_BEGIN_DECLS
0030
0031 /* A hack necesssary to preprocess this file with g-ir-scanner */
0032 #ifdef __GI_SCANNER__
0033 typedef gsize GType;
0034 #endif
0035
0036 /* --- GLib boxed types --- */
0037 /**
0038  * G_TYPE_DATE:
0039  *
0040  * The #GType for #GDate.
0041  */
0042 #define G_TYPE_DATE (g_date_get_type ())
0043
0044 /**
0045  * G_TYPE_STRV:
0046  *
0047  * The #GType for a boxed type holding a %NULL-terminated array of strings.
0048  *
0049  * The code fragments in the following example show the use of a property of
0050  * type %G_TYPE_STRV with g_object_class_install_property(), g_object_set()
0051  * and g_object_get().
0052  *
0053  * |[
0054  * g_object_class_install_property (object_class,
0055  *                                  PROP_AUTHORS,
0056  *                                  g_param_spec_boxed ("authors",
0057  *                                                      _("Authors"),
0058  *                                                      _("List of authors"),
0059  *                                                      G_TYPE_STRV,
0060  *                                                      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
0061  *
0062  * gchar *authors[] = { "Owen", "Tim", NULL };
0063  * g_object_set (obj, "authors", authors, NULL);
0064  *
0065  * gchar *writers[];
0066  * g_object_get (obj, "authors", &writers, NULL);
0067  * /&ast; do something with writers &ast;/
0068  * g_strfreev (writers);
0069  * ]|
0070  *
0071  * Since: 2.4
0072  */
0073 #define G_TYPE_STRV (g_strv_get_type ())
0074
0075 /**
0076  * G_TYPE_GSTRING:
0077  *
0078  * The #GType for #GString.
0079  */
0080 #define G_TYPE_GSTRING (g_gstring_get_type ())
0081
0082 /**
0083  * G_TYPE_HASH_TABLE:
0084  *
0085  * The #GType for a boxed type holding a #GHashTable reference.
0086  *
0087  * Since: 2.10
0088  */
0089 #define G_TYPE_HASH_TABLE (g_hash_table_get_type ())
0090
0091 /**
0092  * G_TYPE_REGEX:
0093  *
0094  * The #GType for a boxed type holding a #GRegex reference.
0095  *
0096  * Since: 2.14
0097  */
0098 #define G_TYPE_REGEX (g_regex_get_type ())
0099
0100 /**
0101  * G_TYPE_MATCH_INFO:
0102  *
0103  * The #GType for a boxed type holding a #GMatchInfo reference.
0104  *
0105  * Since: 2.30
0106  */
0107 #define G_TYPE_MATCH_INFO (g_match_info_get_type ())
0108
0109 /**
0110  * G_TYPE_ARRAY:
0111  *
0112  * The #GType for a boxed type holding a #GArray reference.
0113  *
0114  * Since: 2.22
0115  */
0116 #define G_TYPE_ARRAY (g_array_get_type ())
0117
0118 /**
0119  * G_TYPE_BYTE_ARRAY:
0120  *
0121  * The #GType for a boxed type holding a #GByteArray reference.
0122  *
0123  * Since: 2.22
0124  */
0125 #define G_TYPE_BYTE_ARRAY (g_byte_array_get_type ())
0126
0127 /**
0128  * G_TYPE_PTR_ARRAY:
0129  *
0130  * The #GType for a boxed type holding a #GPtrArray reference.
0131  *
0132  * Since: 2.22
0133  */
0134 #define G_TYPE_PTR_ARRAY (g_ptr_array_get_type ())
0135
0136 /**
0137  * G_TYPE_BYTES:
0138  *
0139  * The #GType for #GBytes.
0140  *
0141  * Since: 2.32
0142  */
0143 #define G_TYPE_BYTES (g_bytes_get_type ())
0144
0145 /**
0146  * G_TYPE_VARIANT_TYPE:
0147  *
0148  * The #GType for a boxed type holding a #GVariantType.
0149  *
0150  * Since: 2.24
0151  */
0152 #define G_TYPE_VARIANT_TYPE (g_variant_type_get_gtype ())
0153
0154 /**
0155  * G_TYPE_ERROR:
0156  *
0157  * The #GType for a boxed type holding a #GError.
0158  *
0159  * Since: 2.26
0160  */
0161 #define G_TYPE_ERROR (g_error_get_type ())
0162
0163 /**
0164  * G_TYPE_DATE_TIME:
0165  *
0166  * The #GType for a boxed type holding a #GDateTime.
0167  *
0168  * Since: 2.26
0169  */
0170 #define G_TYPE_DATE_TIME (g_date_time_get_type ())
0171
0172 /**
0173  * G_TYPE_TIME_ZONE:
0174  *
0175  * The #GType for a boxed type holding a #GTimeZone.
0176  *
0177  * Since: 2.34
0178  */
0179 #define G_TYPE_TIME_ZONE (g_time_zone_get_type ())
0180
0181 /**
0182  * G_TYPE_IO_CHANNEL:
0183  *
0184  * The #GType for #GIOChannel.
0185  */
0186 #define G_TYPE_IO_CHANNEL (g_io_channel_get_type ())
0187
0188 /**
0189  * G_TYPE_IO_CONDITION:
0190  *
0191  * The #GType for #GIOCondition.
0192  */
0193 #define G_TYPE_IO_CONDITION (g_io_condition_get_type ())
0194
0195 /**
0196  * G_TYPE_VARIANT_BUILDER:
0197  *
0198  * The #GType for a boxed type holding a #GVariantBuilder.
0199  *
0200  * Since: 2.30
0201  */
0202 #define G_TYPE_VARIANT_BUILDER (g_variant_builder_get_type ())
0203
0204 /**
0205  * G_TYPE_VARIANT_DICT:
0206  *
0207  * The #GType for a boxed type holding a #GVariantDict.
0208  *
0209  * Since: 2.40
0210  */
0211 #define G_TYPE_VARIANT_DICT (g_variant_dict_get_type ())
0212
0213 /**
0214  * G_TYPE_MAIN_LOOP:
0215  *
0216  * The #GType for a boxed type holding a #GMainLoop.
0217  *
0218  * Since: 2.30
0219  */
0220 #define G_TYPE_MAIN_LOOP (g_main_loop_get_type ())
0221
0222 /**
0223  * G_TYPE_MAIN_CONTEXT:
0224  *
0225  * The #GType for a boxed type holding a #GMainContext.
0226  *
0227  * Since: 2.30
0228  */
0229 #define G_TYPE_MAIN_CONTEXT (g_main_context_get_type ())
0230
0231 /**
0232  * G_TYPE_SOURCE:
0233  *
0234  * The #GType for a boxed type holding a #GSource.
0235  *
0236  * Since: 2.30
0237  */
0238 #define G_TYPE_SOURCE (g_source_get_type ())
0239
0240 /**
0241  * G_TYPE_POLLFD:
0242  *
0243  * The #GType for a boxed type holding a #GPollFD.
0244  *
0245  * Since: 2.36
0246  */
0247 #define G_TYPE_POLLFD (g_pollfd_get_type ())
0248
0249 /**
0250  * G_TYPE_MARKUP_PARSE_CONTEXT:
0251  *
0252  * The #GType for a boxed type holding a #GMarkupParseContext.
0253  *
0254  * Since: 2.36
0255  */
0256 #define G_TYPE_MARKUP_PARSE_CONTEXT (g_markup_parse_context_get_type ())
0257
0258 /**
0259  * G_TYPE_KEY_FILE:
0260  *
0261  * The #GType for a boxed type holding a #GKeyFile.
0262  *
0263  * Since: 2.32
0264  */
0265 #define G_TYPE_KEY_FILE (g_key_file_get_type ())
0266
0267 /**
0268  * G_TYPE_MAPPED_FILE:
0269  *
0270  * The #GType for a boxed type holding a #GMappedFile.
0271  *
0272  * Since: 2.40
0273  */
0274 #define G_TYPE_MAPPED_FILE (g_mapped_file_get_type ())
0275
0276 /**
0277  * G_TYPE_THREAD:
0278  *
0279  * The #GType for a boxed type holding a #GThread.
0280  *
0281  * Since: 2.36
0282  */
0283 #define G_TYPE_THREAD (g_thread_get_type ())
0284
0285 /**
0286  * G_TYPE_CHECKSUM:
0287  *
0288  * The #GType for a boxed type holding a #GChecksum.
0289  *
0290  * Since: 2.36
0291  */
0292 #define G_TYPE_CHECKSUM (g_checksum_get_type ())
0293
0294 /**
0295  * G_TYPE_OPTION_GROUP:
0296  *
0297  * The #GType for a boxed type holding a #GOptionGroup.
0298  *
0299  * Since: 2.44
0300  */
0301 #define G_TYPE_OPTION_GROUP (g_option_group_get_type ())
0302
0303 /**
0304  * G_TYPE_URI:
0305  *
0306  * The #GType for a boxed type holding a #GUri.
0307  *
0308  * Since: 2.66
0309  */
0310 #define G_TYPE_URI (g_uri_get_type ())
0311
0312 /**
0313  * G_TYPE_TREE:
0314  *
0315  * The #GType for #GTree.
0316  *
0317  * Since: 2.68
0318  */
0319 #define G_TYPE_TREE (g_tree_get_type ())
0320
0321 /**
0322  * G_TYPE_PATTERN_SPEC:
0323  *
0324  * The #GType for #GPatternSpec.
0325  *
0326  * Since: 2.70
0327  */
0328 #define G_TYPE_PATTERN_SPEC (g_pattern_spec_get_type ())
0329
0330 /**
0331  * G_TYPE_BOOKMARK_FILE:
0332  *
0333  * The #GType for a boxed type holding a #GBookmarkFile.
0334  *
0335  * Since: 2.76
0336  */
0337 #define G_TYPE_BOOKMARK_FILE (g_bookmark_file_get_type ())
0338
0339 /**
0340  * G_TYPE_HMAC:
0341  *
0342  * The #GType for a boxed type holding a #GHmac.
0343  *
0344  * Since: 2.80
0345  */
0346 #define G_TYPE_HMAC (g_hmac_get_type ())
0347
0348 /**
0349  * G_TYPE_DIR:
0350  *
0351  * The #GType for a boxed type holding a #GDir.
0352  *
0353  * Since: 2.80
0354  */
0355 #define G_TYPE_DIR (g_dir_get_type ())
0356
0357 /**
0358  * G_TYPE_RAND:
0359  *
0360  * The #GType for a boxed type holding a #GRand.
0361  *
0362  * Since: 2.80
0363  */
0364 #define G_TYPE_RAND (g_rand_get_type ())
0365
0366 /**
0367  * G_TYPE_STRV_BUILDER:
0368  *
0369  * The #GType for a boxed type holding a #GStrvBuilder.
0370  *
0371  * Since: 2.80
0372  */
0373 #define G_TYPE_STRV_BUILDER (g_strv_builder_get_type ())
0374
0375 GOBJECT_AVAILABLE_IN_ALL
0376 GType   g_date_get_type            (void) G_GNUC_CONST;
0377 GOBJECT_AVAILABLE_IN_ALL
0378 GType   g_strv_get_type            (void) G_GNUC_CONST;
0379 GOBJECT_AVAILABLE_IN_ALL
0380 GType   g_gstring_get_type         (void) G_GNUC_CONST;
0381 GOBJECT_AVAILABLE_IN_ALL
0382 GType   g_hash_table_get_type      (void) G_GNUC_CONST;
0383 GOBJECT_AVAILABLE_IN_ALL
0384 GType   g_array_get_type           (void) G_GNUC_CONST;
0385 GOBJECT_AVAILABLE_IN_ALL
0386 GType   g_byte_array_get_type      (void) G_GNUC_CONST;
0387 GOBJECT_AVAILABLE_IN_ALL
0388 GType   g_ptr_array_get_type       (void) G_GNUC_CONST;
0389 GOBJECT_AVAILABLE_IN_ALL
0390 GType   g_bytes_get_type           (void) G_GNUC_CONST;
0391 GOBJECT_AVAILABLE_IN_ALL
0392 GType   g_variant_type_get_gtype   (void) G_GNUC_CONST;
0393 GOBJECT_AVAILABLE_IN_ALL
0394 GType   g_regex_get_type           (void) G_GNUC_CONST;
0395 GOBJECT_AVAILABLE_IN_2_30
0396 GType   g_match_info_get_type      (void) G_GNUC_CONST;
0397 GOBJECT_AVAILABLE_IN_ALL
0398 GType   g_error_get_type           (void) G_GNUC_CONST;
0399 GOBJECT_AVAILABLE_IN_ALL
0400 GType   g_date_time_get_type       (void) G_GNUC_CONST;
0401 GOBJECT_AVAILABLE_IN_ALL
0402 GType   g_time_zone_get_type       (void) G_GNUC_CONST;
0403 GOBJECT_AVAILABLE_IN_ALL
0404 GType   g_io_channel_get_type      (void) G_GNUC_CONST;
0405 GOBJECT_AVAILABLE_IN_ALL
0406 GType   g_io_condition_get_type    (void) G_GNUC_CONST;
0407 GOBJECT_AVAILABLE_IN_ALL
0408 GType   g_variant_builder_get_type (void) G_GNUC_CONST;
0409 GOBJECT_AVAILABLE_IN_2_40
0410 GType   g_variant_dict_get_type    (void) G_GNUC_CONST;
0411 GOBJECT_AVAILABLE_IN_ALL
0412 GType   g_key_file_get_type        (void) G_GNUC_CONST;
0413 GOBJECT_AVAILABLE_IN_2_30
0414 GType   g_main_loop_get_type       (void) G_GNUC_CONST;
0415 GOBJECT_AVAILABLE_IN_2_30
0416 GType   g_main_context_get_type    (void) G_GNUC_CONST;
0417 GOBJECT_AVAILABLE_IN_2_30
0418 GType   g_source_get_type          (void) G_GNUC_CONST;
0419 GOBJECT_AVAILABLE_IN_2_36
0420 GType   g_pollfd_get_type          (void) G_GNUC_CONST;
0421 GOBJECT_AVAILABLE_IN_2_36
0422 GType   g_thread_get_type          (void) G_GNUC_CONST;
0423 GOBJECT_AVAILABLE_IN_2_36
0424 GType   g_checksum_get_type        (void) G_GNUC_CONST;
0425 GOBJECT_AVAILABLE_IN_2_36
0426 GType   g_markup_parse_context_get_type (void) G_GNUC_CONST;
0427 GOBJECT_AVAILABLE_IN_2_40
0428 GType   g_mapped_file_get_type (void) G_GNUC_CONST;
0429 GOBJECT_AVAILABLE_IN_2_44
0430 GType   g_option_group_get_type    (void) G_GNUC_CONST;
0431 GOBJECT_AVAILABLE_IN_2_66
0432 GType   g_uri_get_type             (void) G_GNUC_CONST;
0433 GOBJECT_AVAILABLE_IN_2_68
0434 GType   g_tree_get_type            (void) G_GNUC_CONST;
0435 GOBJECT_AVAILABLE_IN_2_70
0436 GType g_pattern_spec_get_type (void) G_GNUC_CONST;
0437 GOBJECT_AVAILABLE_IN_2_76
0438 GType   g_bookmark_file_get_type   (void) G_GNUC_CONST;
0439 GOBJECT_AVAILABLE_IN_2_80
0440 GType   g_hmac_get_type (void) G_GNUC_CONST;
0441 GOBJECT_AVAILABLE_IN_2_80
0442 GType   g_dir_get_type (void) G_GNUC_CONST;
0443 GOBJECT_AVAILABLE_IN_2_80
0444 GType   g_rand_get_type (void) G_GNUC_CONST;
0445 GOBJECT_AVAILABLE_IN_2_80
0446 GType   g_strv_builder_get_type (void) G_GNUC_CONST;
0447
0448 GOBJECT_DEPRECATED_FOR('G_TYPE_VARIANT')
0449 GType   g_variant_get_gtype        (void) G_GNUC_CONST;
0450
0451 G_END_DECLS
0452
0453 #endif  /* __GLIB_TYPES_H__ */