GI.Handy.Objects.DialerCycleButton

No description available in the introspection data.

Exported types

newtype DialerCycleButton

Memory-managed wrapper type.

Constructors

DialerCycleButton (ManagedPtr DialerCycleButton)

Instances

GObject DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

Methods

gobjectType :: IO GType

HasParentTypes DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

type ParentTypes DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

type ParentTypes DialerCycleButton = DialerButton ': (Button ': (Bin ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Actionable ': (Activatable ': (Buildable ': ([] :: [Type]))))))))))

class (GObject o, IsDescendantOf DialerCycleButton o) => IsDialerCycleButton o

Type class for types which can be safely cast to DialerCycleButton, for instance with toDialerCycleButton.

Instances

(GObject o, IsDescendantOf DialerCycleButton o) => IsDialerCycleButton o

Defined in GI.Handy.Objects.DialerCycleButton

toDialerCycleButton :: (MonadIO m, IsDialerCycleButton o) => o -> m DialerCycleButton

Cast to DialerCycleButton, for types for which this is known to be safe. For general casts, use castTo.

noDialerCycleButton :: Maybe DialerCycleButton

A convenience alias for Nothing :: Maybe DialerCycleButton.

Methods

getCurrentSymbol

dialerCycleButtonGetCurrentSymbol

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m Char

Returns: a pointer to the symbol

Get the symbol the dialer should display

getCycleTimeout

dialerCycleButtonGetCycleTimeout

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m Int32

Get the cycle timeout in milliseconds.

isCycling

dialerCycleButtonIsCycling

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m Bool

Returns: TRUE if the in cycling mode otherwise FALSE

Check whether the button is in cycling mode.

new

dialerCycleButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

symbols: the symbols displayed on the DialerCycleButton

-> m DialerCycleButton

Returns: the newly created DialerCycleButton widget

Create a new DialerCycleButton which displays symbols. The symbols can by cycled through by pressing the button multiple times.

setCycleTimeout

dialerCycleButtonSetCycleTimeout

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> Int32

timeout: the timeout in milliseconds

-> m ()

Set the cycle timeout in milliseconds.

stopCycle

dialerCycleButtonStopCycle

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m ()

Stop the cycling mode.

Properties

cycleTimeout

No description available in the introspection data.

constructDialerCycleButtonCycleTimeout :: IsDialerCycleButton o => Int32 -> IO (GValueConstruct o)

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

getDialerCycleButtonCycleTimeout :: (MonadIO m, IsDialerCycleButton o) => o -> m Int32

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

get dialerCycleButton #cycleTimeout

setDialerCycleButtonCycleTimeout :: (MonadIO m, IsDialerCycleButton o) => o -> Int32 -> m ()

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

set dialerCycleButton [ #cycleTimeout := value ]

Signals

cycleEnd

type C_DialerCycleButtonCycleEndCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DialerCycleButtonCycleEndCallback = IO ()

This signal is emitted when the cycle ends. This can either be because of timeout or because hdy_dialer_cycle_stop_cycle got called.

afterDialerCycleButtonCycleEnd :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleEndCallback -> m SignalHandlerId

Connect a signal handler for the “cycle-end” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialerCycleButton #cycleEnd callback

genClosure_DialerCycleButtonCycleEnd :: MonadIO m => DialerCycleButtonCycleEndCallback -> m (GClosure C_DialerCycleButtonCycleEndCallback)

Wrap the callback into a GClosure.

mk_DialerCycleButtonCycleEndCallback :: C_DialerCycleButtonCycleEndCallback -> IO (FunPtr C_DialerCycleButtonCycleEndCallback)

Generate a function pointer callable from C code, from a C_DialerCycleButtonCycleEndCallback.

noDialerCycleButtonCycleEndCallback :: Maybe DialerCycleButtonCycleEndCallback

A convenience synonym for Nothing :: Maybe DialerCycleButtonCycleEndCallback.

onDialerCycleButtonCycleEnd :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleEndCallback -> m SignalHandlerId

Connect a signal handler for the “cycle-end” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialerCycleButton #cycleEnd callback

wrap_DialerCycleButtonCycleEndCallback :: DialerCycleButtonCycleEndCallback -> C_DialerCycleButtonCycleEndCallback

Wrap a DialerCycleButtonCycleEndCallback into a C_DialerCycleButtonCycleEndCallback.

cycleStart

type C_DialerCycleButtonCycleStartCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DialerCycleButtonCycleStartCallback = IO ()

This signal is emitted when the button starts cycling (that is on the first button press).

afterDialerCycleButtonCycleStart :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleStartCallback -> m SignalHandlerId

Connect a signal handler for the “cycle-start” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialerCycleButton #cycleStart callback

genClosure_DialerCycleButtonCycleStart :: MonadIO m => DialerCycleButtonCycleStartCallback -> m (GClosure C_DialerCycleButtonCycleStartCallback)

Wrap the callback into a GClosure.

mk_DialerCycleButtonCycleStartCallback :: C_DialerCycleButtonCycleStartCallback -> IO (FunPtr C_DialerCycleButtonCycleStartCallback)

Generate a function pointer callable from C code, from a C_DialerCycleButtonCycleStartCallback.

noDialerCycleButtonCycleStartCallback :: Maybe DialerCycleButtonCycleStartCallback

A convenience synonym for Nothing :: Maybe DialerCycleButtonCycleStartCallback.

onDialerCycleButtonCycleStart :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleStartCallback -> m SignalHandlerId

Connect a signal handler for the “cycle-start” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialerCycleButton #cycleStart callback

wrap_DialerCycleButtonCycleStartCallback :: DialerCycleButtonCycleStartCallback -> C_DialerCycleButtonCycleStartCallback

Wrap a DialerCycleButtonCycleStartCallback into a C_DialerCycleButtonCycleStartCallback.