GI.Dazzle.Objects.SuggestionEntry

No description available in the introspection data.

Exported types

newtype SuggestionEntry

Memory-managed wrapper type.

Constructors

SuggestionEntry (ManagedPtr SuggestionEntry)

Instances

Eq SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

Methods

(==) :: SuggestionEntry -> SuggestionEntry -> Bool

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

GObject SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

ManagedPtrNewtype SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

Methods

toManagedPtr :: SuggestionEntry -> ManagedPtr SuggestionEntry

TypedObject SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

Methods

glibType :: IO GType

HasParentTypes SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

IsGValue (Maybe SuggestionEntry)

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

Defined in GI.Dazzle.Objects.SuggestionEntry

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SuggestionEntry

Defined in GI.Dazzle.Objects.SuggestionEntry

type ParentTypes SuggestionEntry = '[Entry, Widget, Object, ImplementorIface, Buildable, CellEditable, Editable]

class (GObject o, IsDescendantOf SuggestionEntry o) => IsSuggestionEntry o

Type class for types which can be safely cast to SuggestionEntry, for instance with toSuggestionEntry.

Instances

(GObject o, IsDescendantOf SuggestionEntry o) => IsSuggestionEntry o

Defined in GI.Dazzle.Objects.SuggestionEntry

toSuggestionEntry :: (MonadIO m, IsSuggestionEntry o) => o -> m SuggestionEntry

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

activate, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, childFocus, childNotify, classPath, computeExpand, constructChild, copyClipboard, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, cutClipboard, defaultPositionFunc, deleteSelection, deleteText, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, editingDone, ensureStyle, errorBell, event, forceFloating, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabFocusWithoutSelecting, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, hideSuggestions, imContextFilterKeypress, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, insertText, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, layoutIndexToTextIndex, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, pasteClipboard, path, progressPulse, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, removeAccelerator, removeMnemonicLabel, removeTickCallback, removeWidget, renderIcon, renderIconPixbuf, reparent, resetImContext, resetRcStyles, resetStyle, runDispose, selectRegion, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, startEditing, stealData, stealQdata, styleAttach, styleGetProperty, textIndexToLayoutIndex, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetInvisibleChar, unsetStateFlags, watchClosure, windowPositionFunc.

Getters

getAccessible, getActionGroup, getActivateOnSingleClick, getActivatesDefault, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getAttributes, getBuffer, getCanDefault, getCanFocus, getChars, getChildRequisition, getChildVisible, getClip, getClipboard, getCompact, getCompletion, getCompositeName, getCurrentIconDragSource, getCursorHadjustment, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEditable, getEvents, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasFrame, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getIconActivatable, getIconArea, getIconAtPos, getIconGicon, getIconName, getIconPixbuf, getIconSensitive, getIconStock, getIconStorageType, getIconTooltipMarkup, getIconTooltipText, getInnerBorder, getInputHints, getInputPurpose, getInternalChild, getInvisibleChar, getLayout, getLayoutOffsets, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMaxLength, getMaxWidthChars, getModel, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOverwriteMode, getPangoContext, getParent, getParentWindow, getPath, getPlaceholderText, getPointer, getPopover, getPosition, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProgressFraction, getProgressPulseStep, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getRootWindow, getScaleFactor, getScreen, getSelectionBounds, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSuggestion, getSupportMultidevice, getTabs, getTemplateChild, getText, getTextArea, getTextLength, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTypedText, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisibility, getVisible, getVisual, getWidthChars, getWindow.

Setters

setAccelPath, setActivateOnSingleClick, setActivatesDefault, setAlignment, setAllocation, setAppPaintable, setAttributes, setBuffer, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompact, setCompletion, setCompositeName, setCursorHadjustment, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEditable, setEvents, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasFrame, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setIconActivatable, setIconDragSource, setIconFromGicon, setIconFromIconName, setIconFromPixbuf, setIconFromStock, setIconSensitive, setIconTooltipMarkup, setIconTooltipText, setInnerBorder, setInputHints, setInputPurpose, setInvisibleChar, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMaxLength, setMaxWidthChars, setModel, setName, setNoShowAll, setOpacity, setOverwriteMode, setParent, setParentWindow, setPlaceholderText, setPosition, setPositionFunc, setProgressFraction, setProgressPulseStep, setProperty, setRealized, setReceivesDefault, setRedrawOnAllocate, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSuggestion, setSupportMultidevice, setTabs, setText, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisibility, setVisible, setVisual, setWidthChars, setWindow.

