Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- argumentIsset
- argumentNeedsstring
- build
- getArgumentFlags
- getArgumentPriority
- getArgumentToString
- getDescription
- getProperty
- localCb
- newFromString
- preclose
- printAll
- printDump
- printName
- printSummary
- printSummaryClass
- rewind
- sanity
- sanityAll
- setArgumentFromString
- setFromString
- setProperty
- setStatic
- unrefOutputs
- Properties
- Signals
No description available in the introspection data.
Synopsis
- newtype Object = Object (ManagedPtr Object)
- class (GObject o, IsDescendantOf Object o) => IsObject o
- toObject :: (MonadIO m, IsObject o) => o -> m Object
- objectArgumentIsset :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Bool
- objectArgumentNeedsstring :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Bool
- objectBuild :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32
- objectGetArgumentFlags :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m [ArgumentFlags]
- objectGetArgumentPriority :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Int32
- objectGetArgumentToString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> Text -> m Int32
- objectGetDescription :: (HasCallStack, MonadIO m, IsObject a) => a -> m Text
- objectGetProperty :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> GValue -> GParamSpec -> m ()
- objectLocalCb :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> b -> m ()
- objectNewFromString :: (HasCallStack, MonadIO m) => ObjectClass -> Text -> m Object
- objectPreclose :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- objectPrintAll :: (HasCallStack, MonadIO m) => m ()
- objectPrintDump :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- objectPrintName :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- objectPrintSummary :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- objectPrintSummaryClass :: (HasCallStack, MonadIO m) => ObjectClass -> m ()
- objectRewind :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- objectSanity :: (HasCallStack, MonadIO m, IsObject a) => a -> m Bool
- objectSanityAll :: (HasCallStack, MonadIO m) => m ()
- objectSetArgumentFromString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> Text -> m Int32
- objectSetFromString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Int32
- objectSetProperty :: (HasCallStack, MonadIO m, IsObject a) => a -> Word32 -> GValue -> GParamSpec -> m ()
- objectSetStatic :: (HasCallStack, MonadIO m, IsObject a) => a -> Bool -> m ()
- objectUnrefOutputs :: (HasCallStack, MonadIO m, IsObject a) => a -> m ()
- clearObjectDescription :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectDescription :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectDescription :: (MonadIO m, IsObject o) => o -> m Text
- setObjectDescription :: (MonadIO m, IsObject o) => o -> Text -> m ()
- clearObjectNickname :: (MonadIO m, IsObject o) => o -> m ()
- constructObjectNickname :: (IsObject o, MonadIO m) => Text -> m (GValueConstruct o)
- getObjectNickname :: (MonadIO m, IsObject o) => o -> m (Maybe Text)
- setObjectNickname :: (MonadIO m, IsObject o) => o -> Text -> m ()
- type C_ObjectCloseCallback = Ptr () -> Ptr () -> IO ()
- type ObjectCloseCallback = IO ()
- afterObjectClose :: (IsObject a, MonadIO m) => a -> ObjectCloseCallback -> m SignalHandlerId
- genClosure_ObjectClose :: MonadIO m => ObjectCloseCallback -> m (GClosure C_ObjectCloseCallback)
- mk_ObjectCloseCallback :: C_ObjectCloseCallback -> IO (FunPtr C_ObjectCloseCallback)
- noObjectCloseCallback :: Maybe ObjectCloseCallback
- onObjectClose :: (IsObject a, MonadIO m) => a -> ObjectCloseCallback -> m SignalHandlerId
- wrap_ObjectCloseCallback :: ObjectCloseCallback -> C_ObjectCloseCallback
- type C_ObjectPostbuildCallback = Ptr () -> Ptr () -> IO Int32
- type ObjectPostbuildCallback = IO Int32
- afterObjectPostbuild :: (IsObject a, MonadIO m) => a -> ObjectPostbuildCallback -> m SignalHandlerId
- genClosure_ObjectPostbuild :: MonadIO m => ObjectPostbuildCallback -> m (GClosure C_ObjectPostbuildCallback)
- mk_ObjectPostbuildCallback :: C_ObjectPostbuildCallback -> IO (FunPtr C_ObjectPostbuildCallback)
- noObjectPostbuildCallback :: Maybe ObjectPostbuildCallback
- onObjectPostbuild :: (IsObject a, MonadIO m) => a -> ObjectPostbuildCallback -> m SignalHandlerId
- wrap_ObjectPostbuildCallback :: ObjectPostbuildCallback -> C_ObjectPostbuildCallback
- type C_ObjectPostcloseCallback = Ptr () -> Ptr () -> IO ()
- type ObjectPostcloseCallback = IO ()
- afterObjectPostclose :: (IsObject a, MonadIO m) => a -> ObjectPostcloseCallback -> m SignalHandlerId
- genClosure_ObjectPostclose :: MonadIO m => ObjectPostcloseCallback -> m (GClosure C_ObjectPostcloseCallback)
- mk_ObjectPostcloseCallback :: C_ObjectPostcloseCallback -> IO (FunPtr C_ObjectPostcloseCallback)
- noObjectPostcloseCallback :: Maybe ObjectPostcloseCallback
- onObjectPostclose :: (IsObject a, MonadIO m) => a -> ObjectPostcloseCallback -> m SignalHandlerId
- wrap_ObjectPostcloseCallback :: ObjectPostcloseCallback -> C_ObjectPostcloseCallback
- type C_ObjectPrecloseCallback = Ptr () -> Ptr () -> IO ()
- type ObjectPrecloseCallback = IO ()
- afterObjectPreclose :: (IsObject a, MonadIO m) => a -> ObjectPrecloseCallback -> m SignalHandlerId
- genClosure_ObjectPreclose :: MonadIO m => ObjectPrecloseCallback -> m (GClosure C_ObjectPrecloseCallback)
- mk_ObjectPrecloseCallback :: C_ObjectPrecloseCallback -> IO (FunPtr C_ObjectPrecloseCallback)
- noObjectPrecloseCallback :: Maybe ObjectPrecloseCallback
- onObjectPreclose :: (IsObject a, MonadIO m) => a -> ObjectPrecloseCallback -> m SignalHandlerId
- wrap_ObjectPrecloseCallback :: ObjectPrecloseCallback -> C_ObjectPrecloseCallback
Exported types
Memory-managed wrapper type.
Instances
Eq Object Source # | |
GObject Object Source # | |
Defined in GI.Vips.Objects.Object | |
ManagedPtrNewtype Object Source # | |
Defined in GI.Vips.Objects.Object toManagedPtr :: Object -> ManagedPtr Object | |
TypedObject Object Source # | |
Defined in GI.Vips.Objects.Object | |
HasParentTypes Object Source # | |
Defined in GI.Vips.Objects.Object | |
IsGValue (Maybe Object) Source # | Convert |
Defined in GI.Vips.Objects.Object gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Object -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Object) | |
type ParentTypes Object Source # | |
Defined in GI.Vips.Objects.Object type ParentTypes Object = '[Object] |
class (GObject o, IsDescendantOf Object o) => IsObject o Source #
Instances
(GObject o, IsDescendantOf Object o) => IsObject o Source # | |
Defined in GI.Vips.Objects.Object |
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, unref, unrefOutputs, watchClosure.
Getters
getArgumentFlags, getArgumentPriority, getArgumentToString, getData, getDescription, getQdata.
Setters
setArgumentFromString, setData, setDataFull, setFromString, setRequired, setStatic.
argumentIsset
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: |
Convenience: has an argument been assigned. Useful for bindings.
argumentNeedsstring
objectArgumentNeedsstring :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> m Bool Source #
No description available in the introspection data.
build
objectBuild :: (HasCallStack, MonadIO m, IsObject a) => a -> m Int32 Source #
No description available in the introspection data.
getArgumentFlags
objectGetArgumentFlags Source #
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> m [ArgumentFlags] | Returns: The |
Convenience: get the flags for an argument. Useful for bindings.
getArgumentPriority
objectGetArgumentPriority Source #
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> 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 Source #
No description available in the introspection data.
getDescription
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> 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 () Source #
No description available in the introspection data.
localCb
objectLocalCb :: (HasCallStack, MonadIO m, IsObject a, IsObject b) => a -> b -> m () Source #
No description available in the introspection data.
newFromString
objectNewFromString :: (HasCallStack, MonadIO m) => ObjectClass -> Text -> m Object Source #
No description available in the introspection data.
preclose
objectPreclose :: (HasCallStack, MonadIO m, IsObject a) => a -> m () Source #
No description available in the introspection data.
printAll
objectPrintAll :: (HasCallStack, MonadIO m) => m () Source #
No description available in the introspection data.
printDump
objectPrintDump :: (HasCallStack, MonadIO m, IsObject a) => a -> m () Source #
No description available in the introspection data.
printName
objectPrintName :: (HasCallStack, MonadIO m, IsObject a) => a -> m () Source #
No description available in the introspection data.
printSummary
objectPrintSummary :: (HasCallStack, MonadIO m, IsObject a) => a -> m () Source #
No description available in the introspection data.
printSummaryClass
objectPrintSummaryClass :: (HasCallStack, MonadIO m) => ObjectClass -> m () Source #
No description available in the introspection data.
rewind
objectRewind :: (HasCallStack, MonadIO m, IsObject a) => a -> m () Source #
No description available in the introspection data.
sanity
objectSanity :: (HasCallStack, MonadIO m, IsObject a) => a -> m Bool Source #
No description available in the introspection data.
sanityAll
objectSanityAll :: (HasCallStack, MonadIO m) => m () Source #
No description available in the introspection data.
setArgumentFromString
objectSetArgumentFromString :: (HasCallStack, MonadIO m, IsObject a) => a -> Text -> Text -> m Int32 Source #
No description available in the introspection data.
setFromString
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> Text |
|
-> 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 () Source #
No description available in the introspection data.
setStatic
objectSetStatic :: (HasCallStack, MonadIO m, IsObject a) => a -> Bool -> m () Source #
No description available in the introspection data.
unrefOutputs
:: (HasCallStack, MonadIO m, IsObject a) | |
=> a |
|
-> 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 () Source #
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) Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “nickname
” property.
When overloading is enabled, this is equivalent to
set
object [ #nickname:=
value ]
Signals
close
type C_ObjectCloseCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ObjectCloseCallback = IO () Source #
The close signal is emitted once during object close. The object is dying and may not work.
afterObjectClose :: (IsObject a, MonadIO m) => a -> ObjectCloseCallback -> m SignalHandlerId Source #
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
genClosure_ObjectClose :: MonadIO m => ObjectCloseCallback -> m (GClosure C_ObjectCloseCallback) Source #
Wrap the callback into a GClosure
.
mk_ObjectCloseCallback :: C_ObjectCloseCallback -> IO (FunPtr C_ObjectCloseCallback) Source #
Generate a function pointer callable from C code, from a C_ObjectCloseCallback
.
noObjectCloseCallback :: Maybe ObjectCloseCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ObjectCloseCallback
onObjectClose :: (IsObject a, MonadIO m) => a -> ObjectCloseCallback -> m SignalHandlerId Source #
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
wrap_ObjectCloseCallback :: ObjectCloseCallback -> C_ObjectCloseCallback Source #
Wrap a ObjectCloseCallback
into a C_ObjectCloseCallback
.
postbuild
type C_ObjectPostbuildCallback = Ptr () -> Ptr () -> IO Int32 Source #
Type for the callback on the (unwrapped) C side.
type ObjectPostbuildCallback = IO Int32 Source #
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 -> ObjectPostbuildCallback -> m SignalHandlerId Source #
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
genClosure_ObjectPostbuild :: MonadIO m => ObjectPostbuildCallback -> m (GClosure C_ObjectPostbuildCallback) Source #
Wrap the callback into a GClosure
.
mk_ObjectPostbuildCallback :: C_ObjectPostbuildCallback -> IO (FunPtr C_ObjectPostbuildCallback) Source #
Generate a function pointer callable from C code, from a C_ObjectPostbuildCallback
.
noObjectPostbuildCallback :: Maybe ObjectPostbuildCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ObjectPostbuildCallback
onObjectPostbuild :: (IsObject a, MonadIO m) => a -> ObjectPostbuildCallback -> m SignalHandlerId Source #
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
wrap_ObjectPostbuildCallback :: ObjectPostbuildCallback -> C_ObjectPostbuildCallback Source #
Wrap a ObjectPostbuildCallback
into a C_ObjectPostbuildCallback
.
postclose
type C_ObjectPostcloseCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ObjectPostcloseCallback = IO () Source #
The postclose signal is emitted once after object close. The object pointer is still valid, but nothing else.
afterObjectPostclose :: (IsObject a, MonadIO m) => a -> ObjectPostcloseCallback -> m SignalHandlerId Source #
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
genClosure_ObjectPostclose :: MonadIO m => ObjectPostcloseCallback -> m (GClosure C_ObjectPostcloseCallback) Source #
Wrap the callback into a GClosure
.
mk_ObjectPostcloseCallback :: C_ObjectPostcloseCallback -> IO (FunPtr C_ObjectPostcloseCallback) Source #
Generate a function pointer callable from C code, from a C_ObjectPostcloseCallback
.
noObjectPostcloseCallback :: Maybe ObjectPostcloseCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ObjectPostcloseCallback
onObjectPostclose :: (IsObject a, MonadIO m) => a -> ObjectPostcloseCallback -> m SignalHandlerId Source #
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
wrap_ObjectPostcloseCallback :: ObjectPostcloseCallback -> C_ObjectPostcloseCallback Source #
Wrap a ObjectPostcloseCallback
into a C_ObjectPostcloseCallback
.
preclose
type C_ObjectPrecloseCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ObjectPrecloseCallback = IO () Source #
The preclose signal is emitted once just before object close starts. The oject is still alive.
afterObjectPreclose :: (IsObject a, MonadIO m) => a -> ObjectPrecloseCallback -> m SignalHandlerId Source #
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
genClosure_ObjectPreclose :: MonadIO m => ObjectPrecloseCallback -> m (GClosure C_ObjectPrecloseCallback) Source #
Wrap the callback into a GClosure
.
mk_ObjectPrecloseCallback :: C_ObjectPrecloseCallback -> IO (FunPtr C_ObjectPrecloseCallback) Source #
Generate a function pointer callable from C code, from a C_ObjectPrecloseCallback
.
noObjectPrecloseCallback :: Maybe ObjectPrecloseCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ObjectPrecloseCallback
onObjectPreclose :: (IsObject a, MonadIO m) => a -> ObjectPrecloseCallback -> m SignalHandlerId Source #
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