gi-gobject-2.0.31: GObject bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.GObject.Structs.TypeValueTable

Contents

- Exported types
- Methods
- Properties
  - collectFormat
  - collectValue
  - lcopyFormat
  - lcopyValue
  - valueCopy
  - valueFree
  - valueInit
  - valuePeekPointer

Description

- `'i'`: Integers, passed as `collect_values[].v_int`
- `'l'`: Longs, passed as `collect_values[].v_long`
- `'d'`: Doubles, passed as `collect_values[].v_double`
- `'p'`: Pointers, passed as `collect_values[].v_pointer`

It should be noted that for variable argument list construction, ANSI C promotes every type smaller than an integer to an int, and floats to doubles. So for collection of short int or char, `'i'` needs to be used, and for collection of floats `'d'`. The `TypeValueTable` provides the functions required by the `Value` implementation, to serve as a container for values of a type.

Synopsis

- newtype TypeValueTable = TypeValueTable (ManagedPtr TypeValueTable)
- newZeroTypeValueTable :: MonadIO m => m TypeValueTable
- clearTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> m (Maybe Text)
- setTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> CString -> m ()
- clearTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> m (Maybe TypeValueCollectFunc)
- setTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueCollectFunc -> m ()
- clearTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> m (Maybe Text)
- setTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> CString -> m ()
- clearTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> m (Maybe TypeValueLCopyFunc)
- setTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueLCopyFunc -> m ()
- clearTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> m (Maybe TypeValueCopyFunc)
- setTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueCopyFunc -> m ()
- clearTypeValueTableValueFree :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableValueFree :: MonadIO m => TypeValueTable -> m (Maybe TypeValueFreeFunc)
- setTypeValueTableValueFree :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueFreeFunc -> m ()
- clearTypeValueTableValueInit :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableValueInit :: MonadIO m => TypeValueTable -> m (Maybe TypeValueInitFunc)
- setTypeValueTableValueInit :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueInitFunc -> m ()
- clearTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> m ()
- getTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> m (Maybe TypeValuePeekPointerFunc)
- setTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> FunPtr C_TypeValuePeekPointerFunc -> m ()

# Exported types

newtype TypeValueTable Source #

Memory-managed wrapper type.

Constructors

TypeValueTable (ManagedPtr TypeValueTable) |

#### Instances

Instances details

Eq TypeValueTable Source # |
Instance details Defined in GI.GObject.Structs.TypeValueTable Methods (==) :: TypeValueTable -> TypeValueTable -> Bool Source # (/=) :: TypeValueTable -> TypeValueTable -> Bool Source #
BoxedPtr TypeValueTable Source # |
Instance details Defined in GI.GObject.Structs.TypeValueTable Methods boxedPtrCopy :: TypeValueTable -> IO TypeValueTable Source # boxedPtrFree :: TypeValueTable -> IO () Source #
CallocPtr TypeValueTable Source # |
Instance details Defined in GI.GObject.Structs.TypeValueTable Methods boxedPtrCalloc :: IO (Ptr TypeValueTable) Source #
ManagedPtrNewtype TypeValueTable Source # |
Instance details Defined in GI.GObject.Structs.TypeValueTable Methods toManagedPtr :: TypeValueTable -> ManagedPtr TypeValueTable Source #
tag ~ 'AttrSet => Constructible TypeValueTable tag Source # |
Instance details Defined in GI.GObject.Structs.TypeValueTable Methods new :: MonadIO m => (ManagedPtr TypeValueTable -> TypeValueTable) -> [AttrOp TypeValueTable tag] -> m TypeValueTable Source #

newZeroTypeValueTable :: MonadIO m => m TypeValueTable Source #

Construct a `TypeValueTable` struct initialized to zero.

# Methods

# Properties

## collectFormat

A string format describing how to collect the contents of this value bit-by-bit. Each character in the format represents an argument to be collected, and the characters themselves indicate the type of the argument. Currently supported arguments are:

clearTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #collectFormat

getTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> m (Maybe Text) Source #

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

    get typeValueTable #collectFormat

setTypeValueTableCollectFormat :: MonadIO m => TypeValueTable -> CString -> m () Source #

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

    set typeValueTable [ #collectFormat := value ]

## collectValue

Function to initialize a GValue from the values collected from variadic arguments

clearTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #collectValue

getTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> m (Maybe TypeValueCollectFunc) Source #

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

    get typeValueTable #collectValue

setTypeValueTableCollectValue :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueCollectFunc -> m () Source #

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

    set typeValueTable [ #collectValue := value ]

## lcopyFormat

Format description of the arguments to collect for `lcopyValue`, analogous to `collectFormat`. Usually, `lcopyFormat` string consists only of `'p'`s to provide `lcopy_value()` with pointers to storage locations.

clearTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #lcopyFormat

getTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> m (Maybe Text) Source #

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

    get typeValueTable #lcopyFormat

setTypeValueTableLcopyFormat :: MonadIO m => TypeValueTable -> CString -> m () Source #

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

    set typeValueTable [ #lcopyFormat := value ]

## lcopyValue

Function to store the contents of a value into the locations collected from variadic arguments

clearTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #lcopyValue

getTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> m (Maybe TypeValueLCopyFunc) Source #

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

    get typeValueTable #lcopyValue

setTypeValueTableLcopyValue :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueLCopyFunc -> m () Source #

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

    set typeValueTable [ #lcopyValue := value ]

## valueCopy

Function to copy a GValue

clearTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #valueCopy

getTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> m (Maybe TypeValueCopyFunc) Source #

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

    get typeValueTable #valueCopy

setTypeValueTableValueCopy :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueCopyFunc -> m () Source #

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

    set typeValueTable [ #valueCopy := value ]

## valueFree

Function to free a GValue

clearTypeValueTableValueFree :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #valueFree

getTypeValueTableValueFree :: MonadIO m => TypeValueTable -> m (Maybe TypeValueFreeFunc) Source #

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

    get typeValueTable #valueFree

setTypeValueTableValueFree :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueFreeFunc -> m () Source #

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

    set typeValueTable [ #valueFree := value ]

## valueInit

Function to initialize a GValue

clearTypeValueTableValueInit :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #valueInit

getTypeValueTableValueInit :: MonadIO m => TypeValueTable -> m (Maybe TypeValueInitFunc) Source #

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

    get typeValueTable #valueInit

setTypeValueTableValueInit :: MonadIO m => TypeValueTable -> FunPtr C_TypeValueInitFunc -> m () Source #

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

    set typeValueTable [ #valueInit := value ]

## valuePeekPointer

Function to peek the contents of a GValue if they fit into a pointer

clearTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> m () Source #

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

    clear #valuePeekPointer

getTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> m (Maybe TypeValuePeekPointerFunc) Source #

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

    get typeValueTable #valuePeekPointer

setTypeValueTableValuePeekPointer :: MonadIO m => TypeValueTable -> FunPtr C_TypeValuePeekPointerFunc -> m () Source #

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

    set typeValueTable [ #valuePeekPointer := value ]