defaultPositionFunc

suggestionEntryDefaultPositionFunc :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> Rectangle -> Bool -> Ptr () -> m ()

No description available in the introspection data.

getActivateOnSingleClick

suggestionEntryGetActivateOnSingleClick :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> m Bool

No description available in the introspection data.

getCompact

suggestionEntryGetCompact

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> m Bool

Returns: True if compact-mode is in use.

Gets the SuggestionEntry:compact property.

Since: 3.34

getModel

suggestionEntryGetModel

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> m (Maybe ListModel)

Returns: A ListModel or Nothing.

Gets the model being visualized.

getPopover

suggestionEntryGetPopover

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> m Widget

Returns: a Widget

Gets the result display widget for the entry. This is currently always a SuggestionPopover.

Since: 3.32

getSuggestion

suggestionEntryGetSuggestion

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> m (Maybe Suggestion)

Returns: An Suggestion or Nothing.

Gets the currently selected suggestion.

getTypedText

suggestionEntryGetTypedText :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> m Text

No description available in the introspection data.

hideSuggestions

suggestionEntryHideSuggestions :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> m ()

No description available in the introspection data.

new

suggestionEntryNew :: (HasCallStack, MonadIO m) => m SuggestionEntry

No description available in the introspection data.

setActivateOnSingleClick

suggestionEntrySetActivateOnSingleClick :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> Bool -> m ()

No description available in the introspection data.

setCompact

suggestionEntrySetCompact

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> Bool

compact: if compact mode should be used

-> m ()

Sets the SuggestionEntry:compact property.

Since: 3.34

setModel

suggestionEntrySetModel :: (HasCallStack, MonadIO m, IsSuggestionEntry a, IsListModel b) => a -> b -> m ()

No description available in the introspection data.

setPositionFunc

suggestionEntrySetPositionFunc

Arguments

:: (HasCallStack, MonadIO m, IsSuggestionEntry a)

=> a

self: a SuggestionEntry

-> Maybe SuggestionPositionFunc

func: A function to call to position the popover, or Nothing to set the default.

-> m ()

Sets a position func to position the popover.

In func, you should set the height of the rectangle to the maximum height that the popover should be allowed to grow.

Since: 3.26

setSuggestion

suggestionEntrySetSuggestion :: (HasCallStack, MonadIO m, IsSuggestionEntry a, IsSuggestion b) => a -> b -> m ()

No description available in the introspection data.

windowPositionFunc

suggestionEntryWindowPositionFunc :: (HasCallStack, MonadIO m, IsSuggestionEntry a) => a -> Rectangle -> Bool -> Ptr () -> m ()

This is a SuggestionPositionFunc that can be used to make the suggestion popover the full width of the window. It is similar to what you might find in a web browser.

Properties

activateOnSingleClick

The "activate-on-single-click" property denotes if results should be activated simply by clicking on them. You may want to set this to False if you want the behavior to only select the item.

Since: 3.30

