GI.Vips.Objects.Object

No description available in the introspection data.

Exported types

newtype Object

Memory-managed wrapper type.

Constructors

Object (ManagedPtr Object)

Instances

Eq Object

Defined in GI.Vips.Objects.Object

Methods

(==) :: Object -> Object -> Bool

(/=) :: Object -> Object -> Bool

GObject Object

Defined in GI.Vips.Objects.Object

ManagedPtrNewtype Object

Defined in GI.Vips.Objects.Object

Methods

toManagedPtr :: Object -> ManagedPtr Object

TypedObject Object

Defined in GI.Vips.Objects.Object

Methods

glibType :: IO GType

HasParentTypes Object

Defined in GI.Vips.Objects.Object

IsGValue (Maybe Object)

Convert Object to and from GValue. See toGValue and fromGValue.

Defined in GI.Vips.Objects.Object

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Object -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Object)

type ParentTypes Object

Defined in GI.Vips.Objects.Object

type ParentTypes Object = '[Object]

class (GObject o, IsDescendantOf Object o) => IsObject o

Type class for types which can be safely cast to Object, for instance with toObject.

Instances

(GObject o, IsDescendantOf Object o) => IsObject o

Defined in GI.Vips.Objects.Object

toObject :: (MonadIO m, IsObject o) => o -> m Object

Cast to Object, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

argumentIsset, argumentNeedsstring, bindProperty, bindPropertyFull, build, forceFloating, freezeNotify, getv, isFloating, localCb, notify, notifyByPspec, preclose, printDump, printName, printSummary, ref, refSink, rewind, runDispose, sanity, stealData, stealQdata, thawNotify, toString, unref, unrefOutputs, watchClosure.

Getters

getArgumentFlags, getArgumentPriority, getArgumentToString, getData, getDescription, getQdata.

Setters

setArgumentFromString, setData, setDataFull, setFromString, setRequired, setStatic.

argumentIsset

objectArgumentIsset

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: the object to fetch the args from

-> Text

name: arg to fetch

-> m Bool

Returns: True if the argument has been assigned.

Convenience: has an argument been assigned. Useful for bindings.

argumentNeedsstring

objectArgumentNeedsstring :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Bool

No description available in the introspection data.

build

objectBuild :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32

No description available in the introspection data.

getArgumentFlags

objectGetArgumentFlags

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: the object to fetch the args from

-> Text

name: arg to fetch

-> m [ArgumentFlags]

Returns: The ArgumentFlags for this argument.

Convenience: get the flags for an argument. Useful for bindings.

getArgumentPriority

objectGetArgumentPriority

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: the object to fetch the args from

-> Text

name: arg to fetch

-> m Int32

Returns: The priority of this argument.

Convenience: get the priority for an argument. Useful for bindings.

getArgumentToString

objectGetArgumentToString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> Text -> m Int32

No description available in the introspection data.

getDescription

objectGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: object to fetch description from

-> m Text

Returns: the object description

Fetch the object description. Useful for language bindings.

object.description is only avaliable after _build(), which can be too late. This function fetches from the instance, if possible, but falls back to the class description if we are too early.

getProperty

objectGetProperty :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> GValue -> GParamSpec -> m ()

No description available in the introspection data.

localCb

objectLocalCb :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> b -> m ()

No description available in the introspection data.

newFromString

objectNewFromString :: (HasCallStack, MonadIO m) => ObjectClass -> Text -> m Object

No description available in the introspection data.

preclose

objectPreclose :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()

No description available in the introspection data.

printAll

objectPrintAll :: (HasCallStack, MonadIO m) => m ()

No description available in the introspection data.

printDump

objectPrintDump :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()

No description available in the introspection data.

printName

objectPrintName :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()

No description available in the introspection data.

printSummary

objectPrintSummary :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()

No description available in the introspection data.

printSummaryClass

objectPrintSummaryClass :: (HasCallStack, MonadIO m) => ObjectClass -> m ()

No description available in the introspection data.

rewind

objectRewind :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()

No description available in the introspection data.

sanity

objectSanity :: (HasCallStack, MonadIO m, IsObject a) => a -> m Bool

No description available in the introspection data.

sanityAll

