GI.Dazzle.Objects.ShortcutTooltip

No description available in the introspection data.

Exported types

newtype ShortcutTooltip

Memory-managed wrapper type.

Constructors

ShortcutTooltip (ManagedPtr ShortcutTooltip)

Instances

Eq ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

Methods

(==) :: ShortcutTooltip -> ShortcutTooltip -> Bool

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

GObject ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

ManagedPtrNewtype ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

Methods

toManagedPtr :: ShortcutTooltip -> ManagedPtr ShortcutTooltip

TypedObject ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

Methods

glibType :: IO GType

HasParentTypes ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

IsGValue (Maybe ShortcutTooltip)

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

Defined in GI.Dazzle.Objects.ShortcutTooltip

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ShortcutTooltip

Defined in GI.Dazzle.Objects.ShortcutTooltip

type ParentTypes ShortcutTooltip = '[Object]

class (GObject o, IsDescendantOf ShortcutTooltip o) => IsShortcutTooltip o

Type class for types which can be safely cast to ShortcutTooltip, for instance with toShortcutTooltip.

Instances

(GObject o, IsDescendantOf ShortcutTooltip o) => IsShortcutTooltip o

Defined in GI.Dazzle.Objects.ShortcutTooltip

toShortcutTooltip :: (MonadIO m, IsShortcutTooltip o) => o -> m ShortcutTooltip

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

getAccel, getCommandId, getData, getProperty, getQdata, getTitle, getWidget.

Setters

setAccel, setCommandId, setData, setDataFull, setProperty, setTitle, setWidget.

getAccel

shortcutTooltipGetAccel

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

self: a ShortcutTooltip

-> m (Maybe Text)

Returns: an override accel, or Nothing

Gets the ShortcutTooltip:accel property, which can be used to override the commands accel.

Since: 3.32

getCommandId

shortcutTooltipGetCommandId

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

self: a ShortcutTooltip

-> m (Maybe Text)

Returns: a string containing the command id

Gets the ShortcutTooltip:commandId property.

Since: 3.32

getTitle

shortcutTooltipGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

-> m (Maybe Text)

Returns: a string containing the title, or Nothing

Gets the ShortcutTooltip:title property, if set.

Since: 3.32

getWidget

shortcutTooltipGetWidget

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

-> m (Maybe Widget)

Returns: a Widget or Nothing if unset

Gets the Widget that the shortcut-tooltip is wrapping.

Since: 3.32

new

shortcutTooltipNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ShortcutTooltip

Returns: a newly created ShortcutTooltip

Create a new ShortcutTooltip.

Since: 3.32

setAccel

shortcutTooltipSetAccel

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

self: ShortcutTooltip

-> Maybe Text

accel: Sets the accelerator to use, or Nothing to unset and use the default

-> m ()

Allows overriding the accel that is used.

Since: 3.32

setCommandId

shortcutTooltipSetCommandId

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

self: a ShortcutTooltip

-> Text

commandId: the command-id of the shortcut registered

-> m ()

This sets the ShortcutTooltip:commandId property which denotes which shortcut registered with libdazzle to display when a tooltip request is received.

Since: 3.32

setTitle

shortcutTooltipSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a)

=> a

self: a ShortcutTooltip

-> Maybe Text

title: a title for the tooltip, or Nothing

-> m ()

Sets the ShortcutTooltip:title property, which can be used to override the default title for the tooltip as discovered from the shortcut manager.

Since: 3.32

setWidget

shortcutTooltipSetWidget

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTooltip a, IsWidget b)

=> a

self: a ShortcutTooltip

-> Maybe b

widget: a Widget or Nothing

-> m ()

Sets the widget to connect to the Widget::queryTooltip signal.

If configured, the widget will be displayed with an appropriate tooltip message matching the shortcut from ShortcutTooltip:commandId.

Since: 3.32

Properties

accel

No description available in the introspection data.

clearShortcutTooltipAccel :: (MonadIO m, IsShortcutTooltip o) => o -> m ()

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

clear #accel

constructShortcutTooltipAccel :: (IsShortcutTooltip o, MonadIO m) => Text -> m (GValueConstruct o)

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

getShortcutTooltipAccel :: (MonadIO m, IsShortcutTooltip o) => o -> m (Maybe Text)

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

get shortcutTooltip #accel

setShortcutTooltipAccel :: (MonadIO m, IsShortcutTooltip o) => o -> Text -> m ()

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

set shortcutTooltip [ #accel := value ]

commandId

No description available in the introspection data.

constructShortcutTooltipCommandId :: (IsShortcutTooltip o, MonadIO m) => Text -> m (GValueConstruct o)

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

getShortcutTooltipCommandId :: (MonadIO m, IsShortcutTooltip o) => o -> m (Maybe Text)

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

get shortcutTooltip #commandId

setShortcutTooltipCommandId :: (MonadIO m, IsShortcutTooltip o) => o -> Text -> m ()

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

set shortcutTooltip [ #commandId := value ]

title

The "title" property contains an alternate title for the tooltip instead of discovering the title from the shortcut manager.

Since: 3.32

clearShortcutTooltipTitle :: (MonadIO m, IsShortcutTooltip o) => o -> m ()

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

clear #title

constructShortcutTooltipTitle :: (IsShortcutTooltip o, MonadIO m) => Text -> m (GValueConstruct o)

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

getShortcutTooltipTitle :: (MonadIO m, IsShortcutTooltip o) => o -> m (Maybe Text)

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

get shortcutTooltip #title

setShortcutTooltipTitle :: (MonadIO m, IsShortcutTooltip o) => o -> Text -> m ()

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

set shortcutTooltip [ #title := value ]

widget

No description available in the introspection data.

clearShortcutTooltipWidget :: (MonadIO m, IsShortcutTooltip o) => o -> m ()

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

clear #widget

constructShortcutTooltipWidget :: (IsShortcutTooltip o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getShortcutTooltipWidget :: (MonadIO m, IsShortcutTooltip o) => o -> m (Maybe Widget)

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

get shortcutTooltip #widget

setShortcutTooltipWidget :: (MonadIO m, IsShortcutTooltip o, IsWidget a) => o -> a -> m ()

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

set shortcutTooltip [ #widget := value ]