Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GObject.Structs.ValueArray

Contents

Exported types
Methods
Properties
- nValues
- values

Description

A ValueArray contains an array of Value elements.

Synopsis

Exported types

newtype ValueArray Source #

Constructors

ValueArray (ManagedPtr ValueArray)

Instances

BoxedObject ValueArray Source #
Methods boxedType :: ValueArray -> IO GType #
(~) AttrOpTag tag AttrSet => Constructible ValueArray tag Source #
Methods new :: MonadIO m => (ManagedPtr ValueArray -> ValueArray) -> [AttrOp ValueArray tag] -> m ValueArray #
((~) * info (ResolveValueArrayMethod t ValueArray), MethodInfo * info ValueArray p) => IsLabel t (ValueArray -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> ValueArray -> p #
((~) * info (ResolveValueArrayMethod t ValueArray), MethodInfo * info ValueArray p) => IsLabelProxy t (ValueArray -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> ValueArray -> p #
HasAttributeList * ValueArray Source #

((~) * signature (CompareDataFunc -> m ValueArray), MonadIO m) => MethodInfo * ValueArraySortMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArraySortMethodInfo ValueArray -> signature -> s #
((~) * signature (Word32 -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayRemoveMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayRemoveMethodInfo ValueArray -> signature -> s #
((~) * signature (Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayPrependMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayPrependMethodInfo ValueArray -> signature -> s #
((~) * signature (Word32 -> Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayInsertMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayInsertMethodInfo ValueArray -> signature -> s #
((~) * signature (Word32 -> m GValue), MonadIO m) => MethodInfo * ValueArrayGetNthMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayGetNthMethodInfo ValueArray -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * ValueArrayFreeMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayFreeMethodInfo ValueArray -> signature -> s #
((~) * signature (m ValueArray), MonadIO m) => MethodInfo * ValueArrayCopyMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayCopyMethodInfo ValueArray -> signature -> s #
((~) * signature (Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayAppendMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayAppendMethodInfo ValueArray -> signature -> s #
type AttributeList ValueArray Source #
type AttributeList ValueArray

newZeroValueArray :: MonadIO m => m ValueArray Source #

Construct a ValueArray struct initialized to zero.

noValueArray :: Maybe ValueArray Source #

Methods

append

data ValueArrayAppendMethodInfo Source #

Instances

((~) * signature (Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayAppendMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayAppendMethodInfo ValueArray -> signature -> s #

valueArrayAppend Source #

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

data ValueArrayCopyMethodInfo Source #

Instances

((~) * signature (m ValueArray), MonadIO m) => MethodInfo * ValueArrayCopyMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayCopyMethodInfo ValueArray -> signature -> s #

valueArrayCopy Source #

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.

free

data ValueArrayFreeMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ValueArrayFreeMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayFreeMethodInfo ValueArray -> signature -> s #

valueArrayFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ValueArray	`valueArray`: `ValueArray` to free
-> m ()

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

Free a ValueArray including its contents.

getNth

data ValueArrayGetNthMethodInfo Source #

Instances

((~) * signature (Word32 -> m GValue), MonadIO m) => MethodInfo * ValueArrayGetNthMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayGetNthMethodInfo ValueArray -> signature -> s #

valueArrayGetNth Source #

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

data ValueArrayInsertMethodInfo Source #

Instances

((~) * signature (Word32 -> Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayInsertMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayInsertMethodInfo ValueArray -> signature -> s #

valueArrayInsert Source #

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 Source #

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

data ValueArrayPrependMethodInfo Source #

Instances

((~) * signature (Maybe GValue -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayPrependMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayPrependMethodInfo ValueArray -> signature -> s #

valueArrayPrepend Source #

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

data ValueArrayRemoveMethodInfo Source #

Instances

((~) * signature (Word32 -> m ValueArray), MonadIO m) => MethodInfo * ValueArrayRemoveMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArrayRemoveMethodInfo ValueArray -> signature -> s #

valueArrayRemove Source #

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

data ValueArraySortMethodInfo Source #

Instances

((~) * signature (CompareDataFunc -> m ValueArray), MonadIO m) => MethodInfo * ValueArraySortMethodInfo ValueArray signature Source #
Methods overloadedMethod :: MethodProxy ValueArraySortMethodInfo ValueArray -> signature -> s #

valueArraySort Source #

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

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

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

valueArray_nValues :: AttrLabelProxy "nValues" Source #

values

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

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

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

valueArray_values :: AttrLabelProxy "values" Source #