glibmm 2.78.1
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Glib::Variant< gint16 > Class Reference

Specialization of Glib::Variant containing a gint16 type. More...

#include <glibmm/variant_basictypes.h>

Inheritance diagram for Glib::Variant< gint16 >:
Inheritance graph
[legend]

Public Types

using CType = gint16
 

Public Member Functions

 Variant ()
 Default constructor. More...
 
 Variant (GVariant * castitem, bool take_a_reference=false)
 GVariant constructor. More...
 
gint16 get () const
 Gets the value of the Glib::Variant<gint16>. More...
 
- Public Member Functions inherited from Glib::VariantBase
 VariantBase ()
 Constructs an invalid object. More...
 
 VariantBase (GVariant * castitem, bool make_a_copy=false)
 
 VariantBase (const VariantBase & src)
 
VariantBaseoperator= (const VariantBase & src)
 
 VariantBase (VariantBase && other) noexcept
 
VariantBaseoperator= (VariantBase && other) noexcept
 
 ~VariantBase () noexcept
 
void swap (VariantBase & other) noexcept
 
GVariant * gobj ()
 
const GVariant * gobj () const
 
GVariant * gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More...
 
 operator bool () const
 Test whether the Variant has an underlying instance. More...
 
void init (const GVariant * cobject, bool take_a_reference=false)
 Replace the underlying GVariant. More...
 
VariantType get_type () const
 Determines the type of value. More...
 
std::string get_type_string () const
 Returns the type string of value. More...
 
bool is_floating () const
 Checks whether value has a floating reference count. More...
 
bool is_of_type (const VariantType & type) const
 Checks if a value has a type matching the provided type. More...
 
bool is_container () const
 Checks if value is a container. More...
 
GVariantClass classify () const
 Classifies value according to its top-level type. More...
 
gsize get_size () const
 Determines the number of bytes that would be required to store value with g_variant_store(). More...
 
gconstpointer get_data () const
 Returns a pointer to the serialized form of a Variant instance. More...
 
Glib::RefPtr< const Glib::Bytesget_data_as_bytes () const
 Returns a pointer to the serialized form of a Variant instance. More...
 
void store (gpointer data) const
 Stores the serialized form of value at data. More...
 
Glib::ustring print (bool type_annotate=false) const
 Pretty-prints value in the format understood by g_variant_parse(). More...
 
guint hash () const
 Generates a hash value for a Variant instance. More...
 
bool equal (const VariantBase & other) const
 Checks if *this and other have the same type and value. More...
 
bool operator== (const VariantBase & other) const
 Checks if *this and other have the same type and value. More...
 
bool operator!= (const VariantBase & other) const
 Checks if *this and other have the same type and value. More...
 
bool operator< (const VariantBase & other) const =delete
 Ordering relational operators. More...
 
bool operator<= (const VariantBase & other) const =delete
 See operator<(). More...
 
bool operator> (const VariantBase & other) const =delete
 See operator<(). More...
 
bool operator>= (const VariantBase & other) const =delete
 See operator<(). More...
 
void get_normal_form (VariantBase & result) const
 Gets a VariantBase instance that has the same value as this variant and is trusted to be in normal form. More...
 
bool is_normal_form () const
 Checks if value is in normal form. More...
 
void byteswap (VariantBase & result) const
 Performs a byteswapping operation on the contents of this variant. More...
 
bool check_format_string (const std::string & format_string, bool copy_only=false) const
 Checks if calling g_variant_get() with format_string on value would be valid from a type-compatibility standpoint. More...
 
template<typename ValueType >
ValueType get_dynamic () const
 Cast to a specific variant type and get the value. More...
 

Static Public Member Functions

static const VariantTypevariant_type ()
 Gets the Glib::VariantType. More...
 
static Variant< gint16 > create (gint16 data)
 Creates a new Glib::Variant<gint16>. More...
 
- Static Public Member Functions inherited from Glib::VariantBase
template<class V_CastTo >
static V_CastTo cast_dynamic (const VariantBase & v)
 Cast to a specific variant type. More...
 
template<>
VariantContainerBase cast_dynamic (const VariantBase & v)
 

Additional Inherited Members

- Protected Attributes inherited from Glib::VariantBase
GVariant * gobject_
 

Detailed Description

Specialization of Glib::Variant containing a gint16 type.

Member Typedef Documentation

◆ CType

using Glib::Variant< gint16 >::CType = gint16

Constructor & Destructor Documentation

◆ Variant() [1/2]

Glib::Variant< gint16 >::Variant ( )
inline

Default constructor.

◆ Variant() [2/2]

Glib::Variant< gint16 >::Variant ( GVariant< gint16 > *  castitem,
bool  take_a_reference = false 
)
inlineexplicit

GVariant constructor.

Parameters
castitemThe GVariant to wrap.
take_a_referenceWhether to take an extra reference of the GVariant or not (not taking one could destroy the GVariant with the wrapper).

Member Function Documentation

◆ create()

static Variant< gint16 > Glib::Variant< gint16 >::create ( gint16  data)
static

Creates a new Glib::Variant<gint16>.

Parameters
dataThe value of the new Glib::Variant<gint16>.
Returns
The new Glib::Variant<gint16>.

◆ get()

gint16 Glib::Variant< gint16 >::get ( ) const

Gets the value of the Glib::Variant<gint16>.

Returns
The gint16 value of the Glib::Variant<gint16>.

◆ variant_type()

static const VariantType & Glib::Variant< gint16 >::variant_type ( )
static

Gets the Glib::VariantType.

Returns
The Glib::VariantType.