GI.Gtk.Objects.AspectFrame

The AspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. AspectFrame derives from Frame, so it can draw a label and a frame around the child. The frame will be “shrink-wrapped” to the size of the child.

CSS nodes

GtkAspectFrame uses a CSS node with name frame.

Exported types

newtype AspectFrame

Memory-managed wrapper type.

Constructors

AspectFrame (ManagedPtr AspectFrame)

Instances

Eq AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

Methods

(==) :: AspectFrame -> AspectFrame -> Bool

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

GObject AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

ManagedPtrNewtype AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

Methods

toManagedPtr :: AspectFrame -> ManagedPtr AspectFrame

TypedObject AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

Methods

glibType :: IO GType

IsGValue AspectFrame

Convert AspectFrame to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.AspectFrame

Methods

toGValue :: AspectFrame -> IO GValue

fromGValue :: GValue -> IO AspectFrame

HasParentTypes AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

type ParentTypes AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

type ParentTypes AspectFrame = '[Widget, Object, ImplementorIface, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf AspectFrame o) => IsAspectFrame o

Type class for types which can be safely cast to AspectFrame, for instance with toAspectFrame.

Instances

(GObject o, IsDescendantOf AspectFrame o) => IsAspectFrame o

Defined in GI.Gtk.Objects.AspectFrame

toAspectFrame :: (MonadIO m, IsAspectFrame o) => o -> m AspectFrame

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

Methods

Overloaded methods

getChild

aspectFrameGetChild

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> m (Maybe Widget)

Returns: the child widget of self@

Gets the child widget of self.

getObeyChild

aspectFrameGetObeyChild

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> m Bool

Returns: whether to obey the childs size request

Returns whether the childs size request should override the set aspect ratio of the AspectFrame.

getRatio

aspectFrameGetRatio

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> m Float

Returns: the desired aspect ratio

Returns the desired aspect ratio of the child.

getXalign

aspectFrameGetXalign

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> m Float

Returns: the horizontal alignment

Returns the horizontal alignment of the child within the allocation of the AspectFrame.

getYalign

aspectFrameGetYalign

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> m Float

Returns: the vertical alignment

Returns the vertical alignment of the child within the allocation of the AspectFrame.

new

aspectFrameNew

Arguments

:: (HasCallStack, MonadIO m)

=> Float

xalign: Horizontal alignment of the child within the allocation of the AspectFrame. This ranges from 0.0 (left aligned) to 1.0 (right aligned)

-> Float

yalign: Vertical alignment of the child within the allocation of the AspectFrame. This ranges from 0.0 (top aligned) to 1.0 (bottom aligned)

-> Float

ratio: The desired aspect ratio.

-> Bool

obeyChild: If True, ratio is ignored, and the aspect ratio is taken from the requistion of the child.

-> m AspectFrame

Returns: the new AspectFrame.

Create a new AspectFrame.

setChild

aspectFrameSetChild

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a, IsWidget b)

=> a

self: a AspectFrame

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of self.

setObeyChild

aspectFrameSetObeyChild

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> Bool

obeyChild: If True, ratio is ignored, and the aspect ratio is taken from the requistion of the child.

-> m ()

Sets whether the aspect ratio of the childs size request should override the set aspect ratio of the AspectFrame.

setRatio

aspectFrameSetRatio

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> Float

ratio: aspect ratio of the child

-> m ()

Sets the desired aspect ratio of the child.

setXalign

aspectFrameSetXalign

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> Float

xalign: horizontal alignment, from 0.0 (left aligned) to 1.0 (right aligned)

-> m ()

Sets the horizontal alignment of the child within the allocation of the AspectFrame.

setYalign

aspectFrameSetYalign

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

self: a AspectFrame

-> Float

yalign: horizontal alignment, from 0.0 (top aligned) to 1.0 (bottom aligned)

-> m ()

Sets the vertical alignment of the child within the allocation of the AspectFrame.

Properties

child

No description available in the introspection data.

clearAspectFrameChild :: (MonadIO m, IsAspectFrame o) => o -> m ()

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

clear #child

constructAspectFrameChild :: (IsAspectFrame o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getAspectFrameChild :: (MonadIO m, IsAspectFrame o) => o -> m (Maybe Widget)

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

get aspectFrame #child

setAspectFrameChild :: (MonadIO m, IsAspectFrame o, IsWidget a) => o -> a -> m ()

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

set aspectFrame [ #child := value ]

obeyChild

No description available in the introspection data.

constructAspectFrameObeyChild :: (IsAspectFrame o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getAspectFrameObeyChild :: (MonadIO m, IsAspectFrame o) => o -> m Bool

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

get aspectFrame #obeyChild

setAspectFrameObeyChild :: (MonadIO m, IsAspectFrame o) => o -> Bool -> m ()

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

set aspectFrame [ #obeyChild := value ]

ratio

No description available in the introspection data.

constructAspectFrameRatio :: (IsAspectFrame o, MonadIO m) => Float -> m (GValueConstruct o)

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

getAspectFrameRatio :: (MonadIO m, IsAspectFrame o) => o -> m Float

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

get aspectFrame #ratio

setAspectFrameRatio :: (MonadIO m, IsAspectFrame o) => o -> Float -> m ()

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

set aspectFrame [ #ratio := value ]

xalign

No description available in the introspection data.

constructAspectFrameXalign :: (IsAspectFrame o, MonadIO m) => Float -> m (GValueConstruct o)

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

getAspectFrameXalign :: (MonadIO m, IsAspectFrame o) => o -> m Float

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

get aspectFrame #xalign

setAspectFrameXalign :: (MonadIO m, IsAspectFrame o) => o -> Float -> m ()

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

set aspectFrame [ #xalign := value ]

yalign

No description available in the introspection data.

constructAspectFrameYalign :: (IsAspectFrame o, MonadIO m) => Float -> m (GValueConstruct o)

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

getAspectFrameYalign :: (MonadIO m, IsAspectFrame o) => o -> m Float

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

get aspectFrame #yalign

setAspectFrameYalign :: (MonadIO m, IsAspectFrame o) => o -> Float -> m ()

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

set aspectFrame [ #yalign := value ]