A container structure to maintain an array of generic values.
More...
#include <glibmm/valuearray.h>
|
static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More...
|
|
A container structure to maintain an array of generic values.
The prime purpose of a ValueArray is for it to be used as an object property that holds an array of values. A ValueArray wraps an array of ValueBase elements.
- Since glibmm 2.22:
- Deprecated:
- Use std::vector<Glib::ValueBase*> or std::vector< Glib::Value<> > instead of Glib::ValueArray.
◆ SlotCompare
For example, int on_compare(const Glib::ValueBase& v1, const Glib::ValueBase& v2);.
The compare function should return -1 if v1 < v2, 0 if v1 == v2, and 1 if v1 > v2.
◆ ValueArray() [1/5]
Glib::ValueArray::ValueArray |
( |
GValueArray * |
gobject, |
|
|
bool |
make_a_copy = true |
|
) |
| |
|
explicit |
◆ ValueArray() [2/5]
Glib::ValueArray::ValueArray |
( |
const ValueArray & |
other | ) |
|
◆ ValueArray() [3/5]
Glib::ValueArray::ValueArray |
( |
ValueArray && |
other | ) |
|
|
noexcept |
◆ ~ValueArray()
Glib::ValueArray::~ValueArray |
( |
| ) |
|
|
noexcept |
◆ ValueArray() [4/5]
Glib::ValueArray::ValueArray |
( |
| ) |
|
Default constructor.
Constructs a new array with no pre-allocation.
◆ ValueArray() [5/5]
Glib::ValueArray::ValueArray |
( |
guint |
n_preallocated | ) |
|
Constructs a new array with pre-allocation.
◆ append()
Insert a copy of value as last element of value_array.
If value is nullptr
, an uninitialized value is appended.
Deprecated: 2.32: Use Array and Glib::array_append_val() instead.
- Parameters
-
- Returns
- The ValueArray passed in as value_array.
◆ get_nth()
Return the value at index contained in the value array.
- Parameters
-
index | Index of the value of interest. |
value | An uninitialized ValueBase in which to store the result. If the get is successful, value will be valid, otherwise it will remain uninitialized. |
- Returns
- whether the get was successful or not.
◆ get_type()
static GType Glib::ValueArray::get_type |
( |
| ) |
|
|
static |
Get the GType for this class, for use with the underlying GObject type system.
◆ gobj() [1/2]
GValueArray * Glib::ValueArray::gobj |
( |
| ) |
|
|
inline |
Provides access to the underlying C instance.
◆ gobj() [2/2]
const GValueArray * Glib::ValueArray::gobj |
( |
| ) |
const |
|
inline |
Provides access to the underlying C instance.
◆ gobj_copy()
GValueArray * Glib::ValueArray::gobj_copy |
( |
| ) |
const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
◆ insert()
Insert a copy of value at specified position into value_array.
If value is nullptr
, an uninitialized value is inserted.
Deprecated: 2.32: Use Array and Glib::array_insert_val() instead.
- Parameters
-
index | Insertion position, must be <= value_array->;n_values. |
value | Value to copy into ValueArray, or nullptr . |
- Returns
- The ValueArray passed in as value_array.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ prepend()
Insert a copy of value as first element of value_array.
If value is nullptr
, an uninitialized value is prepended.
Deprecated: 2.32: Use Array and Glib::array_prepend_val() instead.
- Parameters
-
- Returns
- The ValueArray passed in as value_array.
◆ remove()
Remove the value at position index from value_array.
Deprecated: 2.32: Use Array and g_array_remove_index() instead.
- Parameters
-
index | Position of value to remove, which must be less than value_array->n_values. |
- Returns
- The ValueArray passed in as value_array.
◆ sort()
Sort value_array using compare_func to compare the elements according to the semantics of CompareFunc.
The current implementation uses the same sorting algorithm as standard C qsort() function.
Deprecated: 2.32: Use Array and g_array_sort().
- Parameters
-
compare_func | Function to compare elements. |
- Returns
- The ValueArray passed in as value_array.
◆ swap()
◆ swap()
- Parameters
-
lhs | The left-hand side |
rhs | The right-hand side |
◆ wrap()
A Glib::wrap() method for this object.
- Parameters
-
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
- Returns
- A C++ instance that wraps this C instance.
◆ gobject_
GValueArray* Glib::ValueArray::gobject_ |
|
protected |