GI.Dazzle.Objects.Suggestion

No description available in the introspection data.

Exported types

newtype Suggestion

Memory-managed wrapper type.

Constructors

Suggestion (ManagedPtr Suggestion)

Instances

Eq Suggestion

Defined in GI.Dazzle.Objects.Suggestion

Methods

(==) :: Suggestion -> Suggestion -> Bool

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

GObject Suggestion

Defined in GI.Dazzle.Objects.Suggestion

ManagedPtrNewtype Suggestion

Defined in GI.Dazzle.Objects.Suggestion

Methods

toManagedPtr :: Suggestion -> ManagedPtr Suggestion

TypedObject Suggestion

Defined in GI.Dazzle.Objects.Suggestion

Methods

glibType :: IO GType

HasParentTypes Suggestion

Defined in GI.Dazzle.Objects.Suggestion

IsGValue (Maybe Suggestion)

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

Defined in GI.Dazzle.Objects.Suggestion

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Suggestion

Defined in GI.Dazzle.Objects.Suggestion

type ParentTypes Suggestion = '[Object]

class (GObject o, IsDescendantOf Suggestion o) => IsSuggestion o

Type class for types which can be safely cast to Suggestion, for instance with toSuggestion.

Instances

(GObject o, IsDescendantOf Suggestion o) => IsSuggestion o

Defined in GI.Dazzle.Objects.Suggestion

toSuggestion :: (MonadIO m, IsSuggestion o) => o -> m Suggestion

Cast to Suggestion, 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, replaceTypedText, runDispose, stealData, stealQdata, suggestSuffix, thawNotify, unref, watchClosure.

Getters

getData, getIcon, getIconName, getIconSurface, getId, getProperty, getQdata, getSecondaryIcon, getSecondaryIconName, getSecondaryIconSurface, getSubtitle, getTitle.

Setters

setData, setDataFull, setIconName, setId, setProperty, setSecondaryIconName, setSubtitle, setTitle.

getIcon

suggestionGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsSuggestion a)

=> a

self: a Suggestion

-> m (Maybe Icon)

Returns: a Icon or Nothing

Gets the icon for the suggestion, if any.

Since: 3.30

getIconName

suggestionGetIconName :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> m Text

No description available in the introspection data.

getIconSurface

suggestionGetIconSurface

Arguments

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

=> a

self: a Suggestion

-> b

widget: a widget that may contain the surface

-> m (Maybe Surface)

Returns: a Surface or Nothing

This function allows subclasses to dynamicly generate content for the suggestion such as may be required when integrating with favicons or similar.

widget is provided so that the implementation may determine scale or any other style-specific settings from the style context.

Since: 3.30

getId

suggestionGetId :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> m Text

No description available in the introspection data.

getSecondaryIcon

suggestionGetSecondaryIcon

Arguments

:: (HasCallStack, MonadIO m, IsSuggestion a)

=> a

self: a Suggestion

-> m (Maybe Icon)

Returns: a Icon or Nothing

Gets the secondary icon for the suggestion, if any.

Since: 3.36

getSecondaryIconName

suggestionGetSecondaryIconName :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> m Text

No description available in the introspection data.

getSecondaryIconSurface

suggestionGetSecondaryIconSurface

Arguments

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

=> a

self: a Suggestion

-> b

widget: a widget that may contain the surface

-> m (Maybe Surface)

Returns: a Surface or Nothing

This function allows subclasses to dynamicly generate content for the suggestion such as may be required when integrating with favicons or similar.

widget is provided so that the implementation may determine scale or any other style-specific settings from the style context.

Since: 3.36

getSubtitle

suggestionGetSubtitle :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> m Text

No description available in the introspection data.

getTitle

suggestionGetTitle :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> m Text

No description available in the introspection data.

new

suggestionNew :: (HasCallStack, MonadIO m) => m Suggestion

No description available in the introspection data.

replaceTypedText

suggestionReplaceTypedText

Arguments

:: (HasCallStack, MonadIO m, IsSuggestion a)

=> a

self: An Suggestion

-> Text

typedText: the text that was typed into the entry

-> m (Maybe Text)

Returns: The replacement text to insert into the entry when "tab" is pressed to complete the insertion.

This function is meant to be used to replace the text in the entry with text that represents the suggestion most accurately. This happens when the user presses tab while typing a suggestion. For example, if typing "gno" in the entry, you might have a suggest_suffix of "me.org" so that the user sees "gnome.org". But the replace_typed_text might include more data such as "https://gnome.org" as it more closely represents the suggestion.

