| 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.SnapConstraint
Description
SnapConstraint is an opaque structure
whose members cannot be directly accesses
Since: 1.6
Synopsis
- newtype SnapConstraint = SnapConstraint (ManagedPtr SnapConstraint)
- class (GObject o, IsDescendantOf SnapConstraint o) => IsSnapConstraint o
- toSnapConstraint :: (MonadIO m, IsSnapConstraint o) => o -> m SnapConstraint
- snapConstraintGetEdges :: (HasCallStack, MonadIO m, IsSnapConstraint a) => a -> m (SnapEdge, SnapEdge)
- snapConstraintGetOffset :: (HasCallStack, MonadIO m, IsSnapConstraint a) => a -> m Float
- snapConstraintGetSource :: (HasCallStack, MonadIO m, IsSnapConstraint a) => a -> m Actor
- snapConstraintNew :: (HasCallStack, MonadIO m, IsActor a) => Maybe a -> SnapEdge -> SnapEdge -> Float -> m SnapConstraint
- snapConstraintSetEdges :: (HasCallStack, MonadIO m, IsSnapConstraint a) => a -> SnapEdge -> SnapEdge -> m ()
- snapConstraintSetOffset :: (HasCallStack, MonadIO m, IsSnapConstraint a) => a -> Float -> m ()
- snapConstraintSetSource :: (HasCallStack, MonadIO m, IsSnapConstraint a, IsActor b) => a -> Maybe b -> m ()
- constructSnapConstraintFromEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o)
- getSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge
- setSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m ()
- constructSnapConstraintOffset :: (IsSnapConstraint o, MonadIO m) => Float -> m (GValueConstruct o)
- getSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> m Float
- setSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> Float -> m ()
- clearSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m ()
- constructSnapConstraintSource :: (IsSnapConstraint o, MonadIO m, IsActor a) => a -> m (GValueConstruct o)
- getSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m Actor
- setSnapConstraintSource :: (MonadIO m, IsSnapConstraint o, IsActor a) => o -> a -> m ()
- constructSnapConstraintToEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o)
- getSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge
- setSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m ()
Exported types
newtype SnapConstraint Source #
Memory-managed wrapper type.
Constructors
| SnapConstraint (ManagedPtr SnapConstraint) |
Instances
| Eq SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint Methods (==) :: SnapConstraint -> SnapConstraint -> Bool # (/=) :: SnapConstraint -> SnapConstraint -> Bool # | |
| GObject SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint | |
| ManagedPtrNewtype SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint Methods toManagedPtr :: SnapConstraint -> ManagedPtr SnapConstraint | |
| TypedObject SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint | |
| HasParentTypes SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint | |
| IsGValue (Maybe SnapConstraint) Source # | Convert |
Defined in GI.Clutter.Objects.SnapConstraint Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe SnapConstraint -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe SnapConstraint) | |
| type ParentTypes SnapConstraint Source # | |
Defined in GI.Clutter.Objects.SnapConstraint | |
class (GObject o, IsDescendantOf SnapConstraint o) => IsSnapConstraint o Source #
Type class for types which can be safely cast to SnapConstraint, for instance with toSnapConstraint.
Instances
| (GObject o, IsDescendantOf SnapConstraint o) => IsSnapConstraint o Source # | |
Defined in GI.Clutter.Objects.SnapConstraint | |
toSnapConstraint :: (MonadIO m, IsSnapConstraint o) => o -> m SnapConstraint Source #
Cast to SnapConstraint, 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, getEdges, getEnabled, getName, getOffset, getProperty, getQdata, getSource.
Setters
setData, setDataFull, setEdges, setEnabled, setName, setOffset, setProperty, setSource.
getEdges
snapConstraintGetEdges Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a) | |
| => a |
|
| -> m (SnapEdge, SnapEdge) |
Retrieves the edges used by the constraint
Since: 1.6
getOffset
snapConstraintGetOffset Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a) | |
| => a |
|
| -> m Float | Returns: the offset, in pixels |
Retrieves the offset set using snapConstraintSetOffset
Since: 1.6
getSource
snapConstraintGetSource Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a) | |
| => a |
|
| -> m Actor | Returns: a pointer to the source actor |
Retrieves the Actor set using snapConstraintSetSource
Since: 1.6
new
Arguments
| :: (HasCallStack, MonadIO m, IsActor a) | |
| => Maybe a |
|
| -> SnapEdge |
|
| -> SnapEdge |
|
| -> Float |
|
| -> m SnapConstraint | Returns: the newly created |
Creates a new SnapConstraint that will snap a Actor
to the edge of source, with the given offset.
Since: 1.6
setEdges
snapConstraintSetEdges Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a) | |
| => a |
|
| -> SnapEdge |
|
| -> SnapEdge |
|
| -> m () |
Sets the edges to be used by the constraint
The fromEdge is the edge on the Actor to which constraint
has been added. The toEdge is the edge of the Actor inside
the SnapConstraint:source property.
Since: 1.6
setOffset
snapConstraintSetOffset Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a) | |
| => a |
|
| -> Float |
|
| -> m () |
Sets the offset to be applied to the constraint
Since: 1.6
setSource
snapConstraintSetSource Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSnapConstraint a, IsActor b) | |
| => a |
|
| -> Maybe b | |
| -> m () |
Sets the source Actor for the constraint
Since: 1.6
Properties
fromEdge
The edge of the Actor that should be snapped
Since: 1.6
constructSnapConstraintFromEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “from-edge” property. This is rarely needed directly, but it is used by new.
getSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge Source #
Get the value of the “from-edge” property.
When overloading is enabled, this is equivalent to
get snapConstraint #fromEdge
setSnapConstraintFromEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m () Source #
Set the value of the “from-edge” property.
When overloading is enabled, this is equivalent to
setsnapConstraint [ #fromEdge:=value ]
offset
The offset, in pixels, between SnapConstraint:fromEdge and SnapConstraint:toEdge
Since: 1.6
constructSnapConstraintOffset :: (IsSnapConstraint 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.
getSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> m Float Source #
Get the value of the “offset” property.
When overloading is enabled, this is equivalent to
get snapConstraint #offset
setSnapConstraintOffset :: (MonadIO m, IsSnapConstraint o) => o -> Float -> m () Source #
Set the value of the “offset” property.
When overloading is enabled, this is equivalent to
setsnapConstraint [ #offset:=value ]
source
The Actor used as the source for the constraint
Since: 1.6
clearSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m () Source #
Set the value of the “source” property to Nothing.
When overloading is enabled, this is equivalent to
clear #source
constructSnapConstraintSource :: (IsSnapConstraint o, MonadIO m, IsActor a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “source” property. This is rarely needed directly, but it is used by new.
getSnapConstraintSource :: (MonadIO m, IsSnapConstraint o) => o -> m Actor Source #
Get the value of the “source” property.
When overloading is enabled, this is equivalent to
get snapConstraint #source
setSnapConstraintSource :: (MonadIO m, IsSnapConstraint o, IsActor a) => o -> a -> m () Source #
Set the value of the “source” property.
When overloading is enabled, this is equivalent to
setsnapConstraint [ #source:=value ]
toEdge
The edge of the SnapConstraint:source that should be snapped
Since: 1.6
constructSnapConstraintToEdge :: (IsSnapConstraint o, MonadIO m) => SnapEdge -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “to-edge” property. This is rarely needed directly, but it is used by new.
getSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> m SnapEdge Source #
Get the value of the “to-edge” property.
When overloading is enabled, this is equivalent to
get snapConstraint #toEdge
setSnapConstraintToEdge :: (MonadIO m, IsSnapConstraint o) => o -> SnapEdge -> m () Source #
Set the value of the “to-edge” property.
When overloading is enabled, this is equivalent to
setsnapConstraint [ #toEdge:=value ]