glibmm: Glib::Container_Helpers::ArrayKeeper< Tr > Class Template Reference
A keeper class for C array. More...
#include <glibmm/vectorutils.h>
Public Types | |
using | CppType = typename Tr::CppType |
using | CType = typename Tr::CType |
Public Member Functions | |
ArrayKeeper (const CType* array, std::size_t array_size, Glib::OwnershipType ownership) | |
Constructs an ArrayKeeper holding array of size array_size. More... | |
ArrayKeeper (const ArrayKeeper& keeper) | |
~ArrayKeeper () noexcept | |
CType* | data () const |
Gets data the keeper holds. More... | |
Detailed Description
template<typename Tr>
class Glib::Container_Helpers::ArrayKeeper< Tr >
A keeper class for C array.
Primarily used by C++ wrappers like gtkmm.
Its main purpose is to free its data when they are not needed. What will be destroyed depends on passed ownership upon construction.
The most common usage of Glib::ArrayKeeper is getting its data when converting std::vector to a C array:
Variables of this class are seldom defined directly - it is mostly used as a temporary variable returned by Glib::ArrayHandler::vector_to_array().
Note that the usage above is correct with regards to C++ standard point 12.2.3. That means that data returned by data() method is valid through whole g_temp_do_something function and is destroyed, when this function returns.
Member Typedef Documentation
using Glib::Container_Helpers::ArrayKeeper< Tr >::CppType = typename Tr::CppType |
using Glib::Container_Helpers::ArrayKeeper< Tr >::CType = typename Tr::CType |
Constructor & Destructor Documentation
|
inlineexplicit |
Constructs an ArrayKeeper holding array of size array_size.
ownership tells what should be destroyed with keeper destruction:
- Glib::OWNERSHIP_NONE - keeper won't destroy data it holds.
- Glib::OWNERSHIP_SHALLOW - keeper will destroy only container it holds.
- Glib::OWNERSHIP_DEEP - keeper will destroy data and container it holds.
- Parameters
-
array - C array to hold. array_size - length of array. ownership - ownership definition.
|
inline |
|
noexcept |
Member Function Documentation
|
inline |
Gets data the keeper holds.
Note that this data is owned by the keeper, so there is no need to free it.
- Returns
- C array owned by ArrayKeeper.