objectSanityAll :: (HasCallStack, MonadIO m) => m ()

No description available in the introspection data.

setArgumentFromString

objectSetArgumentFromString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> Text -> m Int32

No description available in the introspection data.

setFromString

objectSetFromString

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: object to set arguments on

-> Text

string: arguments as a string

-> m Int32

Returns: 0 on success, -1 on error

Set object arguments from a string. The string can be something like "a=12", or "a = 12, b = 13", or "fred". The string can optionally be enclosed in brackets.

You'd typically use this between creating the object and building it.

See also: vips_object_set(), objectBuild, vips_cache_operation_buildp().

setProperty

objectSetProperty :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> GValue -> GParamSpec -> m ()

No description available in the introspection data.

setStatic

objectSetStatic :: (HasCallStack, MonadIO m, IsObject a) => a -> Bool -> m ()

No description available in the introspection data.

toString

objectToString

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: object to stringify

-> Buf

buf: write string here

-> m ()

The inverse of objectNewFromString: turn object into eg. "VipsInterpolateSnohalo1(blur=.333333)".

unrefOutputs

objectUnrefOutputs

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: object to drop output refs from

-> m ()

Unref all assigned output objects. Useful for language bindings.

After an object is built, all output args are owned by the caller. If something goes wrong before then, we have to unref the outputs that have been made so far. This function can also be useful for callers when they've finished processing outputs themselves.

See also: cacheOperationBuild.

Properties

description

No description available in the introspection data.

clearObjectDescription :: (MonadIO m, IsObject o) => o -> m ()

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

clear #description

constructObjectDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “description” property. This is rarely needed directly, but it is used by new.

getObjectDescription :: (MonadIO m, IsObject o) => o -> m Text

Get the value of the “description” property. When overloading is enabled, this is equivalent to

get object #description

setObjectDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()

Set the value of the “description” property. When overloading is enabled, this is equivalent to

set object [ #description := value ]

nickname

No description available in the introspection data.

clearObjectNickname :: (MonadIO m, IsObject o) => o -> m ()

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

clear #nickname

constructObjectNickname :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “nickname” property. This is rarely needed directly, but it is used by new.

getObjectNickname :: (MonadIO m, IsObject o) => o -> m (Maybe Text)

Get the value of the “nickname” property. When overloading is enabled, this is equivalent to

get object #nickname

setObjectNickname :: (MonadIO m, IsObject o) => o -> Text -> m ()

Set the value of the “nickname” property. When overloading is enabled, this is equivalent to

set object [ #nickname := value ]

Signals

close

type ObjectCloseCallback = IO ()

The close signal is emitted once during object close. The object is dying and may not work.

afterObjectClose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectCloseCallback) -> m SignalHandlerId

Connect a signal handler for the close signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #close callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onObjectClose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectCloseCallback) -> m SignalHandlerId

Connect a signal handler for the close signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #close callback

postbuild

type ObjectPostbuildCallback = IO Int32

The postbuild signal is emitted once just after successful object construction. Return non-zero to cause object construction to fail.

afterObjectPostbuild :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPostbuildCallback) -> m SignalHandlerId

Connect a signal handler for the postbuild signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #postbuild callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onObjectPostbuild :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPostbuildCallback) -> m SignalHandlerId

Connect a signal handler for the postbuild signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #postbuild callback

postclose

type ObjectPostcloseCallback = IO ()

The postclose signal is emitted once after object close. The object pointer is still valid, but nothing else.

afterObjectPostclose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPostcloseCallback) -> m SignalHandlerId

Connect a signal handler for the postclose signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #postclose callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onObjectPostclose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPostcloseCallback) -> m SignalHandlerId

Connect a signal handler for the postclose signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #postclose callback

preclose

type ObjectPrecloseCallback = IO ()

The preclose signal is emitted once just before object close starts. The oject is still alive.

afterObjectPreclose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPrecloseCallback) -> m SignalHandlerId

Connect a signal handler for the preclose signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after object #preclose callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onObjectPreclose :: (IsObject a, MonadIO m) => a -> ((?self :: a) => ObjectPrecloseCallback) -> m SignalHandlerId

Connect a signal handler for the preclose signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on object #preclose callback