gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.VolumeButton

Contents

- Exported types
- Methods
  - new
- Properties
  - useSymbolic

Description

`VolumeButton` is a subclass of `ScaleButton` that has been tailored for use as a volume control widget with suitable icons, tooltips and accessible labels.

Synopsis

- newtype VolumeButton = VolumeButton (ManagedPtr VolumeButton)
- class (GObject o, IsDescendantOf VolumeButton o) => IsVolumeButton o
- toVolumeButton :: (MonadIO m, IsVolumeButton o) => o -> m VolumeButton
- volumeButtonNew :: (HasCallStack, MonadIO m) => m VolumeButton
- constructVolumeButtonUseSymbolic :: (IsVolumeButton o, MonadIO m) => Bool -> m (GValueConstruct o)
- getVolumeButtonUseSymbolic :: (MonadIO m, IsVolumeButton o) => o -> m Bool
- setVolumeButtonUseSymbolic :: (MonadIO m, IsVolumeButton o) => o -> Bool -> m ()

# Exported types

newtype VolumeButton Source #

Memory-managed wrapper type.

Constructors

VolumeButton (ManagedPtr VolumeButton) |

#### Instances

Instances details

Eq VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton Methods (==) :: VolumeButton -> VolumeButton -> Bool Source # (/=) :: VolumeButton -> VolumeButton -> Bool Source #
GObject VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton
ManagedPtrNewtype VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton Methods toManagedPtr :: VolumeButton -> ManagedPtr VolumeButton Source #
TypedObject VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton Methods glibType :: IO GType Source #
HasParentTypes VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton
IsGValue (Maybe VolumeButton) Source # | Convert `VolumeButton` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.VolumeButton Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe VolumeButton -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe VolumeButton) Source #
type ParentTypes VolumeButton Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton type ParentTypes VolumeButton = '[ScaleButton, Button, Bin, Container, Widget, Object, ImplementorIface, Actionable, Activatable, Buildable, Orientable]

class (GObject o, IsDescendantOf VolumeButton o) => IsVolumeButton o Source #

Type class for types which can be safely cast to `VolumeButton`, for instance with `toVolumeButton`.

#### Instances

Instances details

(GObject o, IsDescendantOf VolumeButton o) => IsVolumeButton o Source # |
Instance details Defined in GI.Gtk.Objects.VolumeButton

toVolumeButton :: (MonadIO m, IsVolumeButton o) => o -> m VolumeButton Source #

Cast to `VolumeButton`, 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

Expand

#### 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, 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, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getActionName, getActionTargetValue, getAdjustment, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAlwaysShowImage, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, 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, getMinusButton, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPlusButton, getPointer, getPopup, 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, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseStock, getUseUnderline, getValign, getValignWithBaseline, getValue, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

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

## new

volumeButtonNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m VolumeButton | Returns: a new `VolumeButton`

Creates a `VolumeButton`, with a range between 0.0 and 1.0, with a stepping of 0.02. Volume values can be obtained and modified using the functions from `ScaleButton`.

Since: 2.12

# Properties

## useSymbolic

Whether to use symbolic icons as the icons. Note that if the symbolic icons are not available in your installed theme, then the normal (potentially colorful) icons will be used.

Since: 3.0

constructVolumeButtonUseSymbolic :: (IsVolumeButton o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getVolumeButtonUseSymbolic :: (MonadIO m, IsVolumeButton o) => o -> m Bool Source #

Get the value of the “`use-symbolic`” property. When overloading is enabled, this is equivalent to

    get volumeButton #useSymbolic

setVolumeButtonUseSymbolic :: (MonadIO m, IsVolumeButton o) => o -> Bool -> m () Source #

Set the value of the “`use-symbolic`” property. When overloading is enabled, this is equivalent to

    set volumeButton [ #useSymbolic := value ]