GI.Handy.Objects.DialerCycleButton

The DialerCycleButton widget is a single button on an Dialer representing symbols such as digits, letters, #, + or ☃. When the button is pressed multiple times in a row, the symbols are cycled through. That is a call to get_curent_symbol returns another symbol each time the button is pressed. If no further button presses are received, cycling mode ends after a timeout. This is configurable via the DialerCycleButton:cycle-timeout property.

Exported types

newtype DialerCycleButton

Memory-managed wrapper type.

Constructors

DialerCycleButton (ManagedPtr DialerCycleButton)

Instances

Eq DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

Methods

(==) :: DialerCycleButton -> DialerCycleButton -> Bool

(/=) :: DialerCycleButton -> DialerCycleButton -> Bool

GObject DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

ManagedPtrNewtype DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

Methods

toManagedPtr :: DialerCycleButton -> ManagedPtr DialerCycleButton

TypedObject DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

Methods

glibType :: IO GType

HasParentTypes DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

IsGValue (Maybe DialerCycleButton)

Convert DialerCycleButton to and from GValue. See toGValue and fromGValue.

Defined in GI.Handy.Objects.DialerCycleButton

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe DialerCycleButton -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe DialerCycleButton)

type ParentTypes DialerCycleButton

Defined in GI.Handy.Objects.DialerCycleButton

type ParentTypes DialerCycleButton = '[DialerButton, Button, Bin, Container, Widget, Object, ImplementorIface, Actionable, Activatable, Buildable]

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.

Methods

Click to display all available methods, including inherited ones

Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, clicked, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, doSetRelatedAction, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, enter, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isCycling, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, leave, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, pressed, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, released, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, stopCycle, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getActionName, getActionTargetValue, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAlwaysShowImage, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getCurrentSymbol, getCycleTimeout, getData, getDeviceEnabled, getDeviceEvents, getDigit, getDirection, getDisplay, getDoubleBuffered, getEventWindow, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getImage, getImagePosition, getInternalChild, getLabel, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRelatedAction, getRelief, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getSymbols, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseStock, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setActionName, setActionTargetValue, setAlignment, setAllocation, setAlwaysShowImage, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setCycleTimeout, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setImage, setImagePosition, setLabel, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setRelief, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setUseStock, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

getCurrentSymbol

dialerCycleButtonGetCurrentSymbol

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m Char

Returns: a pointer to the symbol

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

Get the symbol the dialer should display

getCycleTimeout

dialerCycleButtonGetCycleTimeout

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m Int32

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

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

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

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

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

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

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

Set the cycle timeout in milliseconds.

stopCycle

dialerCycleButtonStopCycle

Arguments

:: (HasCallStack, MonadIO m, IsDialerCycleButton a)

=> a

self: a DialerCycleButton

-> m ()

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

Stop the cycling mode.

Properties

cycleTimeout

No description available in the introspection data.

constructDialerCycleButtonCycleTimeout :: (IsDialerCycleButton o, MonadIO m) => Int32 -> m (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 ()

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

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 cycleEnd 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 cycleEnd 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 ()

Deprecated: (Since version 0.0.12)This widget is considered a Dialer internalapi

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 cycleStart 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 cycleStart 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.