Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
EventControllerFocus
is an event controller meant for situations
where you need to know where the focus is.
Synopsis
- newtype EventControllerFocus = EventControllerFocus (ManagedPtr EventControllerFocus)
- class (GObject o, IsDescendantOf EventControllerFocus o) => IsEventControllerFocus o
- toEventControllerFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m EventControllerFocus
- eventControllerFocusContainsFocus :: (HasCallStack, MonadIO m, IsEventControllerFocus a) => a -> m Bool
- eventControllerFocusIsFocus :: (HasCallStack, MonadIO m, IsEventControllerFocus a) => a -> m Bool
- eventControllerFocusNew :: (HasCallStack, MonadIO m) => m EventControllerFocus
- getEventControllerFocusContainsFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m Bool
- getEventControllerFocusIsFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m Bool
- type C_EventControllerFocusEnterCallback = Ptr () -> Ptr () -> IO ()
- type EventControllerFocusEnterCallback = IO ()
- afterEventControllerFocusEnter :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusEnterCallback -> m SignalHandlerId
- genClosure_EventControllerFocusEnter :: MonadIO m => EventControllerFocusEnterCallback -> m (GClosure C_EventControllerFocusEnterCallback)
- mk_EventControllerFocusEnterCallback :: C_EventControllerFocusEnterCallback -> IO (FunPtr C_EventControllerFocusEnterCallback)
- noEventControllerFocusEnterCallback :: Maybe EventControllerFocusEnterCallback
- onEventControllerFocusEnter :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusEnterCallback -> m SignalHandlerId
- wrap_EventControllerFocusEnterCallback :: EventControllerFocusEnterCallback -> C_EventControllerFocusEnterCallback
- type C_EventControllerFocusLeaveCallback = Ptr () -> Ptr () -> IO ()
- type EventControllerFocusLeaveCallback = IO ()
- afterEventControllerFocusLeave :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusLeaveCallback -> m SignalHandlerId
- genClosure_EventControllerFocusLeave :: MonadIO m => EventControllerFocusLeaveCallback -> m (GClosure C_EventControllerFocusLeaveCallback)
- mk_EventControllerFocusLeaveCallback :: C_EventControllerFocusLeaveCallback -> IO (FunPtr C_EventControllerFocusLeaveCallback)
- noEventControllerFocusLeaveCallback :: Maybe EventControllerFocusLeaveCallback
- onEventControllerFocusLeave :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusLeaveCallback -> m SignalHandlerId
- wrap_EventControllerFocusLeaveCallback :: EventControllerFocusLeaveCallback -> C_EventControllerFocusLeaveCallback
Exported types
newtype EventControllerFocus Source #
Memory-managed wrapper type.
EventControllerFocus (ManagedPtr EventControllerFocus) |
Instances
class (GObject o, IsDescendantOf EventControllerFocus o) => IsEventControllerFocus o Source #
Type class for types which can be safely cast to EventControllerFocus
, for instance with toEventControllerFocus
.
Instances
(GObject o, IsDescendantOf EventControllerFocus o) => IsEventControllerFocus o Source # | |
Defined in GI.Gtk.Objects.EventControllerFocus |
toEventControllerFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m EventControllerFocus Source #
Cast to EventControllerFocus
, 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, containsFocus, forceFloating, freezeNotify, getv, isFloating, isFocus, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getData, getName, getPropagationLimit, getPropagationPhase, getProperty, getQdata, getWidget.
Setters
setData, setDataFull, setName, setPropagationLimit, setPropagationPhase, setProperty.
containsFocus
eventControllerFocusContainsFocus Source #
:: (HasCallStack, MonadIO m, IsEventControllerFocus a) | |
=> a |
|
-> m Bool | Returns: |
Returns the value of the GtkEventControllerFocus:contains-focus property.
isFocus
eventControllerFocusIsFocus Source #
:: (HasCallStack, MonadIO m, IsEventControllerFocus a) | |
=> a |
|
-> m Bool | Returns: |
Returns the value of the GtkEventControllerFocus:is-focus property.
new
eventControllerFocusNew Source #
:: (HasCallStack, MonadIO m) | |
=> m EventControllerFocus | Returns: a new |
Creates a new event controller that will handle focus events.
Properties
containsFocus
Whether focus is contain in the controllers widget. See
See EventControllerFocus
:is-focus
for whether the focus is in the widget itself
or inside a descendent.
When handling focus events, this property is updated before enter or leave are emitted.
getEventControllerFocusContainsFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m Bool Source #
Get the value of the “contains-focus
” property.
When overloading is enabled, this is equivalent to
get
eventControllerFocus #containsFocus
isFocus
Whether focus is in the controllers widget itself,
opposed to in a descendent widget. See also
EventControllerFocus
:contains-focus
.
When handling focus events, this property is updated before enter or leave are emitted.
getEventControllerFocusIsFocus :: (MonadIO m, IsEventControllerFocus o) => o -> m Bool Source #
Get the value of the “is-focus
” property.
When overloading is enabled, this is equivalent to
get
eventControllerFocus #isFocus
Signals
enter
type C_EventControllerFocusEnterCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type EventControllerFocusEnterCallback = IO () Source #
This signal is emitted whenever the focus enters into the widget or one of its descendents.
Note that this means you may not get an enter signal
even though the widget becomes the focus location, in
certain cases (such as when the focus moves from a descendent
of the widget to the widget itself). If you are interested
in these cases, you can monitor the EventControllerFocus
:is-focus
property for changes.
afterEventControllerFocusEnter :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusEnterCallback -> m SignalHandlerId Source #
Connect a signal handler for the enter signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
eventControllerFocus #enter callback
genClosure_EventControllerFocusEnter :: MonadIO m => EventControllerFocusEnterCallback -> m (GClosure C_EventControllerFocusEnterCallback) Source #
Wrap the callback into a GClosure
.
mk_EventControllerFocusEnterCallback :: C_EventControllerFocusEnterCallback -> IO (FunPtr C_EventControllerFocusEnterCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerFocusEnterCallback
.
noEventControllerFocusEnterCallback :: Maybe EventControllerFocusEnterCallback Source #
A convenience synonym for
.Nothing
:: Maybe
EventControllerFocusEnterCallback
onEventControllerFocusEnter :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusEnterCallback -> m SignalHandlerId Source #
Connect a signal handler for the enter signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
eventControllerFocus #enter callback
wrap_EventControllerFocusEnterCallback :: EventControllerFocusEnterCallback -> C_EventControllerFocusEnterCallback Source #
leave
type C_EventControllerFocusLeaveCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type EventControllerFocusLeaveCallback = IO () Source #
This signal is emitted whenever the focus leaves the widget hierarchy that is rooted at the widget that the controller is attached to.
Note that this means you may not get a leave signal
even though the focus moves away from the widget, in
certain cases (such as when the focus moves from the widget
to a descendent). If you are interested in these cases, you
can monitor the EventControllerFocus
:is-focus
property
for changes.
afterEventControllerFocusLeave :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusLeaveCallback -> m SignalHandlerId Source #
Connect a signal handler for the leave signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
eventControllerFocus #leave callback
genClosure_EventControllerFocusLeave :: MonadIO m => EventControllerFocusLeaveCallback -> m (GClosure C_EventControllerFocusLeaveCallback) Source #
Wrap the callback into a GClosure
.
mk_EventControllerFocusLeaveCallback :: C_EventControllerFocusLeaveCallback -> IO (FunPtr C_EventControllerFocusLeaveCallback) Source #
Generate a function pointer callable from C code, from a C_EventControllerFocusLeaveCallback
.
noEventControllerFocusLeaveCallback :: Maybe EventControllerFocusLeaveCallback Source #
A convenience synonym for
.Nothing
:: Maybe
EventControllerFocusLeaveCallback
onEventControllerFocusLeave :: (IsEventControllerFocus a, MonadIO m) => a -> EventControllerFocusLeaveCallback -> m SignalHandlerId Source #
Connect a signal handler for the leave signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
eventControllerFocus #leave callback