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

GI.Handy.Objects.DialerCycleButton

Contents

Exported types
Methods
Properties
- cycleTimeout
Signals
- cycleEnd
- cycleStart

Description

No description available in the introspection data.

Synopsis

newtype DialerCycleButton = DialerCycleButton (ManagedPtr DialerCycleButton)
class (GObject o, IsDescendantOf DialerCycleButton o) => IsDialerCycleButton o
toDialerCycleButton :: (MonadIO m, IsDialerCycleButton o) => o -> m DialerCycleButton
noDialerCycleButton :: Maybe DialerCycleButton
dialerCycleButtonGetCurrentSymbol :: (HasCallStack, MonadIO m, IsDialerCycleButton a) => a -> m Char
dialerCycleButtonGetCycleTimeout :: (HasCallStack, MonadIO m, IsDialerCycleButton a) => a -> m Int32
dialerCycleButtonIsCycling :: (HasCallStack, MonadIO m, IsDialerCycleButton a) => a -> m Bool
dialerCycleButtonNew :: (HasCallStack, MonadIO m) => Text -> m DialerCycleButton
dialerCycleButtonSetCycleTimeout :: (HasCallStack, MonadIO m, IsDialerCycleButton a) => a -> Int32 -> m ()
dialerCycleButtonStopCycle :: (HasCallStack, MonadIO m, IsDialerCycleButton a) => a -> m ()
constructDialerCycleButtonCycleTimeout :: IsDialerCycleButton o => Int32 -> IO (GValueConstruct o)
getDialerCycleButtonCycleTimeout :: (MonadIO m, IsDialerCycleButton o) => o -> m Int32
setDialerCycleButtonCycleTimeout :: (MonadIO m, IsDialerCycleButton o) => o -> Int32 -> m ()
type C_DialerCycleButtonCycleEndCallback = Ptr () -> Ptr () -> IO ()
type DialerCycleButtonCycleEndCallback = IO ()
afterDialerCycleButtonCycleEnd :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleEndCallback -> m SignalHandlerId
genClosure_DialerCycleButtonCycleEnd :: MonadIO m => DialerCycleButtonCycleEndCallback -> m (GClosure C_DialerCycleButtonCycleEndCallback)
mk_DialerCycleButtonCycleEndCallback :: C_DialerCycleButtonCycleEndCallback -> IO (FunPtr C_DialerCycleButtonCycleEndCallback)
noDialerCycleButtonCycleEndCallback :: Maybe DialerCycleButtonCycleEndCallback
onDialerCycleButtonCycleEnd :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleEndCallback -> m SignalHandlerId
wrap_DialerCycleButtonCycleEndCallback :: DialerCycleButtonCycleEndCallback -> C_DialerCycleButtonCycleEndCallback
type C_DialerCycleButtonCycleStartCallback = Ptr () -> Ptr () -> IO ()
type DialerCycleButtonCycleStartCallback = IO ()
afterDialerCycleButtonCycleStart :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleStartCallback -> m SignalHandlerId
genClosure_DialerCycleButtonCycleStart :: MonadIO m => DialerCycleButtonCycleStartCallback -> m (GClosure C_DialerCycleButtonCycleStartCallback)
mk_DialerCycleButtonCycleStartCallback :: C_DialerCycleButtonCycleStartCallback -> IO (FunPtr C_DialerCycleButtonCycleStartCallback)
noDialerCycleButtonCycleStartCallback :: Maybe DialerCycleButtonCycleStartCallback
onDialerCycleButtonCycleStart :: (IsDialerCycleButton a, MonadIO m) => a -> DialerCycleButtonCycleStartCallback -> m SignalHandlerId
wrap_DialerCycleButtonCycleStartCallback :: DialerCycleButtonCycleStartCallback -> C_DialerCycleButtonCycleStartCallback

Exported types

newtype DialerCycleButton Source #

Memory-managed wrapper type.

Constructors

DialerCycleButton (ManagedPtr DialerCycleButton)

Instances

GObject DialerCycleButton Source #
Instance details Defined in GI.Handy.Objects.DialerCycleButton Methods gobjectType :: IO GType #
HasParentTypes DialerCycleButton Source #
Instance details Defined in GI.Handy.Objects.DialerCycleButton
type ParentTypes DialerCycleButton Source #
Instance details 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 Source #

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

Instances

(GObject o, IsDescendantOf DialerCycleButton o) => IsDialerCycleButton o Source #
Instance details Defined in GI.Handy.Objects.DialerCycleButton

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

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

noDialerCycleButton :: Maybe DialerCycleButton Source #

A convenience alias for Nothing :: Maybe DialerCycleButton.

Methods

getCurrentSymbol

dialerCycleButtonGetCurrentSymbol Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)
=> a	`self`: a `DialerCycleButton`
-> m Int32

Get the cycle timeout in milliseconds.

isCycling

dialerCycleButtonIsCycling Source #

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 Source #

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 Source #

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 Source #

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) Source #

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 Source #

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 () Source #

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 () Source #

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

type DialerCycleButtonCycleEndCallback = IO () Source #

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 Source #

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) Source #

Wrap the callback into a GClosure.

mk_DialerCycleButtonCycleEndCallback :: C_DialerCycleButtonCycleEndCallback -> IO (FunPtr C_DialerCycleButtonCycleEndCallback) Source #

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

noDialerCycleButtonCycleEndCallback :: Maybe DialerCycleButtonCycleEndCallback Source #

A convenience synonym for Nothing :: Maybe DialerCycleButtonCycleEndCallback.

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

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 Source #

Wrap a DialerCycleButtonCycleEndCallback into a C_DialerCycleButtonCycleEndCallback.

cycleStart

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

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

type DialerCycleButtonCycleStartCallback = IO () Source #

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 Source #

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) Source #

Wrap the callback into a GClosure.

mk_DialerCycleButtonCycleStartCallback :: C_DialerCycleButtonCycleStartCallback -> IO (FunPtr C_DialerCycleButtonCycleStartCallback) Source #

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

noDialerCycleButtonCycleStartCallback :: Maybe DialerCycleButtonCycleStartCallback Source #

A convenience synonym for Nothing :: Maybe DialerCycleButtonCycleStartCallback.

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

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 Source #

Wrap a DialerCycleButtonCycleStartCallback into a C_DialerCycleButtonCycleStartCallback.