Public Types | Public Member Functions | Static Public Member Functions

Glib::Variant< std::vector< Glib::ustring > > Class Template Reference

Specialization of Glib::Variant containing an array of UTF-8 capable strings. More...

#include <glibmm/variant.h>

Inheritance diagram for Glib::Variant< std::vector< Glib::ustring > >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Glib::ustring CppType
typedef std::vector
< Glib::ustring
CppContainerType

Public Member Functions

 Variant ()
 Default constructor.
 Variant (GVariant* castitem, bool take_a_reference=false)
 GVariant constructor.
Glib::ustring get (gsize index) const
 Gets a specific element of the string array.
std::vector< Glib::ustringget () const
 Gets the string vector of the Glib::Variant.
VariantIter get_iter ()
 Gets a VariantIter of the Variant.

Static Public Member Functions

static const Glib::VariantTypevariant_type ()
 Gets the Glib::VariantType.
static Variant< std::vector
< Glib::ustring > > 
create (const std::vector< Glib::ustring >& data)
 Creates a new Glib::Variant from an array of strings.

Detailed Description

template <>
class Glib::Variant< std::vector< Glib::ustring > >

Specialization of Glib::Variant containing an array of UTF-8 capable strings.


Member Typedef Documentation

Reimplemented from Glib::VariantContainerBase.


Constructor & Destructor Documentation

Default constructor.

Glib::Variant< std::vector< Glib::ustring > >::Variant ( GVariant< std::vector< Glib::ustring > >*  castitem,
bool  take_a_reference = false 
) [inline, explicit]

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

static Variant< std::vector<Glib::ustring> > Glib::Variant< std::vector< Glib::ustring > >::create ( const std::vector< Glib::ustring >&  data ) [static]

Creates a new Glib::Variant from an array of strings.

Parameters:
dataThe array to use for creation.
Returns:
The new Glib::Variant.
Since glibmm 2.28:

Gets the string vector of the Glib::Variant.

Returns:
The vector.
Since glibmm 2.28:
Glib::ustring Glib::Variant< std::vector< Glib::ustring > >::get ( gsize  index ) const

Gets a specific element of the string array.

It is an error if index is greater than the number of child items in the container. See Glib::VariantContainerBase::get_n_children().

This function is O(1).

Parameters:
indexThe index of the element.
Returns:
The element at index .
Since glibmm 2.28:

Gets a VariantIter of the Variant.

Returns:
the VaraintIter.
Since glibmm 2.28:
static const Glib::VariantType& Glib::Variant< std::vector< Glib::ustring > >::variant_type (  ) [static]