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

GI.Gtk.Objects.ConstraintGuide

Contents

Exported types
Methods
Properties

Description

A ConstraintGuide is an invisible layout element that can be used by widgets inside a ConstraintLayout as a source or a target of a Constraint. Guides can be used like guidelines or as flexible space.

Unlike a Widget, a ConstraintGuide will not be drawn.

Synopsis

newtype ConstraintGuide = ConstraintGuide (ManagedPtr ConstraintGuide)
class (GObject o, IsDescendantOf ConstraintGuide o) => IsConstraintGuide o
toConstraintGuide :: (MonadIO m, IsConstraintGuide o) => o -> m ConstraintGuide
constraintGuideGetMaxSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideGetMinSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideGetName :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> m (Maybe Text)
constraintGuideGetNatSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideGetStrength :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> m ConstraintStrength
constraintGuideNew :: (HasCallStack, MonadIO m) => m ConstraintGuide
constraintGuideSetMaxSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideSetMinSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideSetName :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Maybe Text -> m ()
constraintGuideSetNatSize :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> Int32 -> Int32 -> m ()
constraintGuideSetStrength :: (HasCallStack, MonadIO m, IsConstraintGuide a) => a -> ConstraintStrength -> m ()
constructConstraintGuideMaxHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideMaxHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideMaxHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
constructConstraintGuideMaxWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideMaxWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideMaxWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
constructConstraintGuideMinHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideMinHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideMinHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
constructConstraintGuideMinWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideMinWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideMinWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
clearConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> m ()
constructConstraintGuideName :: (IsConstraintGuide o, MonadIO m) => Text -> m (GValueConstruct o)
getConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> m (Maybe Text)
setConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> Text -> m ()
constructConstraintGuideNatHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideNatHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideNatHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
constructConstraintGuideNatWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o)
getConstraintGuideNatWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32
setConstraintGuideNatWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m ()
constructConstraintGuideStrength :: (IsConstraintGuide o, MonadIO m) => ConstraintStrength -> m (GValueConstruct o)
getConstraintGuideStrength :: (MonadIO m, IsConstraintGuide o) => o -> m ConstraintStrength
setConstraintGuideStrength :: (MonadIO m, IsConstraintGuide o) => o -> ConstraintStrength -> m ()

Exported types

newtype ConstraintGuide Source #

Memory-managed wrapper type.

Constructors

ConstraintGuide (ManagedPtr ConstraintGuide)

Instances

Instances details

Eq ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide Methods (==) :: ConstraintGuide -> ConstraintGuide -> Bool # (/=) :: ConstraintGuide -> ConstraintGuide -> Bool #
GObject ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide
ManagedPtrNewtype ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide Methods toManagedPtr :: ConstraintGuide -> ManagedPtr ConstraintGuide
TypedObject ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide Methods glibType :: IO GType
HasParentTypes ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide
IsGValue (Maybe ConstraintGuide) Source #	Convert `ConstraintGuide` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ConstraintGuide Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ConstraintGuide -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ConstraintGuide)
type ParentTypes ConstraintGuide Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide type ParentTypes ConstraintGuide = '[Object, ConstraintTarget]

class (GObject o, IsDescendantOf ConstraintGuide o) => IsConstraintGuide o Source #

Type class for types which can be safely cast to ConstraintGuide, for instance with toConstraintGuide.

Instances

Instances details

(GObject o, IsDescendantOf ConstraintGuide o) => IsConstraintGuide o Source #
Instance details Defined in GI.Gtk.Objects.ConstraintGuide

toConstraintGuide :: (MonadIO m, IsConstraintGuide o) => o -> m ConstraintGuide Source #

Cast to ConstraintGuide, 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

Expand

getMaxSize

constraintGuideGetMaxSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: return location for the maximum width, or `Nothing`
-> Int32	`height`: return location for the maximum height, or `Nothing`
-> m ()

Gets the maximum size of guide.

getMinSize

constraintGuideGetMinSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: return location for the minimum width, or `Nothing`
-> Int32	`height`: return location for the minimum height, or `Nothing`
-> m ()

Gets the minimum size of guide.

getName

constraintGuideGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide`
-> m (Maybe Text)	Returns: the name of the guide

Retrieves the name set using constraintGuideSetName.

getNatSize

constraintGuideGetNatSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: return location for the natural width, or `Nothing`
-> Int32	`height`: return location for the natural height, or `Nothing`
-> m ()

Gets the natural size of guide.

getStrength

constraintGuideGetStrength Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide`
-> m ConstraintStrength	Returns: the strength of the constraint on the natural size

Retrieves the strength set using constraintGuideSetStrength.

new

constraintGuideNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m ConstraintGuide	Returns: a new `ConstraintGuide` object.

Creates a new ConstraintGuide object.

setMaxSize

constraintGuideSetMaxSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: the new maximum width, or -1 to not change it
-> Int32	`height`: the new maximum height, or -1 to not change it
-> m ()

Sets the maximum size of guide.

If guide is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

setMinSize

constraintGuideSetMinSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: the new minimum width, or -1 to not change it
-> Int32	`height`: the new minimum height, or -1 to not change it
-> m ()

Sets the minimum size of guide.

If guide is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

setName

constraintGuideSetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide`
-> Maybe Text	`name`: a name for the `guide`
-> m ()

Sets a name for the given ConstraintGuide.

The name is useful for debugging purposes.

setNatSize

constraintGuideSetNatSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide` object
-> Int32	`width`: the new natural width, or -1 to not change it
-> Int32	`height`: the new natural height, or -1 to not change it
-> m ()

Sets the natural size of guide.

If guide is attached to a ConstraintLayout, the constraints will be updated to reflect the new size.

setStrength

constraintGuideSetStrength Source #

Arguments

:: (HasCallStack, MonadIO m, IsConstraintGuide a)
=> a	`guide`: a `ConstraintGuide`
-> ConstraintStrength	`strength`: the strength of the constraint
-> m ()

Sets the strength of the constraint on the natural size of the given ConstraintGuide.

Properties

maxHeight

The maximum height of the guide.

constructConstraintGuideMaxHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideMaxHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #maxHeight

setConstraintGuideMaxHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #maxHeight := value ]

maxWidth

The maximum width of the guide.

constructConstraintGuideMaxWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideMaxWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #maxWidth

setConstraintGuideMaxWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #maxWidth := value ]

minHeight

The minimum height of the guide.

constructConstraintGuideMinHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideMinHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #minHeight

setConstraintGuideMinHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #minHeight := value ]

minWidth

The minimum width of the guide.

constructConstraintGuideMinWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideMinWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #minWidth

setConstraintGuideMinWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #minWidth := value ]

name

A name that identifies the ConstraintGuide, for debugging.

clearConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> m () Source #

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

clear #name

constructConstraintGuideName :: (IsConstraintGuide o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> m (Maybe Text) Source #

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

get constraintGuide #name

setConstraintGuideName :: (MonadIO m, IsConstraintGuide o) => o -> Text -> m () Source #

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

set constraintGuide [ #name := value ]

natHeight

The preferred, or natural, height of the guide.

constructConstraintGuideNatHeight :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideNatHeight :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #natHeight

setConstraintGuideNatHeight :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #natHeight := value ]

natWidth

The preferred, or natural, width of the guide.

constructConstraintGuideNatWidth :: (IsConstraintGuide o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getConstraintGuideNatWidth :: (MonadIO m, IsConstraintGuide o) => o -> m Int32 Source #

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

get constraintGuide #natWidth

setConstraintGuideNatWidth :: (MonadIO m, IsConstraintGuide o) => o -> Int32 -> m () Source #

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

set constraintGuide [ #natWidth := value ]

strength

The ConstraintStrength to be used for the constraint on the natural size of the guide.

constructConstraintGuideStrength :: (IsConstraintGuide o, MonadIO m) => ConstraintStrength -> m (GValueConstruct o) Source #

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

getConstraintGuideStrength :: (MonadIO m, IsConstraintGuide o) => o -> m ConstraintStrength Source #

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

get constraintGuide #strength

setConstraintGuideStrength :: (MonadIO m, IsConstraintGuide o) => o -> ConstraintStrength -> m () Source #

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

set constraintGuide [ #strength := value ]

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getMaxSize

getMinSize

getName

getNatSize

getStrength

new

setMaxSize

setMinSize

setName

setNatSize

setStrength

Properties

maxHeight

maxWidth

minHeight

minWidth

name

natHeight

natWidth

strength