constructSuggestionEntryActivateOnSingleClick :: (IsSuggestionEntry o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSuggestionEntryActivateOnSingleClick :: (MonadIO m, IsSuggestionEntry o) => o -> m Bool

Get the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

get suggestionEntry #activateOnSingleClick

setSuggestionEntryActivateOnSingleClick :: (MonadIO m, IsSuggestionEntry o) => o -> Bool -> m ()

Set the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

set suggestionEntry [ #activateOnSingleClick := value ]

compact

The "compact" property denotes if an alternate style should be used to reduce the width of the rows. This may be ideal in size contrained situations with portrait display.

Since: 3.34

constructSuggestionEntryCompact :: (IsSuggestionEntry o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSuggestionEntryCompact :: (MonadIO m, IsSuggestionEntry o) => o -> m Bool

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

get suggestionEntry #compact

setSuggestionEntryCompact :: (MonadIO m, IsSuggestionEntry o) => o -> Bool -> m ()

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

set suggestionEntry [ #compact := value ]

model

No description available in the introspection data.

constructSuggestionEntryModel :: (IsSuggestionEntry o, MonadIO m, IsListModel a) => a -> m (GValueConstruct o)

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

getSuggestionEntryModel :: (MonadIO m, IsSuggestionEntry o) => o -> m (Maybe ListModel)

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

get suggestionEntry #model

setSuggestionEntryModel :: (MonadIO m, IsSuggestionEntry o, IsListModel a) => o -> a -> m ()

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

set suggestionEntry [ #model := value ]

suggestion

The "suggestion" property is the currently selected suggestion, if any.

Since: 3.30

constructSuggestionEntrySuggestion :: (IsSuggestionEntry o, MonadIO m, IsSuggestion a) => a -> m (GValueConstruct o)

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

getSuggestionEntrySuggestion :: (MonadIO m, IsSuggestionEntry o) => o -> m (Maybe Suggestion)

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

get suggestionEntry #suggestion

setSuggestionEntrySuggestion :: (MonadIO m, IsSuggestionEntry o, IsSuggestion a) => o -> a -> m ()

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

set suggestionEntry [ #suggestion := value ]

typedText

No description available in the introspection data.

getSuggestionEntryTypedText :: (MonadIO m, IsSuggestionEntry o) => o -> m Text

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

get suggestionEntry #typedText

Signals

action

type SuggestionEntryActionCallback = Text -> Text -> Text -> IO ()

No description available in the introspection data.

afterSuggestionEntryAction :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryActionCallback) -> m SignalHandlerId

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

after suggestionEntry #action 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.

onSuggestionEntryAction :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryActionCallback) -> m SignalHandlerId

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

on suggestionEntry #action callback

activateSuggestion

type SuggestionEntryActivateSuggestionCallback = IO ()

No description available in the introspection data.

afterSuggestionEntryActivateSuggestion :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryActivateSuggestionCallback) -> m SignalHandlerId

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

after suggestionEntry #activateSuggestion 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.

onSuggestionEntryActivateSuggestion :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryActivateSuggestionCallback) -> m SignalHandlerId

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

on suggestionEntry #activateSuggestion callback

hideSuggestions

type SuggestionEntryHideSuggestionsCallback = IO ()

No description available in the introspection data.

afterSuggestionEntryHideSuggestions :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryHideSuggestionsCallback) -> m SignalHandlerId

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

after suggestionEntry #hideSuggestions 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.

onSuggestionEntryHideSuggestions :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryHideSuggestionsCallback) -> m SignalHandlerId

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

on suggestionEntry #hideSuggestions callback

moveSuggestion

type SuggestionEntryMoveSuggestionCallback

Arguments

 = Int32

amount: The number of items to move

-> IO ()

This moves the selected suggestion in the popover by the value provided. -1 moves up one row, 1, moves down a row.

afterSuggestionEntryMoveSuggestion :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryMoveSuggestionCallback) -> m SignalHandlerId

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

after suggestionEntry #moveSuggestion 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.

onSuggestionEntryMoveSuggestion :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryMoveSuggestionCallback) -> m SignalHandlerId

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

on suggestionEntry #moveSuggestion callback

showSuggestions

type SuggestionEntryShowSuggestionsCallback = IO ()

No description available in the introspection data.

afterSuggestionEntryShowSuggestions :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryShowSuggestionsCallback) -> m SignalHandlerId

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

after suggestionEntry #showSuggestions 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.

onSuggestionEntryShowSuggestions :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntryShowSuggestionsCallback) -> m SignalHandlerId

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

on suggestionEntry #showSuggestions callback

suggestionActivated

type SuggestionEntrySuggestionActivatedCallback = Suggestion -> IO ()

No description available in the introspection data.

afterSuggestionEntrySuggestionActivated :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntrySuggestionActivatedCallback) -> m SignalHandlerId

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

after suggestionEntry #suggestionActivated 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.

onSuggestionEntrySuggestionActivated :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntrySuggestionActivatedCallback) -> m SignalHandlerId

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

on suggestionEntry #suggestionActivated callback

suggestionSelected

type SuggestionEntrySuggestionSelectedCallback

Arguments

 = Suggestion

suggestion: a Suggestion

-> IO ()

This signal is emitted when a selection has been specifically selected by the user, such as by clicking on the row or moving to the row with keyboard, such as with SuggestionEntry::moveSuggestion

Since: 3.30

afterSuggestionEntrySuggestionSelected :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntrySuggestionSelectedCallback) -> m SignalHandlerId

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

after suggestionEntry #suggestionSelected 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.

onSuggestionEntrySuggestionSelected :: (IsSuggestionEntry a, MonadIO m) => a -> ((?self :: a) => SuggestionEntrySuggestionSelectedCallback) -> m SignalHandlerId

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

on suggestionEntry #suggestionSelected callback