setIconName

suggestionSetIconName :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> Text -> m ()

No description available in the introspection data.

setId

suggestionSetId :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> Text -> m ()

No description available in the introspection data.

setSecondaryIconName

suggestionSetSecondaryIconName :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> Text -> m ()

No description available in the introspection data.

setSubtitle

suggestionSetSubtitle :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> Text -> m ()

No description available in the introspection data.

setTitle

suggestionSetTitle :: (HasCallStack, MonadIO m, IsSuggestion a) => a -> Text -> m ()

No description available in the introspection data.

suggestSuffix

suggestionSuggestSuffix

Arguments

:: (HasCallStack, MonadIO m, IsSuggestion a)

=> a

self: a Suggestion

-> Text

typedText: The user entered text

-> m (Maybe Text)

Returns: Suffix to append to typedText or Nothing to leave it unchanged.

This function requests potential text to append to typedText to make it more clear to the user what they will be activating by selecting this suggestion. For example, if they start typing "gno", a potential suggested suffix might be "me.org" to create "gnome.org".

Properties

icon

No description available in the introspection data.

getSuggestionIcon :: (MonadIO m, IsSuggestion o) => o -> m (Maybe Icon)

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

get suggestion #icon

iconName

No description available in the introspection data.

constructSuggestionIconName :: (IsSuggestion o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSuggestionIconName :: (MonadIO m, IsSuggestion o) => o -> m Text

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

get suggestion #iconName

setSuggestionIconName :: (MonadIO m, IsSuggestion o) => o -> Text -> m ()

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

set suggestion [ #iconName := value ]

id

No description available in the introspection data.

constructSuggestionId :: (IsSuggestion o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSuggestionId :: (MonadIO m, IsSuggestion o) => o -> m Text

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

get suggestion #id

setSuggestionId :: (MonadIO m, IsSuggestion o) => o -> Text -> m ()

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

set suggestion [ #id := value ]

secondaryIcon

No description available in the introspection data.

getSuggestionSecondaryIcon :: (MonadIO m, IsSuggestion o) => o -> m (Maybe Icon)

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

get suggestion #secondaryIcon

secondaryIconName

No description available in the introspection data.

constructSuggestionSecondaryIconName :: (IsSuggestion o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSuggestionSecondaryIconName :: (MonadIO m, IsSuggestion o) => o -> m Text

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

get suggestion #secondaryIconName

setSuggestionSecondaryIconName :: (MonadIO m, IsSuggestion o) => o -> Text -> m ()

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

set suggestion [ #secondaryIconName := value ]

subtitle

No description available in the introspection data.

constructSuggestionSubtitle :: (IsSuggestion o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSuggestionSubtitle :: (MonadIO m, IsSuggestion o) => o -> m Text

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

get suggestion #subtitle

setSuggestionSubtitle :: (MonadIO m, IsSuggestion o) => o -> Text -> m ()

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

set suggestion [ #subtitle := value ]

title

No description available in the introspection data.

constructSuggestionTitle :: (IsSuggestion 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.

getSuggestionTitle :: (MonadIO m, IsSuggestion o) => o -> m Text

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

get suggestion #title

setSuggestionTitle :: (MonadIO m, IsSuggestion o) => o -> Text -> m ()

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

set suggestion [ #title := value ]

Signals

replaceTypedText

type SuggestionReplaceTypedTextCallback = Text -> IO Text

No description available in the introspection data.

afterSuggestionReplaceTypedText :: (IsSuggestion a, MonadIO m) => a -> ((?self :: a) => SuggestionReplaceTypedTextCallback) -> m SignalHandlerId

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

after suggestion #replaceTypedText 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.

onSuggestionReplaceTypedText :: (IsSuggestion a, MonadIO m) => a -> ((?self :: a) => SuggestionReplaceTypedTextCallback) -> m SignalHandlerId

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

on suggestion #replaceTypedText callback

suggestSuffix

type SuggestionSuggestSuffixCallback = Text -> IO Text

No description available in the introspection data.

afterSuggestionSuggestSuffix :: (IsSuggestion a, MonadIO m) => a -> ((?self :: a) => SuggestionSuggestSuffixCallback) -> m SignalHandlerId

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

after suggestion #suggestSuffix 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.

onSuggestionSuggestSuffix :: (IsSuggestion a, MonadIO m) => a -> ((?self :: a) => SuggestionSuggestSuffixCallback) -> m SignalHandlerId

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

on suggestion #suggestSuffix callback