Method
VtePropertiesget_property_value
unstable since: 0.82
Declaration [src]
gboolean
vte_properties_get_property_value (
const VteProperties* properties,
const char* prop,
GValue* gvalue
)
Description [src]
Returns TRUE
with the value of prop
stored in value
(if not NULL
) if,
the property has a value, or FALSE
if prop
is unset, or prop
is not
a registered property; in that case value
will not be set.
The value type returned depends on the property type:
* A VTE_PROPERTY_VALUELESS
property stores no value, and returns FALSE
from this function.
* A VTE_PROPERTY_BOOL
property stores a G_TYPE_BOOLEAN
value.
* A VTE_PROPERTY_INT
property stores a G_TYPE_INT64
value.
* A VTE_PROPERTY_UINT
property stores a G_TYPE_UINT64
value.
* A VTE_PROPERTY_DOUBLE
property stores a G_TYPE_DOUBLE
value.
* A VTE_PROPERTY_RGB
property stores a boxed GdkRGBA
value with alpha 1.0 on gtk3,
and nothing on gtk4.
* A VTE_PROPERTY_RGBA
property stores a boxed GdkRGBA
value on gtk3,
and nothing on gtk4.
* A VTE_PROPERTY_STRING
property stores a G_TYPE_STRING
value.
* A VTE_PROPERTY_DATA
property stores a boxed GBytes
value.
* A VTE_PROPERTY_UUID
property stores a boxed VteUuid
value.
* A VTE_PROPERTY_URI
property stores a boxed GUri
value.
* A VTE_PROPERTY_IMAGE
property stores a boxed #cairo_surface_t value on gtk3,
and a boxed GdkTexture
on gtk4.
Available since: 0.82
Parameters
prop
-
Type:
const char*
A property name.
The data is owned by the caller of the method. The value is a NUL terminated UTF-8 string. gvalue
-
Type:
GValue
A
GValue
to be filled in, orNULL
.The argument will be set by the function. The argument can be NULL
.The returned data is owned by the instance.