gi-dazzle-1.0.1: libdazzle bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Dazzle.Objects.ShortcutTheme

Description

No description available in the introspection data.

Synopsis

Exported types

newtype ShortcutTheme Source #

Memory-managed wrapper type.

Constructors

ShortcutTheme (ManagedPtr ShortcutTheme) 

Instances

Instances details
Eq ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

GObject ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

ManagedPtrNewtype ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

Methods

toManagedPtr :: ShortcutTheme -> ManagedPtr ShortcutTheme

TypedObject ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

Methods

glibType :: IO GType

HasParentTypes ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

IsGValue (Maybe ShortcutTheme) Source #

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

Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ShortcutTheme Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

type ParentTypes ShortcutTheme = '[Object]

class (GObject o, IsDescendantOf ShortcutTheme o) => IsShortcutTheme o Source #

Type class for types which can be safely cast to ShortcutTheme, for instance with toShortcutTheme.

Instances

Instances details
(GObject o, IsDescendantOf ShortcutTheme o) => IsShortcutTheme o Source # 
Instance details

Defined in GI.Dazzle.Objects.ShortcutTheme

toShortcutTheme :: (MonadIO m, IsShortcutTheme o) => o -> m ShortcutTheme Source #

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

Methods

addContext

shortcutThemeAddContext :: (HasCallStack, MonadIO m, IsShortcutTheme a, IsShortcutContext b) => a -> b -> m () Source #

No description available in the introspection data.

addCssResource

shortcutThemeAddCssResource :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> m () Source #

No description available in the introspection data.

findContextByName

shortcutThemeFindContextByName Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a

self: An ShortcutContext

-> Text

name: The name of the context

-> m ShortcutContext

Returns: An ShortcutContext

Gets the context named name. If the context does not exist, it will be created.

findDefaultContext

shortcutThemeFindDefaultContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsWidget b) 
=> a 
-> b 
-> m (Maybe ShortcutContext)

Returns: An ShortcutContext or Nothing.

Finds the default context in the theme for widget.

getChordForAction

shortcutThemeGetChordForAction :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> m ShortcutChord Source #

No description available in the introspection data.

getChordForCommand

shortcutThemeGetChordForCommand :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> m ShortcutChord Source #

No description available in the introspection data.

getName

shortcutThemeGetName :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> m Text Source #

No description available in the introspection data.

getParent

shortcutThemeGetParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a

self: a ShortcutTheme

-> m (Maybe ShortcutTheme)

Returns: A ShortcutTheme or Nothing.

If the ShortcutTheme:parentName property has been set, this will fetch the parent ShortcutTheme.

getParentName

shortcutThemeGetParentName Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a

self: a ShortcutTheme

-> m (Maybe Text)

Returns: The name of the parent theme, or Nothing if none is set.

Gets the name of the parent shortcut theme.

This is used to resolve shortcuts from the parent theme without having to copy them directly into this shortcut theme. It allows for some level of copy-on-write (CoW).

getSubtitle

shortcutThemeGetSubtitle :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> m Text Source #

No description available in the introspection data.

getTitle

shortcutThemeGetTitle :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> m Text Source #

No description available in the introspection data.

loadFromData

shortcutThemeLoadFromData Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a 
-> Text 
-> Int64 
-> m ()

(Can throw GError)

No description available in the introspection data.

loadFromFile

shortcutThemeLoadFromFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsFile b, IsCancellable c) 
=> a 
-> b 
-> Maybe c 
-> m ()

(Can throw GError)

No description available in the introspection data.

loadFromPath

shortcutThemeLoadFromPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsCancellable b) 
=> a 
-> Text 
-> Maybe b 
-> m ()

(Can throw GError)

No description available in the introspection data.

new

shortcutThemeNew :: (HasCallStack, MonadIO m) => Text -> m ShortcutTheme Source #

No description available in the introspection data.

removeCssResource

shortcutThemeRemoveCssResource :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> m () Source #

No description available in the introspection data.

saveToFile

shortcutThemeSaveToFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsFile b, IsCancellable c) 
=> a 
-> b 
-> Maybe c 
-> m ()

(Can throw GError)

No description available in the introspection data.

saveToPath

shortcutThemeSaveToPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsCancellable b) 
=> a 
-> Text 
-> Maybe b 
-> m ()

(Can throw GError)

No description available in the introspection data.

saveToStream

shortcutThemeSaveToStream Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a, IsOutputStream b, IsCancellable c) 
=> a 
-> b 
-> Maybe c 
-> m ()

(Can throw GError)

No description available in the introspection data.

setAccelForAction

shortcutThemeSetAccelForAction :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> Text -> [ShortcutPhase] -> m () Source #

No description available in the introspection data.

setAccelForCommand

shortcutThemeSetAccelForCommand Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a

self: a ShortcutTheme

-> Maybe Text

command: the command to be executed

-> Maybe Text

accel: the shortcut accelerator

-> [ShortcutPhase]

phase: the phase to activate within, or 0 for the default

-> m () 

This will set the command to execute when accel is pressed. If command is Nothing, the accelerator will be cleared. If accelerator is Nothing, all accelerators for command will be cleared.

setChordForAction

shortcutThemeSetChordForAction :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> ShortcutChord -> [ShortcutPhase] -> m () Source #

No description available in the introspection data.

setChordForCommand

shortcutThemeSetChordForCommand Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTheme a) 
=> a

self: a ShortcutTheme

-> Maybe Text

command: the command to be executed

-> Maybe ShortcutChord

chord: the chord for the command

-> [ShortcutPhase]

phase: the phase to activate within, or 0 for the default

-> m () 

This will set the command to execute when chord is pressed. If command is Nothing, the accelerator will be cleared. If chord is Nothing, all accelerators for command will be cleared.

setParentName

shortcutThemeSetParentName :: (HasCallStack, MonadIO m, IsShortcutTheme a) => a -> Text -> m () Source #

No description available in the introspection data.

Properties

name

No description available in the introspection data.

constructShortcutThemeName :: (IsShortcutTheme o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutThemeName :: (MonadIO m, IsShortcutTheme o) => o -> m Text Source #

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

get shortcutTheme #name

parentName

No description available in the introspection data.

constructShortcutThemeParentName :: (IsShortcutTheme o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutThemeParentName :: (MonadIO m, IsShortcutTheme o) => o -> m (Maybe Text) Source #

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

get shortcutTheme #parentName

setShortcutThemeParentName :: (MonadIO m, IsShortcutTheme o) => o -> Text -> m () Source #

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

set shortcutTheme [ #parentName := value ]

subtitle

No description available in the introspection data.

clearShortcutThemeSubtitle :: (MonadIO m, IsShortcutTheme o) => o -> m () Source #

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

clear #subtitle

constructShortcutThemeSubtitle :: (IsShortcutTheme o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutThemeSubtitle :: (MonadIO m, IsShortcutTheme o) => o -> m Text Source #

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

get shortcutTheme #subtitle

setShortcutThemeSubtitle :: (MonadIO m, IsShortcutTheme o) => o -> Text -> m () Source #

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

set shortcutTheme [ #subtitle := value ]

title

No description available in the introspection data.

clearShortcutThemeTitle :: (MonadIO m, IsShortcutTheme o) => o -> m () Source #

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

clear #title

constructShortcutThemeTitle :: (IsShortcutTheme o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutThemeTitle :: (MonadIO m, IsShortcutTheme o) => o -> m Text Source #

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

get shortcutTheme #title

setShortcutThemeTitle :: (MonadIO m, IsShortcutTheme o) => o -> Text -> m () Source #

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

set shortcutTheme [ #title := value ]