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

GI.Clutter.Objects.Backend

Contents

Exported types
Methods
Signals

Description

Backend is an opaque structure whose members cannot be directly accessed.

Since: 0.4

Synopsis

newtype Backend = Backend (ManagedPtr Backend)
class (GObject o, IsDescendantOf Backend o) => IsBackend o
toBackend :: (MonadIO m, IsBackend o) => o -> m Backend
backendGetDoubleClickDistance :: (HasCallStack, MonadIO m, IsBackend a) => a -> m Word32
backendGetDoubleClickTime :: (HasCallStack, MonadIO m, IsBackend a) => a -> m Word32
backendGetFontName :: (HasCallStack, MonadIO m, IsBackend a) => a -> m Text
backendGetFontOptions :: (HasCallStack, MonadIO m, IsBackend a) => a -> m FontOptions
backendGetResolution :: (HasCallStack, MonadIO m, IsBackend a) => a -> m Double
backendSetDoubleClickDistance :: (HasCallStack, MonadIO m, IsBackend a) => a -> Word32 -> m ()
backendSetDoubleClickTime :: (HasCallStack, MonadIO m, IsBackend a) => a -> Word32 -> m ()
backendSetFontName :: (HasCallStack, MonadIO m, IsBackend a) => a -> Text -> m ()
backendSetFontOptions :: (HasCallStack, MonadIO m, IsBackend a) => a -> FontOptions -> m ()
backendSetResolution :: (HasCallStack, MonadIO m, IsBackend a) => a -> Double -> m ()
type BackendFontChangedCallback = IO ()
afterBackendFontChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendFontChangedCallback) -> m SignalHandlerId
onBackendFontChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendFontChangedCallback) -> m SignalHandlerId
type BackendResolutionChangedCallback = IO ()
afterBackendResolutionChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendResolutionChangedCallback) -> m SignalHandlerId
onBackendResolutionChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendResolutionChangedCallback) -> m SignalHandlerId
type BackendSettingsChangedCallback = IO ()
afterBackendSettingsChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendSettingsChangedCallback) -> m SignalHandlerId
onBackendSettingsChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendSettingsChangedCallback) -> m SignalHandlerId

Exported types

newtype Backend Source #

Memory-managed wrapper type.

Constructors

Backend (ManagedPtr Backend)

Instances

Instances details

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

class (GObject o, IsDescendantOf Backend o) => IsBackend o Source #

Type class for types which can be safely cast to Backend, for instance with toBackend.

Instances

Instances details

(GObject o, IsDescendantOf Backend o) => IsBackend o Source #
Instance details Defined in GI.Clutter.Objects.Backend

toBackend :: (MonadIO m, IsBackend o) => o -> m Backend Source #

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

getDoubleClickDistance

backendGetDoubleClickDistance Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> m Word32	Returns: a distance, in pixels.

Deprecated: (Since version 1.4)Use Settings:doubleClickDistance instead

Retrieves the distance used to verify a double click event

Since: 0.4

getDoubleClickTime

backendGetDoubleClickTime Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> m Word32	Returns: a time in milliseconds

Deprecated: (Since version 1.4)Use Settings:doubleClickTime instead

Gets the maximum time between two button press events, as set by backendSetDoubleClickTime.

Since: 0.4

getFontName

backendGetFontName Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> m Text	Returns: the font name for the backend. The returned string is owned by the `Backend` and should never be modified or freed

Deprecated: (Since version 1.4)Use Settings:fontName instead

Retrieves the default font name as set by backendSetFontName.

Since: 1.0

getFontOptions

backendGetFontOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> m FontOptions	Returns: the font options of the `Backend`. The returned `FontOptions` is owned by the backend and should not be modified or freed

Retrieves the font options for backend.

Since: 0.8

getResolution

backendGetResolution Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> m Double	Returns: the current resolution, or -1 if no resolution has been set.

Gets the resolution for font handling on the screen.

The resolution is a scale factor between points specified in a FontDescription and cairo units. The default value is 96.0, meaning that a 10 point font will be 13 units high (10 * 96. / 72. = 13.3).

Clutter will set the resolution using the current backend when initializing; the resolution is also stored in the Settings:fontDpi property.

Since: 0.4

setDoubleClickDistance

backendSetDoubleClickDistance Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> Word32	`distance`: a distance, in pixels
-> m ()

Deprecated: (Since version 1.4)Use Settings:doubleClickDistance instead

Sets the maximum distance used to verify a double click event.

Since: 0.4

setDoubleClickTime

backendSetDoubleClickTime Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> Word32	`msec`: milliseconds between two button press events
-> m ()

Deprecated: (Since version 1.4)Use Settings:doubleClickTime instead

Sets the maximum time between two button press events, used to verify whether it's a double click event or not.

Since: 0.4

setFontName

backendSetFontName Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> Text	`fontName`: the name of the font
-> m ()

Deprecated: (Since version 1.4)Use Settings:fontName instead

Sets the default font to be used by Clutter. The fontName string must either be Nothing, which means that the font name from the default Backend will be used; or be something that can be parsed by the fontDescriptionFromString function.

Since: 1.0

setFontOptions

backendSetFontOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> FontOptions	`options`: Cairo font options for the backend, or `Nothing`
-> m ()

Sets the new font options for backend. The Backend will copy the FontOptions.

If options is Nothing, the first following call to backendGetFontOptions will return the default font options for backend.

This function is intended for actors creating a Pango layout using the PangoCairo API.

Since: 0.8

setResolution

backendSetResolution Source #

Arguments

:: (HasCallStack, MonadIO m, IsBackend a)
=> a	`backend`: a `Backend`
-> Double	`dpi`: the resolution in "dots per inch" (Physical inches aren't actually involved; the terminology is conventional).
-> m ()

Deprecated: (Since version 1.4)Use Settings:fontDpi instead

Sets the resolution for font handling on the screen. This is a scale factor between points specified in a FontDescription and cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3).

Applications should never need to call this function.

Since: 0.4

Signals

fontChanged

type BackendFontChangedCallback = IO () Source #

The fontChanged signal is emitted each time the font options have been changed through Settings.

Since: 1.0

afterBackendFontChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendFontChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the fontChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after backend #fontChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBackendFontChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendFontChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the fontChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on backend #fontChanged callback

resolutionChanged

type BackendResolutionChangedCallback = IO () Source #

The resolutionChanged signal is emitted each time the font resolutions has been changed through Settings.

Since: 1.0

afterBackendResolutionChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendResolutionChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the resolutionChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after backend #resolutionChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBackendResolutionChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendResolutionChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the resolutionChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on backend #resolutionChanged callback

settingsChanged

type BackendSettingsChangedCallback = IO () Source #

The settingsChanged signal is emitted each time the Settings properties have been changed.

Since: 1.4

afterBackendSettingsChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendSettingsChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the settingsChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after backend #settingsChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBackendSettingsChanged :: (IsBackend a, MonadIO m) => a -> ((?self :: a) => BackendSettingsChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the settingsChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on backend #settingsChanged callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getDoubleClickDistance

getDoubleClickTime

getFontName

getFontOptions

getResolution

setDoubleClickDistance

setDoubleClickTime

setFontName

setFontOptions

setResolution

Signals

fontChanged

resolutionChanged

settingsChanged