Method

VtePropertiesref_property_variant

unstable since: 0.82

Declaration [src]

GVariant*
vte_properties_ref_property_variant (
  const VteProperties* properties,
  const char* prop
)

Description [src]

Returns the value of prop as a GVariant, or NULL if prop unset, or prop is not a registered property.

The GVariantType of the returned GVariant depends on the property type: * A VTE_PROPERTY_VALUELESS property returns a G_VARIANT_TYPE_UNIT variant. * A VTE_PROPERTY_BOOL property returns a G_VARIANT_TYPE_BOOLEAN variant. * A VTE_PROPERTY_INT property returns a G_VARIANT_TYPE_INT64 variant. * A VTE_PROPERTY_UINT property returns a G_VARIANT_TYPE_UINT64 variant. * A VTE_PROPERTY_DOUBLE property returns a G_VARIANT_TYPE_DOUBLE variant. * A VTE_PROPERTY_RGB or VTE_PROPERTY_RGBA property returns a “(ddddv)” tuple containing the red, green, blue, and alpha (1.0 for VTE_PROPERTY_RGB) components of the color and a variant of unspecified contents * A VTE_PROPERTY_STRING property returns a G_VARIANT_TYPE_STRING variant. * A VTE_PROPERTY_DATA property returns a “ay” variant (which is not a bytestring!). * A VTE_PROPERTY_UUID property returns a G_VARIANT_TYPE_STRING variant containing a string representation of the UUID in simple form. * A VTE_PROPERTY_URI property returns a G_VARIANT_TYPE_STRING variant containing a string representation of the URI * A VTE_PROPERTY_IMAGE property returns NULL since an image has no variant representation.

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.

Return value

Type: GVariant

A floating GVariant, or NULL.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.
The return value can be NULL.