Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype Completion = Completion (ManagedPtr Completion)
- class (GObject o, IsDescendantOf Completion o) => IsCompletion o
- toCompletion :: (MonadIO m, IsCompletion o) => o -> m Completion
- noCompletion :: Maybe Completion
- completionAddProvider :: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b) => a -> b -> m ()
- completionBlockInteractive :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m ()
- completionCreateContext :: (HasCallStack, MonadIO m, IsCompletion a) => a -> Maybe TextIter -> m CompletionContext
- completionGetInfoWindow :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m CompletionInfo
- completionGetProviders :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m [CompletionProvider]
- completionGetView :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m (Maybe View)
- completionHide :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m ()
- completionMoveWindow :: (HasCallStack, MonadIO m, IsCompletion a) => a -> TextIter -> m ()
- completionRemoveProvider :: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b) => a -> b -> m ()
- completionShow :: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b, IsCompletionContext c) => a -> [b] -> c -> m Bool
- completionUnblockInteractive :: (HasCallStack, MonadIO m, IsCompletion a) => a -> m ()
- constructCompletionAccelerators :: IsCompletion o => Word32 -> IO (GValueConstruct o)
- getCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> m Word32
- setCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()
- constructCompletionAutoCompleteDelay :: IsCompletion o => Word32 -> IO (GValueConstruct o)
- getCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> m Word32
- setCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()
- constructCompletionProposalPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o)
- getCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32
- setCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()
- constructCompletionProviderPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o)
- getCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32
- setCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()
- constructCompletionRememberInfoVisibility :: IsCompletion o => Bool -> IO (GValueConstruct o)
- getCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> m Bool
- setCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()
- constructCompletionSelectOnShow :: IsCompletion o => Bool -> IO (GValueConstruct o)
- getCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> m Bool
- setCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()
- constructCompletionShowHeaders :: IsCompletion o => Bool -> IO (GValueConstruct o)
- getCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> m Bool
- setCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()
- constructCompletionShowIcons :: IsCompletion o => Bool -> IO (GValueConstruct o)
- getCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> m Bool
- setCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()
- constructCompletionView :: (IsCompletion o, IsView a) => a -> IO (GValueConstruct o)
- getCompletionView :: (MonadIO m, IsCompletion o) => o -> m (Maybe View)
- type C_CompletionActivateProposalCallback = Ptr () -> Ptr () -> IO ()
- type CompletionActivateProposalCallback = IO ()
- afterCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId
- genClosure_CompletionActivateProposal :: MonadIO m => CompletionActivateProposalCallback -> m (GClosure C_CompletionActivateProposalCallback)
- mk_CompletionActivateProposalCallback :: C_CompletionActivateProposalCallback -> IO (FunPtr C_CompletionActivateProposalCallback)
- noCompletionActivateProposalCallback :: Maybe CompletionActivateProposalCallback
- onCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId
- wrap_CompletionActivateProposalCallback :: CompletionActivateProposalCallback -> C_CompletionActivateProposalCallback
- type C_CompletionHideCallback = Ptr () -> Ptr () -> IO ()
- type CompletionHideCallback = IO ()
- afterCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId
- genClosure_CompletionHide :: MonadIO m => CompletionHideCallback -> m (GClosure C_CompletionHideCallback)
- mk_CompletionHideCallback :: C_CompletionHideCallback -> IO (FunPtr C_CompletionHideCallback)
- noCompletionHideCallback :: Maybe CompletionHideCallback
- onCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId
- wrap_CompletionHideCallback :: CompletionHideCallback -> C_CompletionHideCallback
- type C_CompletionMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()
- type CompletionMoveCursorCallback = ScrollStep -> Int32 -> IO ()
- afterCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId
- genClosure_CompletionMoveCursor :: MonadIO m => CompletionMoveCursorCallback -> m (GClosure C_CompletionMoveCursorCallback)
- mk_CompletionMoveCursorCallback :: C_CompletionMoveCursorCallback -> IO (FunPtr C_CompletionMoveCursorCallback)
- noCompletionMoveCursorCallback :: Maybe CompletionMoveCursorCallback
- onCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId
- wrap_CompletionMoveCursorCallback :: CompletionMoveCursorCallback -> C_CompletionMoveCursorCallback
- type C_CompletionMovePageCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()
- type CompletionMovePageCallback = ScrollStep -> Int32 -> IO ()
- afterCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId
- genClosure_CompletionMovePage :: MonadIO m => CompletionMovePageCallback -> m (GClosure C_CompletionMovePageCallback)
- mk_CompletionMovePageCallback :: C_CompletionMovePageCallback -> IO (FunPtr C_CompletionMovePageCallback)
- noCompletionMovePageCallback :: Maybe CompletionMovePageCallback
- onCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId
- wrap_CompletionMovePageCallback :: CompletionMovePageCallback -> C_CompletionMovePageCallback
- type C_CompletionPopulateContextCallback = Ptr () -> Ptr CompletionContext -> Ptr () -> IO ()
- type CompletionPopulateContextCallback = CompletionContext -> IO ()
- afterCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId
- genClosure_CompletionPopulateContext :: MonadIO m => CompletionPopulateContextCallback -> m (GClosure C_CompletionPopulateContextCallback)
- mk_CompletionPopulateContextCallback :: C_CompletionPopulateContextCallback -> IO (FunPtr C_CompletionPopulateContextCallback)
- noCompletionPopulateContextCallback :: Maybe CompletionPopulateContextCallback
- onCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId
- wrap_CompletionPopulateContextCallback :: CompletionPopulateContextCallback -> C_CompletionPopulateContextCallback
- type C_CompletionShowCallback = Ptr () -> Ptr () -> IO ()
- type CompletionShowCallback = IO ()
- afterCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId
- genClosure_CompletionShow :: MonadIO m => CompletionShowCallback -> m (GClosure C_CompletionShowCallback)
- mk_CompletionShowCallback :: C_CompletionShowCallback -> IO (FunPtr C_CompletionShowCallback)
- noCompletionShowCallback :: Maybe CompletionShowCallback
- onCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId
- wrap_CompletionShowCallback :: CompletionShowCallback -> C_CompletionShowCallback
Exported types
newtype Completion Source #
Memory-managed wrapper type.
Completion (ManagedPtr Completion) |
Instances
GObject Completion Source # | |
Defined in GI.GtkSource.Objects.Completion gobjectType :: IO GType | |
HasParentTypes Completion Source # | |
Defined in GI.GtkSource.Objects.Completion | |
type ParentTypes Completion Source # | |
Defined in GI.GtkSource.Objects.Completion |
class (GObject o, IsDescendantOf Completion o) => IsCompletion o Source #
Type class for types which can be safely cast to Completion
, for instance with toCompletion
.
Instances
(GObject o, IsDescendantOf Completion o) => IsCompletion o Source # | |
Defined in GI.GtkSource.Objects.Completion |
toCompletion :: (MonadIO m, IsCompletion o) => o -> m Completion Source #
Cast to Completion
, for types for which this is known to be safe. For general casts, use castTo
.
noCompletion :: Maybe Completion Source #
A convenience alias for Nothing
:: Maybe
Completion
.
Methods
addProvider
completionAddProvider Source #
:: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Add a new CompletionProvider
to the completion object. This will
add a reference provider
, so make sure to unref your own copy when you
no longer need it.
blockInteractive
completionBlockInteractive Source #
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m () |
Block interactive completion. This can be used to disable interactive
completion when inserting or deleting text from the buffer associated with
the completion. Use completionUnblockInteractive
to enable
interactive completion again.
This function may be called multiple times. It will continue to block
interactive completion until completionUnblockInteractive
has been called the same number of times.
createContext
completionCreateContext Source #
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> Maybe TextIter | |
-> m CompletionContext | Returns: a new |
Create a new CompletionContext
for completion
. The position where
the completion occurs can be specified by position
. If position
is Nothing
,
the current cursor position will be used.
getInfoWindow
completionGetInfoWindow Source #
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m CompletionInfo | Returns: The |
The info widget is the window where the completion displays optional extra information of the proposal.
getProviders
completionGetProviders Source #
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m [CompletionProvider] | Returns:
list of |
Get list of providers registered on completion
. The returned list is owned
by the completion and should not be freed.
getView
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m (Maybe View) |
hide
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m () |
Hides the completion if it is active (visible).
moveWindow
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> TextIter |
|
-> m () |
Deprecated: (Since version 3.8)Use completionProviderGetStartIter
instead.
Move the completion window to a specific iter.
removeProvider
completionRemoveProvider Source #
:: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Remove provider
from the completion.
show
:: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b, IsCompletionContext c) | |
=> a |
|
-> [b] |
|
-> c |
|
-> m Bool | Returns: |
Starts a new completion with the specified CompletionContext
and
a list of potential candidate providers for completion.
It can be convenient for showing a completion on-the-fly, without the need to
add or remove providers to the Completion
.
Another solution is to add providers with
completionAddProvider
, and implement
completionProviderMatch
for each provider.
unblockInteractive
completionUnblockInteractive Source #
:: (HasCallStack, MonadIO m, IsCompletion a) | |
=> a |
|
-> m () |
Unblock interactive completion. This can be used after using
completionBlockInteractive
to enable interactive completion
again.
Properties
accelerators
Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo>.
constructCompletionAccelerators :: IsCompletion o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “accelerators
” property. This is rarely needed directly, but it is used by new
.
getCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> m Word32 Source #
Get the value of the “accelerators
” property.
When overloading is enabled, this is equivalent to
get
completion #accelerators
setCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> Word32 -> m () Source #
Set the value of the “accelerators
” property.
When overloading is enabled, this is equivalent to
set
completion [ #accelerators:=
value ]
autoCompleteDelay
Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.
constructCompletionAutoCompleteDelay :: IsCompletion o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “auto-complete-delay
” property. This is rarely needed directly, but it is used by new
.
getCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> m Word32 Source #
Get the value of the “auto-complete-delay
” property.
When overloading is enabled, this is equivalent to
get
completion #autoCompleteDelay
setCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> Word32 -> m () Source #
Set the value of the “auto-complete-delay
” property.
When overloading is enabled, this is equivalent to
set
completion [ #autoCompleteDelay:=
value ]
proposalPageSize
The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is pressed, the selected proposal becomes the one which is located one page size backward or forward.
See also the Completion
::move-cursor
signal.
constructCompletionProposalPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “proposal-page-size
” property. This is rarely needed directly, but it is used by new
.
getCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32 Source #
Get the value of the “proposal-page-size
” property.
When overloading is enabled, this is equivalent to
get
completion #proposalPageSize
setCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m () Source #
Set the value of the “proposal-page-size
” property.
When overloading is enabled, this is equivalent to
set
completion [ #proposalPageSize:=
value ]
providerPageSize
The scroll page size of the provider pages in the completion window.
See the Completion
::move-page
signal.
constructCompletionProviderPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “provider-page-size
” property. This is rarely needed directly, but it is used by new
.
getCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32 Source #
Get the value of the “provider-page-size
” property.
When overloading is enabled, this is equivalent to
get
completion #providerPageSize
setCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m () Source #
Set the value of the “provider-page-size
” property.
When overloading is enabled, this is equivalent to
set
completion [ #providerPageSize:=
value ]
rememberInfoVisibility
Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.
constructCompletionRememberInfoVisibility :: IsCompletion o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “remember-info-visibility
” property. This is rarely needed directly, but it is used by new
.
getCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> m Bool Source #
Get the value of the “remember-info-visibility
” property.
When overloading is enabled, this is equivalent to
get
completion #rememberInfoVisibility
setCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> Bool -> m () Source #
Set the value of the “remember-info-visibility
” property.
When overloading is enabled, this is equivalent to
set
completion [ #rememberInfoVisibility:=
value ]
selectOnShow
Determines whether the first proposal should be selected when the completion is first shown.
constructCompletionSelectOnShow :: IsCompletion o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “select-on-show
” property. This is rarely needed directly, but it is used by new
.
getCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> m Bool Source #
Get the value of the “select-on-show
” property.
When overloading is enabled, this is equivalent to
get
completion #selectOnShow
setCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> Bool -> m () Source #
Set the value of the “select-on-show
” property.
When overloading is enabled, this is equivalent to
set
completion [ #selectOnShow:=
value ]
showHeaders
Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.
constructCompletionShowHeaders :: IsCompletion o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-headers
” property. This is rarely needed directly, but it is used by new
.
getCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> m Bool Source #
Get the value of the “show-headers
” property.
When overloading is enabled, this is equivalent to
get
completion #showHeaders
setCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> Bool -> m () Source #
Set the value of the “show-headers
” property.
When overloading is enabled, this is equivalent to
set
completion [ #showHeaders:=
value ]
showIcons
Determines whether provider and proposal icons should be shown in the completion popup.
constructCompletionShowIcons :: IsCompletion o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-icons
” property. This is rarely needed directly, but it is used by new
.
getCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> m Bool Source #
Get the value of the “show-icons
” property.
When overloading is enabled, this is equivalent to
get
completion #showIcons
setCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> Bool -> m () Source #
Set the value of the “show-icons
” property.
When overloading is enabled, this is equivalent to
set
completion [ #showIcons:=
value ]
view
The View
bound to the completion object.
constructCompletionView :: (IsCompletion o, IsView a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “view
” property. This is rarely needed directly, but it is used by new
.
getCompletionView :: (MonadIO m, IsCompletion o) => o -> m (Maybe View) Source #
Get the value of the “view
” property.
When overloading is enabled, this is equivalent to
get
completion #view
Signals
activateProposal
type C_CompletionActivateProposalCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionActivateProposalCallback = IO () Source #
The Completion
::activate-proposal
signal is a
keybinding signal which gets emitted when the user initiates
a proposal activation.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the proposal
activation programmatically.
afterCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId Source #
Connect a signal handler for the “activate-proposal
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #activateProposal callback
genClosure_CompletionActivateProposal :: MonadIO m => CompletionActivateProposalCallback -> m (GClosure C_CompletionActivateProposalCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionActivateProposalCallback :: C_CompletionActivateProposalCallback -> IO (FunPtr C_CompletionActivateProposalCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionActivateProposalCallback
.
noCompletionActivateProposalCallback :: Maybe CompletionActivateProposalCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionActivateProposalCallback
onCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId Source #
Connect a signal handler for the “activate-proposal
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #activateProposal callback
wrap_CompletionActivateProposalCallback :: CompletionActivateProposalCallback -> C_CompletionActivateProposalCallback Source #
hide
type C_CompletionHideCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionHideCallback = IO () Source #
Emitted when the completion window is hidden. The default handler will actually hide the window.
afterCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId Source #
Connect a signal handler for the “hide
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #hide callback
genClosure_CompletionHide :: MonadIO m => CompletionHideCallback -> m (GClosure C_CompletionHideCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionHideCallback :: C_CompletionHideCallback -> IO (FunPtr C_CompletionHideCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionHideCallback
.
noCompletionHideCallback :: Maybe CompletionHideCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionHideCallback
onCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId Source #
Connect a signal handler for the “hide
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #hide callback
wrap_CompletionHideCallback :: CompletionHideCallback -> C_CompletionHideCallback Source #
Wrap a CompletionHideCallback
into a C_CompletionHideCallback
.
moveCursor
type C_CompletionMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionMoveCursorCallback Source #
= ScrollStep |
|
-> Int32 |
|
-> IO () |
The Completion
::move-cursor
signal is a keybinding
signal which gets emitted when the user initiates a cursor
movement.
The <keycap>Up</keycap>, <keycap>Down</keycap>, <keycap>PageUp</keycap>, <keycap>PageDown</keycap>, <keycap>Home</keycap> and <keycap>End</keycap> keys are bound to the normal behavior expected by those keys.
When step
is equal to ScrollStepPages
, the page size is defined by
the Completion
:proposal-page-size
property. It is used for
the <keycap>PageDown</keycap> and <keycap>PageUp</keycap> keys.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the cursor
programmatically.
afterCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the “move-cursor
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #moveCursor callback
genClosure_CompletionMoveCursor :: MonadIO m => CompletionMoveCursorCallback -> m (GClosure C_CompletionMoveCursorCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionMoveCursorCallback :: C_CompletionMoveCursorCallback -> IO (FunPtr C_CompletionMoveCursorCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionMoveCursorCallback
.
noCompletionMoveCursorCallback :: Maybe CompletionMoveCursorCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionMoveCursorCallback
onCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the “move-cursor
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #moveCursor callback
wrap_CompletionMoveCursorCallback :: CompletionMoveCursorCallback -> C_CompletionMoveCursorCallback Source #
Wrap a CompletionMoveCursorCallback
into a C_CompletionMoveCursorCallback
.
movePage
type C_CompletionMovePageCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionMovePageCallback Source #
= ScrollStep |
|
-> Int32 |
|
-> IO () |
The Completion
::move-page
signal is a keybinding
signal which gets emitted when the user initiates a page
movement (i.e. switches between provider pages).
<keycombo><keycap>Control</keycap><keycap>Left</keycap></keycombo> is for going to the previous provider. <keycombo><keycap>Control</keycap><keycap>Right</keycap></keycombo> is for going to the next provider. <keycombo><keycap>Control</keycap><keycap>Home</keycap></keycombo> is for displaying all the providers. <keycombo><keycap>Control</keycap><keycap>End</keycap></keycombo> is for going to the last provider.
When step
is equal to GTK_SCROLL_PAGES
, the page size is defined by
the Completion
:provider-page-size
property.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the page selection
programmatically.
afterCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId Source #
Connect a signal handler for the “move-page
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #movePage callback
genClosure_CompletionMovePage :: MonadIO m => CompletionMovePageCallback -> m (GClosure C_CompletionMovePageCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionMovePageCallback :: C_CompletionMovePageCallback -> IO (FunPtr C_CompletionMovePageCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionMovePageCallback
.
noCompletionMovePageCallback :: Maybe CompletionMovePageCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionMovePageCallback
onCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId Source #
Connect a signal handler for the “move-page
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #movePage callback
wrap_CompletionMovePageCallback :: CompletionMovePageCallback -> C_CompletionMovePageCallback Source #
Wrap a CompletionMovePageCallback
into a C_CompletionMovePageCallback
.
populateContext
type C_CompletionPopulateContextCallback = Ptr () -> Ptr CompletionContext -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionPopulateContextCallback Source #
= CompletionContext |
|
-> IO () |
Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context.
afterCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId Source #
Connect a signal handler for the “populate-context
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #populateContext callback
genClosure_CompletionPopulateContext :: MonadIO m => CompletionPopulateContextCallback -> m (GClosure C_CompletionPopulateContextCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionPopulateContextCallback :: C_CompletionPopulateContextCallback -> IO (FunPtr C_CompletionPopulateContextCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionPopulateContextCallback
.
noCompletionPopulateContextCallback :: Maybe CompletionPopulateContextCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionPopulateContextCallback
onCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId Source #
Connect a signal handler for the “populate-context
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #populateContext callback
wrap_CompletionPopulateContextCallback :: CompletionPopulateContextCallback -> C_CompletionPopulateContextCallback Source #
show
type C_CompletionShowCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionShowCallback = IO () Source #
Emitted when the completion window is shown. The default handler will actually show the window.
afterCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId Source #
Connect a signal handler for the “show
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completion #show callback
genClosure_CompletionShow :: MonadIO m => CompletionShowCallback -> m (GClosure C_CompletionShowCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionShowCallback :: C_CompletionShowCallback -> IO (FunPtr C_CompletionShowCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionShowCallback
.
noCompletionShowCallback :: Maybe CompletionShowCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionShowCallback
onCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId Source #
Connect a signal handler for the “show
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completion #show callback