| 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 |
GI.Clutter.Objects.PathConstraint
Description
PathConstraint is an opaque structure
whose members cannot be directly accessed
Since: 1.6
Synopsis
- newtype PathConstraint = PathConstraint (ManagedPtr PathConstraint)
- class (GObject o, IsDescendantOf PathConstraint o) => IsPathConstraint o
- toPathConstraint :: (MonadIO m, IsPathConstraint o) => o -> m PathConstraint
- pathConstraintGetOffset :: (HasCallStack, MonadIO m, IsPathConstraint a) => a -> m Float
- pathConstraintGetPath :: (HasCallStack, MonadIO m, IsPathConstraint a) => a -> m Path
- pathConstraintNew :: (HasCallStack, MonadIO m, IsPath a) => Maybe a -> Float -> m PathConstraint
- pathConstraintSetOffset :: (HasCallStack, MonadIO m, IsPathConstraint a) => a -> Float -> m ()
- pathConstraintSetPath :: (HasCallStack, MonadIO m, IsPathConstraint a, IsPath b) => a -> Maybe b -> m ()
- constructPathConstraintOffset :: (IsPathConstraint o, MonadIO m) => Float -> m (GValueConstruct o)
- getPathConstraintOffset :: (MonadIO m, IsPathConstraint o) => o -> m Float
- setPathConstraintOffset :: (MonadIO m, IsPathConstraint o) => o -> Float -> m ()
- clearPathConstraintPath :: (MonadIO m, IsPathConstraint o) => o -> m ()
- constructPathConstraintPath :: (IsPathConstraint o, MonadIO m, IsPath a) => a -> m (GValueConstruct o)
- getPathConstraintPath :: (MonadIO m, IsPathConstraint o) => o -> m Path
- setPathConstraintPath :: (MonadIO m, IsPathConstraint o, IsPath a) => o -> a -> m ()
- type PathConstraintNodeReachedCallback = Actor -> Word32 -> IO ()
- afterPathConstraintNodeReached :: (IsPathConstraint a, MonadIO m) => a -> ((?self :: a) => PathConstraintNodeReachedCallback) -> m SignalHandlerId
- onPathConstraintNodeReached :: (IsPathConstraint a, MonadIO m) => a -> ((?self :: a) => PathConstraintNodeReachedCallback) -> m SignalHandlerId
Exported types
newtype PathConstraint Source #
Memory-managed wrapper type.
Constructors
| PathConstraint (ManagedPtr PathConstraint) |
Instances
| Eq PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint Methods (==) :: PathConstraint -> PathConstraint -> Bool # (/=) :: PathConstraint -> PathConstraint -> Bool # | |
| GObject PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint | |
| ManagedPtrNewtype PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint Methods toManagedPtr :: PathConstraint -> ManagedPtr PathConstraint | |
| TypedObject PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint | |
| HasParentTypes PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint | |
| IsGValue (Maybe PathConstraint) Source # | Convert |
Defined in GI.Clutter.Objects.PathConstraint Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe PathConstraint -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe PathConstraint) | |
| type ParentTypes PathConstraint Source # | |
Defined in GI.Clutter.Objects.PathConstraint | |
class (GObject o, IsDescendantOf PathConstraint o) => IsPathConstraint o Source #
Type class for types which can be safely cast to PathConstraint, for instance with toPathConstraint.
Instances
| (GObject o, IsDescendantOf PathConstraint o) => IsPathConstraint o Source # | |
Defined in GI.Clutter.Objects.PathConstraint | |
toPathConstraint :: (MonadIO m, IsPathConstraint o) => o -> m PathConstraint Source #
Cast to PathConstraint, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getActor, getData, getEnabled, getName, getOffset, getPath, getProperty, getQdata.
Setters
setData, setDataFull, setEnabled, setName, setOffset, setPath, setProperty.
getOffset
pathConstraintGetOffset Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPathConstraint a) | |
| => a |
|
| -> m Float | Returns: the offset |
Retrieves the offset along the Path used by constraint.
Since: 1.6
getPath
pathConstraintGetPath Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPathConstraint a) | |
| => a |
|
| -> m Path | Returns: the |
Retrieves a pointer to the Path used by constraint.
Since: 1.6
new
Arguments
| :: (HasCallStack, MonadIO m, IsPath a) | |
| => Maybe a | |
| -> Float |
|
| -> m PathConstraint | Returns: the newly created |
Creates a new PathConstraint with the given path and offset
Since: 1.6
setOffset
pathConstraintSetOffset Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPathConstraint a) | |
| => a |
|
| -> Float |
|
| -> m () |
Sets the offset along the Path used by constraint.
Since: 1.6
setPath
pathConstraintSetPath Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPathConstraint a, IsPath b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
Sets the path to be followed by the PathConstraint.
The constraint will take ownership of the Path passed to this
function.
Since: 1.6
Properties
offset
The offset along the PathConstraint:path, between -1.0 and 2.0.
Since: 1.6
constructPathConstraintOffset :: (IsPathConstraint o, MonadIO m) => Float -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “offset” property. This is rarely needed directly, but it is used by new.
getPathConstraintOffset :: (MonadIO m, IsPathConstraint o) => o -> m Float Source #
Get the value of the “offset” property.
When overloading is enabled, this is equivalent to
get pathConstraint #offset
setPathConstraintOffset :: (MonadIO m, IsPathConstraint o) => o -> Float -> m () Source #
Set the value of the “offset” property.
When overloading is enabled, this is equivalent to
setpathConstraint [ #offset:=value ]
path
The Path used to constrain the position of an actor.
Since: 1.6
clearPathConstraintPath :: (MonadIO m, IsPathConstraint o) => o -> m () Source #
Set the value of the “path” property to Nothing.
When overloading is enabled, this is equivalent to
clear #path
constructPathConstraintPath :: (IsPathConstraint o, MonadIO m, IsPath a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “path” property. This is rarely needed directly, but it is used by new.
getPathConstraintPath :: (MonadIO m, IsPathConstraint o) => o -> m Path Source #
Get the value of the “path” property.
When overloading is enabled, this is equivalent to
get pathConstraint #path
setPathConstraintPath :: (MonadIO m, IsPathConstraint o, IsPath a) => o -> a -> m () Source #
Set the value of the “path” property.
When overloading is enabled, this is equivalent to
setpathConstraint [ #path:=value ]
Signals
nodeReached
type PathConstraintNodeReachedCallback Source #
Arguments
| = Actor |
|
| -> Word32 |
|
| -> IO () |
The nodeReached signal is emitted each time a
PathConstraint:offset value results in the actor
passing a PathNode
Since: 1.6
afterPathConstraintNodeReached :: (IsPathConstraint a, MonadIO m) => a -> ((?self :: a) => PathConstraintNodeReachedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the nodeReached signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after pathConstraint #nodeReached 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.
onPathConstraintNodeReached :: (IsPathConstraint a, MonadIO m) => a -> ((?self :: a) => PathConstraintNodeReachedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the nodeReached signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on pathConstraint #nodeReached callback