gi-poppler-0.18.27: Poppler bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Poppler.Structs.PageTransition

Description

A PageTransition structures describes a visual transition to use when moving between pages during a presentation

Synopsis

Exported types

newtype PageTransition Source #

Memory-managed wrapper type.

Constructors

PageTransition (ManagedPtr PageTransition) 

Instances

Instances details
Eq PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

GBoxed PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

ManagedPtrNewtype PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

TypedObject PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

Methods

glibType :: IO GType

HasParentTypes PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

tag ~ 'AttrSet => Constructible PageTransition tag Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

Methods

new :: MonadIO m => (ManagedPtr PageTransition -> PageTransition) -> [AttrOp PageTransition tag] -> m PageTransition

IsGValue (Maybe PageTransition) Source #

Convert PageTransition to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Poppler.Structs.PageTransition

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe PageTransition -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe PageTransition)

type ParentTypes PageTransition Source # 
Instance details

Defined in GI.Poppler.Structs.PageTransition

type ParentTypes PageTransition = '[] :: [Type]

newZeroPageTransition :: MonadIO m => m PageTransition Source #

Construct a PageTransition struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free.

Getters

None.

Setters

None.

copy

pageTransitionCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> PageTransition

transition: a PageTransition to copy

-> m PageTransition

Returns: a new allocated copy of transition

Creates a copy of transition

free

pageTransitionFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> PageTransition

transition: a PageTransition

-> m () 

Frees the given PageTransition

new

pageTransitionNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m PageTransition

Returns: a new PageTransition, use pageTransitionFree to free it

Creates a new PageTransition

Properties

alignment

the dimension in which the transition effect shall occur. Only for POPPLER_PAGE_TRANSITION_SPLIT and POPPLER_PAGE_TRANSITION_BLINDS transition types

getPageTransitionAlignment :: MonadIO m => PageTransition -> m PageTransitionAlignment Source #

Get the value of the “alignment” field. When overloading is enabled, this is equivalent to

get pageTransition #alignment

setPageTransitionAlignment :: MonadIO m => PageTransition -> PageTransitionAlignment -> m () Source #

Set the value of the “alignment” field. When overloading is enabled, this is equivalent to

set pageTransition [ #alignment := value ]

angle

the direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. Only for POPPLER_PAGE_TRANSITION_WIPE, POPPLER_PAGE_TRANSITION_GLITTER, POPPLER_PAGE_TRANSITION_FLY, POPPLER_PAGE_TRANSITION_COVER, POPPLER_PAGE_TRANSITION_UNCOVER and POPPLER_PAGE_TRANSITION_PUSH transition types

getPageTransitionAngle :: MonadIO m => PageTransition -> m Int32 Source #

Get the value of the “angle” field. When overloading is enabled, this is equivalent to

get pageTransition #angle

setPageTransitionAngle :: MonadIO m => PageTransition -> Int32 -> m () Source #

Set the value of the “angle” field. When overloading is enabled, this is equivalent to

set pageTransition [ #angle := value ]

direction

the direction of motion for the transition effect. Only for POPPLER_PAGE_TRANSITION_SPLIT, POPPLER_PAGE_TRANSITION_BOX and POPPLER_PAGE_TRANSITION_FLY transition types

getPageTransitionDirection :: MonadIO m => PageTransition -> m PageTransitionDirection Source #

Get the value of the “direction” field. When overloading is enabled, this is equivalent to

get pageTransition #direction

setPageTransitionDirection :: MonadIO m => PageTransition -> PageTransitionDirection -> m () Source #

Set the value of the “direction” field. When overloading is enabled, this is equivalent to

set pageTransition [ #direction := value ]

duration

the duration of the transition effect

getPageTransitionDuration :: MonadIO m => PageTransition -> m Int32 Source #

Get the value of the “duration” field. When overloading is enabled, this is equivalent to

get pageTransition #duration

setPageTransitionDuration :: MonadIO m => PageTransition -> Int32 -> m () Source #

Set the value of the “duration” field. When overloading is enabled, this is equivalent to

set pageTransition [ #duration := value ]

durationReal

No description available in the introspection data.

getPageTransitionDurationReal :: MonadIO m => PageTransition -> m Double Source #

Get the value of the “duration_real” field. When overloading is enabled, this is equivalent to

get pageTransition #durationReal

setPageTransitionDurationReal :: MonadIO m => PageTransition -> Double -> m () Source #

Set the value of the “duration_real” field. When overloading is enabled, this is equivalent to

set pageTransition [ #durationReal := value ]

rectangular

whether the area that will be flown is rectangular and opaque. Only for POPPLER_PAGE_TRANSITION_FLY transition type

getPageTransitionRectangular :: MonadIO m => PageTransition -> m Bool Source #

Get the value of the “rectangular” field. When overloading is enabled, this is equivalent to

get pageTransition #rectangular

setPageTransitionRectangular :: MonadIO m => PageTransition -> Bool -> m () Source #

Set the value of the “rectangular” field. When overloading is enabled, this is equivalent to

set pageTransition [ #rectangular := value ]

scale

the starting or ending scale at which the changes shall be drawn. Only for POPPLER_PAGE_TRANSITION_FLY transition type

getPageTransitionScale :: MonadIO m => PageTransition -> m Double Source #

Get the value of the “scale” field. When overloading is enabled, this is equivalent to

get pageTransition #scale

setPageTransitionScale :: MonadIO m => PageTransition -> Double -> m () Source #

Set the value of the “scale” field. When overloading is enabled, this is equivalent to

set pageTransition [ #scale := value ]

type

the type of transtition

getPageTransitionType :: MonadIO m => PageTransition -> m PageTransitionType Source #

Get the value of the “type” field. When overloading is enabled, this is equivalent to

get pageTransition #type

setPageTransitionType :: MonadIO m => PageTransition -> PageTransitionType -> m () Source #

Set the value of the “type” field. When overloading is enabled, this is equivalent to

set pageTransition [ #type := value ]