gi-gtk-3.0.27: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.AspectFrame

Contents

Description

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.

Synopsis

Exported types

newtype AspectFrame Source #

Memory-managed wrapper type.

class GObject o => IsAspectFrame o Source #

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

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

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

Methods

new

aspectFrameNew Source #

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 Source #

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) Source #

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 Source #

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

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) Source #

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 Source #

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

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) Source #

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 Source #

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

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) Source #

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 Source #

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

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

set aspectFrame [ #yalign := value ]