GI.Clutter.Objects.Settings

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

Since: 1.4

Exported types

newtype Settings

Memory-managed wrapper type.

Constructors

Settings (ManagedPtr Settings)

Instances

Eq Settings

Defined in GI.Clutter.Objects.Settings

Methods

(==) :: Settings -> Settings -> Bool

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

GObject Settings

Defined in GI.Clutter.Objects.Settings

ManagedPtrNewtype Settings

Defined in GI.Clutter.Objects.Settings

Methods

toManagedPtr :: Settings -> ManagedPtr Settings

TypedObject Settings

Defined in GI.Clutter.Objects.Settings

Methods

glibType :: IO GType

HasParentTypes Settings

Defined in GI.Clutter.Objects.Settings

IsGValue (Maybe Settings)

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

Defined in GI.Clutter.Objects.Settings

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Settings

Defined in GI.Clutter.Objects.Settings

type ParentTypes Settings = '[Object]

class (GObject o, IsDescendantOf Settings o) => IsSettings o

Type class for types which can be safely cast to Settings, for instance with toSettings.

Instances

(GObject o, IsDescendantOf Settings o) => IsSettings o

Defined in GI.Clutter.Objects.Settings

toSettings :: (MonadIO m, IsSettings o) => o -> m Settings

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

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

getDefault

settingsGetDefault

Arguments

:: (HasCallStack, MonadIO m)

=> m Settings

Returns: the instance of Settings. The returned object is owned by Clutter and it should not be unreferenced directly

Retrieves the singleton instance of Settings

Since: 1.4

Properties

backend

A back pointer to the Backend

Since: 1.4

constructSettingsBackend :: (IsSettings o, MonadIO m, IsBackend a) => a -> m (GValueConstruct o)

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

dndDragThreshold

The default distance that the cursor of a pointer device should travel before a drag operation should start.

Since: 1.8

constructSettingsDndDragThreshold :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsDndDragThreshold :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “dnd-drag-threshold” property. When overloading is enabled, this is equivalent to

get settings #dndDragThreshold

setSettingsDndDragThreshold :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “dnd-drag-threshold” property. When overloading is enabled, this is equivalent to

