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

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

GObject AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

Methods

gobjectType :: IO GType

HasParentTypes AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

type ParentTypes AspectFrame

Defined in GI.Gtk.Objects.AspectFrame

type ParentTypes AspectFrame = '[Frame, Bin, Container, Widget, Object, ImplementorIface, Buildable]

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.

noAspectFrame :: Maybe AspectFrame

A convenience alias for Nothing :: Maybe AspectFrame.

Methods

Overloaded methods

new

aspectFrameNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

label: Label text.

-> 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.

set

aspectFrameSet

Arguments

:: (HasCallStack, MonadIO m, IsAspectFrame a)

=> a

aspectFrame: a AspectFrame

-> 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 ()

Set parameters for an existing AspectFrame.

Properties

obeyChild

No description available in the introspection data.

constructAspectFrameObeyChild :: IsAspectFrame o => Bool -> IO (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 => Float -> IO (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 => Float -> IO (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 => Float -> IO (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 ]