2012-02-03 19:42:56 +01:00
|
|
|
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
|
|
|
|
|
* GObject introspection: Property
|
2010-06-07 00:52:12 +02:00
|
|
|
*
|
|
|
|
|
* Copyright (C) 2005 Matthias Clasen
|
|
|
|
|
* Copyright (C) 2008,2009 Red Hat, Inc.
|
|
|
|
|
*
|
2023-10-25 18:10:10 +02:00
|
|
|
* SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
|
*
|
2010-06-07 00:52:12 +02:00
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser 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
|
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU Lesser 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.
|
|
|
|
|
*/
|
|
|
|
|
|
2023-11-07 19:23:17 +01:00
|
|
|
#pragma once
|
2010-06-07 00:52:12 +02:00
|
|
|
|
|
|
|
|
#if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
|
|
|
|
|
#error "Only <girepository.h> can be included directly."
|
|
|
|
|
#endif
|
|
|
|
|
|
2023-10-25 18:45:42 +02:00
|
|
|
#include <girepository/gitypes.h>
|
2010-06-07 00:52:12 +02:00
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
2013-10-10 22:21:18 +02:00
|
|
|
/**
|
|
|
|
|
* GI_IS_PROPERTY_INFO
|
|
|
|
|
* @info: an info structure
|
|
|
|
|
*
|
|
|
|
|
* Checks if @info is a #GIPropertyInfo.
|
|
|
|
|
*/
|
2010-06-07 00:52:12 +02:00
|
|
|
#define GI_IS_PROPERTY_INFO(info) \
|
2023-12-12 17:16:30 +01:00
|
|
|
(gi_base_info_get_info_type ((GIBaseInfo*) info) == GI_INFO_TYPE_PROPERTY)
|
2010-06-07 00:52:12 +02:00
|
|
|
|
2014-07-04 12:18:32 +02:00
|
|
|
|
|
|
|
|
GI_AVAILABLE_IN_ALL
|
2023-11-08 15:17:52 +01:00
|
|
|
GParamFlags gi_property_info_get_flags (GIPropertyInfo *info);
|
2014-07-04 12:18:32 +02:00
|
|
|
|
|
|
|
|
GI_AVAILABLE_IN_ALL
|
2023-11-28 18:09:26 +01:00
|
|
|
GITypeInfo *gi_property_info_get_type_info (GIPropertyInfo *info);
|
2014-07-04 12:18:32 +02:00
|
|
|
|
|
|
|
|
GI_AVAILABLE_IN_ALL
|
2023-11-08 15:17:52 +01:00
|
|
|
GITransfer gi_property_info_get_ownership_transfer (GIPropertyInfo *info);
|
2010-06-07 00:52:12 +02:00
|
|
|
|
2023-11-08 01:02:12 +01:00
|
|
|
GI_AVAILABLE_IN_ALL
|
2023-11-08 15:17:52 +01:00
|
|
|
GIFunctionInfo *gi_property_info_get_setter (GIPropertyInfo *info);
|
Add introspection data for property accessors
A GObject property can be accessed generically through the GObject API,
e.g. g_object_set_property() and g_object_get_property(). Properties
typically also have public accessor functions, which are (according to
our own best practices) called through the generic API.
The introspection data is currently missing the relation between a
property and its public accessor functions. With this information, a
language binding could, for instance, avoid exposing the C API entirely,
thus minimizing the chances of collisions between property names and
accessor functions; alternatively, a binding could call the C API
directly instead of going through the generic GObject API, thus avoiding
the boxing and unboxing from a native type to a GIArgument and finally
into a GValue, and vice versa.
In the GIR, we add two new attributes to the `property` element:
- setter="SYMBOL"
- getter="SYMBOL"
where "symbol" is the C function identifier of the setter and getter
functions, respectively. The `setter` attribute is only applied to
writable, non-construct-only properties; the `getter` attribute is only
applied to readable properties.
We maintain the ABI compatibility of the typelib data by using 20 bits
of the 25 reserved bits inside the PropertyBlob structure. The data is
exposed through two new GIPropertyInfo methods:
- g_property_info_get_setter()
- g_property_info_get_getter()
which return the GIFunctionInfo for the setter and getter functions,
respectively.
2021-06-17 14:07:35 +02:00
|
|
|
|
2023-11-08 01:02:12 +01:00
|
|
|
GI_AVAILABLE_IN_ALL
|
2023-11-08 15:17:52 +01:00
|
|
|
GIFunctionInfo *gi_property_info_get_getter (GIPropertyInfo *info);
|
Add introspection data for property accessors
A GObject property can be accessed generically through the GObject API,
e.g. g_object_set_property() and g_object_get_property(). Properties
typically also have public accessor functions, which are (according to
our own best practices) called through the generic API.
The introspection data is currently missing the relation between a
property and its public accessor functions. With this information, a
language binding could, for instance, avoid exposing the C API entirely,
thus minimizing the chances of collisions between property names and
accessor functions; alternatively, a binding could call the C API
directly instead of going through the generic GObject API, thus avoiding
the boxing and unboxing from a native type to a GIArgument and finally
into a GValue, and vice versa.
In the GIR, we add two new attributes to the `property` element:
- setter="SYMBOL"
- getter="SYMBOL"
where "symbol" is the C function identifier of the setter and getter
functions, respectively. The `setter` attribute is only applied to
writable, non-construct-only properties; the `getter` attribute is only
applied to readable properties.
We maintain the ABI compatibility of the typelib data by using 20 bits
of the 25 reserved bits inside the PropertyBlob structure. The data is
exposed through two new GIPropertyInfo methods:
- g_property_info_get_setter()
- g_property_info_get_getter()
which return the GIFunctionInfo for the setter and getter functions,
respectively.
2021-06-17 14:07:35 +02:00
|
|
|
|
2010-06-07 00:52:12 +02:00
|
|
|
G_END_DECLS
|