set settings [ #dndDragThreshold := value ]

doubleClickDistance

The maximum distance, in pixels, between button-press events that determines whether or not to increase the click count by 1.

Since: 1.4

constructSettingsDoubleClickDistance :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsDoubleClickDistance :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “double-click-distance” property. When overloading is enabled, this is equivalent to

get settings #doubleClickDistance

setSettingsDoubleClickDistance :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “double-click-distance” property. When overloading is enabled, this is equivalent to

set settings [ #doubleClickDistance := value ]

doubleClickTime

The time, in milliseconds, that should elapse between button-press events in order to increase the click count by 1.

Since: 1.4

constructSettingsDoubleClickTime :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsDoubleClickTime :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “double-click-time” property. When overloading is enabled, this is equivalent to

get settings #doubleClickTime

setSettingsDoubleClickTime :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “double-click-time” property. When overloading is enabled, this is equivalent to

set settings [ #doubleClickTime := value ]

fontAntialias

Whether or not to use antialiasing when rendering text; a value of 1 enables it unconditionally; a value of 0 disables it unconditionally; and -1 will use the system's default.

Since: 1.4

constructSettingsFontAntialias :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsFontAntialias :: (MonadIO m, IsSettings o) => o -> m Int32

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

get settings #fontAntialias

setSettingsFontAntialias :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

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

set settings [ #fontAntialias := value ]

fontDpi

The DPI used when rendering text, as a value of 1024 * dots/inch.

If set to -1, the system's default will be used instead

Since: 1.4

constructSettingsFontDpi :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsFontDpi :: (MonadIO m, IsSettings o) => o -> m Int32

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

get settings #fontDpi

setSettingsFontDpi :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

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

set settings [ #fontDpi := value ]

fontHintStyle

The style of the hinting used when rendering text. Valid values are:

• hintnone
• hintslight
• hintmedium
• hintfull

Since: 1.4

clearSettingsFontHintStyle :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “font-hint-style” property to Nothing. When overloading is enabled, this is equivalent to

clear #fontHintStyle

constructSettingsFontHintStyle :: (IsSettings o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingsFontHintStyle :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “font-hint-style” property. When overloading is enabled, this is equivalent to

get settings #fontHintStyle

setSettingsFontHintStyle :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “font-hint-style” property. When overloading is enabled, this is equivalent to

set settings [ #fontHintStyle := value ]

fontHinting

Whether or not to use hinting when rendering text; a value of 1 unconditionally enables it; a value of 0 unconditionally disables it; and a value of -1 will use the system's default.

Since: 1.4

constructSettingsFontHinting :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsFontHinting :: (MonadIO m, IsSettings o) => o -> m Int32

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

get settings #fontHinting

setSettingsFontHinting :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

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

set settings [ #fontHinting := value ]

fontName

The default font name that should be used by text actors, as a string that can be passed to fontDescriptionFromString.

Since: 1.4

clearSettingsFontName :: (MonadIO m, IsSettings o) => o -> m ()

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

clear #fontName

constructSettingsFontName :: (IsSettings o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingsFontName :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

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

get settings #fontName

setSettingsFontName :: (MonadIO m, IsSettings o) => o -> Text -> m ()

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

set settings [ #fontName := value ]

fontSubpixelOrder

The type of sub-pixel antialiasing used when rendering text. Valid values are:

• none
• rgb
• bgr
• vrgb
• vbgr

Since: 1.4

clearSettingsFontSubpixelOrder :: (MonadIO m, IsSettings o) => o -> m ()

Set the value of the “font-subpixel-order” property to Nothing. When overloading is enabled, this is equivalent to

clear #fontSubpixelOrder

constructSettingsFontSubpixelOrder :: (IsSettings o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingsFontSubpixelOrder :: (MonadIO m, IsSettings o) => o -> m (Maybe Text)

Get the value of the “font-subpixel-order” property. When overloading is enabled, this is equivalent to

get settings #fontSubpixelOrder

setSettingsFontSubpixelOrder :: (MonadIO m, IsSettings o) => o -> Text -> m ()

Set the value of the “font-subpixel-order” property. When overloading is enabled, this is equivalent to

set settings [ #fontSubpixelOrder := value ]

fontconfigTimestamp

No description available in the introspection data.

constructSettingsFontconfigTimestamp :: (IsSettings o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

setSettingsFontconfigTimestamp :: (MonadIO m, IsSettings o) => o -> Word32 -> m ()

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

set settings [ #fontconfigTimestamp := value ]

longPressDuration

Sets the minimum duration for a press to be recognized as a long press gesture. The duration is expressed in milliseconds.

See also ClickAction:longPressDuration.

Since: 1.8

constructSettingsLongPressDuration :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsLongPressDuration :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “long-press-duration” property. When overloading is enabled, this is equivalent to

get settings #longPressDuration

setSettingsLongPressDuration :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “long-press-duration” property. When overloading is enabled, this is equivalent to

set settings [ #longPressDuration := value ]

passwordHintTime

No description available in the introspection data.

constructSettingsPasswordHintTime :: (IsSettings o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingsPasswordHintTime :: (MonadIO m, IsSettings o) => o -> m Word32

Get the value of the “password-hint-time” property. When overloading is enabled, this is equivalent to

get settings #passwordHintTime

setSettingsPasswordHintTime :: (MonadIO m, IsSettings o) => o -> Word32 -> m ()

Set the value of the “password-hint-time” property. When overloading is enabled, this is equivalent to

set settings [ #passwordHintTime := value ]

unscaledFontDpi

No description available in the introspection data.

constructSettingsUnscaledFontDpi :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

setSettingsUnscaledFontDpi :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “unscaled-font-dpi” property. When overloading is enabled, this is equivalent to

set settings [ #unscaledFontDpi := value ]

windowScalingFactor

No description available in the introspection data.

constructSettingsWindowScalingFactor :: (IsSettings o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingsWindowScalingFactor :: (MonadIO m, IsSettings o) => o -> m Int32

Get the value of the “window-scaling-factor” property. When overloading is enabled, this is equivalent to

get settings #windowScalingFactor

setSettingsWindowScalingFactor :: (MonadIO m, IsSettings o) => o -> Int32 -> m ()

Set the value of the “window-scaling-factor” property. When overloading is enabled, this is equivalent to

set settings [ #windowScalingFactor := value ]