gi-handy-0.0.4: libhandy bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Handy.Objects.DialerCycleButton

Contents

Description

No description available in the introspection data.

Synopsis

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.

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

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

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

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