GI.GObject.Structs.ValueArray

A ValueArray contains an array of Value elements.

Exported types

newtype ValueArray

Memory-managed wrapper type.

Constructors

ValueArray (ManagedPtr ValueArray)

Instances

BoxedObject ValueArray

Defined in GI.GObject.Structs.ValueArray

Methods

boxedType :: ValueArray -> IO GType

tag ~ AttrSet => Constructible ValueArray tag

Defined in GI.GObject.Structs.ValueArray

Methods

new :: MonadIO m => (ManagedPtr ValueArray -> ValueArray) -> [AttrOp ValueArray tag] -> m ValueArray

newZeroValueArray :: MonadIO m => m ValueArray

Construct a ValueArray struct initialized to zero.

noValueArray :: Maybe ValueArray

A convenience alias for Nothing :: Maybe ValueArray.

Methods

append

valueArrayAppend

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to add an element to

-> Maybe GValue

value: Value to copy into ValueArray, or Nothing

-> m ValueArray

Returns: the ValueArray passed in as valueArray

Deprecated: (Since version 2.32)Use Array and g_array_append_val() instead.

Insert a copy of value as last element of valueArray. If value is Nothing, an uninitialized value is appended.

copy

valueArrayCopy

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to copy

-> m ValueArray

Returns: Newly allocated copy of ValueArray

Deprecated: (Since version 2.32)Use Array and g_array_ref() instead.

Construct an exact copy of a ValueArray by duplicating all its contents.

getNth

valueArrayGetNth

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to get a value from

-> Word32

index_: index of the value of interest

-> m GValue

Returns: pointer to a value at index_ in valueArray

Deprecated: (Since version 2.32)Use g_array_index() instead.

Return a pointer to the value at index_ containd in valueArray.

insert

valueArrayInsert

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to add an element to

-> Word32

index_: insertion position, must be <= value_array->;n_values

-> Maybe GValue

value: Value to copy into ValueArray, or Nothing

-> m ValueArray

Returns: the ValueArray passed in as valueArray

Deprecated: (Since version 2.32)Use Array and g_array_insert_val() instead.

Insert a copy of value at specified position into valueArray. If value is Nothing, an uninitialized value is inserted.

new

valueArrayNew

Arguments

:: (HasCallStack, MonadIO m)

=> Word32

nPrealloced: number of values to preallocate space for

-> m ValueArray

Returns: a newly allocated ValueArray with 0 values

Deprecated: (Since version 2.32)Use Array and g_array_sized_new() instead.

Allocate and initialize a new ValueArray, optionally preserve space for nPrealloced elements. New arrays always contain 0 elements, regardless of the value of nPrealloced.

prepend

valueArrayPrepend

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to add an element to

-> Maybe GValue

value: Value to copy into ValueArray, or Nothing

-> m ValueArray

Returns: the ValueArray passed in as valueArray

Deprecated: (Since version 2.32)Use Array and g_array_prepend_val() instead.

Insert a copy of value as first element of valueArray. If value is Nothing, an uninitialized value is prepended.

remove

valueArrayRemove

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to remove an element from

-> Word32

index_: position of value to remove, which must be less than valueArray->n_values

-> m ValueArray

Returns: the ValueArray passed in as valueArray

Deprecated: (Since version 2.32)Use Array and g_array_remove_index() instead.

Remove the value at position index_ from valueArray.

sort

valueArraySort

Arguments

:: (HasCallStack, MonadIO m)

=> ValueArray

valueArray: ValueArray to sort

-> CompareDataFunc

compareFunc: function to compare elements

-> m ValueArray

Returns: the ValueArray passed in as valueArray

Deprecated: (Since version 2.32)Use Array and g_array_sort_with_data().

Sort valueArray using compareFunc to compare the elements according to the semantics of CompareDataFunc.

The current implementation uses the same sorting algorithm as standard C qsort() function.

Properties

nValues

number of values contained in the array

getValueArrayNValues :: MonadIO m => ValueArray -> m Word32

Get the value of the “n_values” field. When overloading is enabled, this is equivalent to

get valueArray #nValues

setValueArrayNValues :: MonadIO m => ValueArray -> Word32 -> m ()

Set the value of the “n_values” field. When overloading is enabled, this is equivalent to

set valueArray [ #nValues := value ]

values

array of values

clearValueArrayValues :: MonadIO m => ValueArray -> m ()

Set the value of the “values” field to Nothing. When overloading is enabled, this is equivalent to

clear #values

getValueArrayValues :: MonadIO m => ValueArray -> m (Maybe GValue)

Get the value of the “values” field. When overloading is enabled, this is equivalent to

get valueArray #values

setValueArrayValues :: MonadIO m => ValueArray -> Ptr GValue -> m ()

Set the value of the “values” field. When overloading is enabled, this is equivalent to

set valueArray [ #values := value ]