gi-handy-1.0.1: libhandy bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Handy.Objects.ActionRow

Description

No description available in the introspection data.

Synopsis

Exported types

class (GObject o, IsDescendantOf ActionRow o) => IsActionRow o Source #

Type class for types which can be safely cast to ActionRow, for instance with toActionRow.

Instances

Instances details
(GObject o, IsDescendantOf ActionRow o) => IsActionRow o Source # 
Instance details

Defined in GI.Handy.Objects.ActionRow

toActionRow :: (MonadIO m, IsActionRow o) => o -> m ActionRow Source #

Cast to ActionRow, 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, addPrefix, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, changed, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, 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, 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, isSelected, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getActionName, getActionTargetValue, getActivatable, getActivatableWidget, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHeader, getHexpand, getHexpandSet, getIconName, getIndex, getInternalChild, 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, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSelectable, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSubtitle, getSubtitleLines, getSupportMultidevice, getTemplateChild, getTitle, getTitleLines, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setActionName, setActionTargetValue, setActivatable, setActivatableWidget, setAllocation, 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, setHeader, setHexpand, setHexpandSet, setIconName, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSelectable, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSubtitle, setSubtitleLines, setSupportMultidevice, setTitle, setTitleLines, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

activate

actionRowActivate :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m () Source #

No description available in the introspection data.

addPrefix

actionRowAddPrefix Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) 
=> a

self: a ActionRow

-> b

widget: the prefix widget

-> m () 

Adds a prefix widget to self.

Since: 0.0.6

getActivatableWidget

actionRowGetActivatableWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m (Maybe Widget)

Returns: the widget activated when self is activated, or Nothing if none has been set.

Gets the widget activated when self is activated.

Since: 0.0.7

getIconName

actionRowGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m Text

Returns: the icon name for self. The returned string is owned by the ActionRow and should not be freed.

Gets the icon name for self.

Since: 0.0.6

getSubtitle

actionRowGetSubtitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m (Maybe Text)

Returns: the subtitle for self, or Nothing.

Gets the subtitle for self.

Since: 0.0.6

getSubtitleLines

actionRowGetSubtitleLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m Int32

Returns: the number of lines at the end of which the subtitle label will be ellipsized.

Gets the number of lines at the end of which the subtitle label will be ellipsized. If the value is 0, the number of lines won't be limited.

Since: 1.2

getTitleLines

actionRowGetTitleLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m Int32

Returns: the number of lines at the end of which the title label will be ellipsized.

Gets the number of lines at the end of which the title label will be ellipsized. If the value is 0, the number of lines won't be limited.

Since: 1.2

getUseUnderline

actionRowGetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> m Bool

Returns: True if an embedded underline in the title and subtitle labels indicates the mnemonic accelerator keys.

Gets whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic. See actionRowSetUseUnderline.

Since: 0.0.6

new

actionRowNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m ActionRow

Returns: a new ActionRow

Creates a new ActionRow.

Since: 0.0.6

setActivatableWidget

actionRowSetActivatableWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) 
=> a

self: a ActionRow

-> Maybe b

widget: the target Widget, or Nothing to unset

-> m () 

Sets the widget to activate when self is activated, either by clicking on it, by calling actionRowActivate, or via mnemonics in the title or the subtitle. See the “use_underline” property to enable mnemonics.

The target widget will be activated by emitting the GtkWidget[mnemonicActivate](#g:signal:mnemonicActivate) signal on it.

Since: 0.0.7

setIconName

actionRowSetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> Text

iconName: the icon name

-> m () 

Sets the icon name for self.

Since: 0.0.6

setSubtitle

actionRowSetSubtitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> Maybe Text

subtitle: the subtitle

-> m () 

Sets the subtitle for self.

Since: 0.0.6

setSubtitleLines

actionRowSetSubtitleLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> Int32

subtitleLines: the number of lines at the end of which the subtitle label will be ellipsized

-> m () 

Sets the number of lines at the end of which the subtitle label will be ellipsized. If the value is 0, the number of lines won't be limited.

Since: 1.2

setTitleLines

actionRowSetTitleLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> Int32

titleLines: the number of lines at the end of which the title label will be ellipsized

-> m () 

Sets the number of lines at the end of which the title label will be ellipsized. If the value is 0, the number of lines won't be limited.

Since: 1.2

setUseUnderline

actionRowSetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a) 
=> a

self: a ActionRow

-> Bool

useUnderline: True if underlines in the text indicate mnemonics

-> m () 

If true, an underline in the text of the title and subtitle labels indicates the next character should be used for the mnemonic accelerator key.

Since: 0.0.6

Properties

activatableWidget

The activatable widget for this row.

Since: 0.0.7

clearActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m () Source #

Set the value of the “activatable-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #activatableWidget

constructActionRowActivatableWidget :: (IsActionRow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

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

getActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m (Maybe Widget) Source #

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

get actionRow #activatableWidget

setActionRowActivatableWidget :: (MonadIO m, IsActionRow o, IsWidget a) => o -> a -> m () Source #

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

set actionRow [ #activatableWidget := value ]

iconName

The icon name for this row.

Since: 0.0.6

constructActionRowIconName :: (IsActionRow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getActionRowIconName :: (MonadIO m, IsActionRow o) => o -> m Text Source #

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

get actionRow #iconName

setActionRowIconName :: (MonadIO m, IsActionRow o) => o -> Text -> m () Source #

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

set actionRow [ #iconName := value ]

subtitle

The subtitle for this row.

Since: 0.0.6

clearActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m () Source #

Set the value of the “subtitle” property to Nothing. When overloading is enabled, this is equivalent to

clear #subtitle

constructActionRowSubtitle :: (IsActionRow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m (Maybe Text) Source #

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

get actionRow #subtitle

setActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> Text -> m () Source #

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

set actionRow [ #subtitle := value ]

subtitleLines

The number of lines at the end of which the subtitle label will be ellipsized. Set this property to 0 if you don't want to limit the number of lines.

Since: 1.2

constructActionRowSubtitleLines :: (IsActionRow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getActionRowSubtitleLines :: (MonadIO m, IsActionRow o) => o -> m Int32 Source #

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

get actionRow #subtitleLines

setActionRowSubtitleLines :: (MonadIO m, IsActionRow o) => o -> Int32 -> m () Source #

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

set actionRow [ #subtitleLines := value ]

titleLines

The number of lines at the end of which the title label will be ellipsized. Set this property to 0 if you don't want to limit the number of lines.

Since: 1.2

constructActionRowTitleLines :: (IsActionRow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getActionRowTitleLines :: (MonadIO m, IsActionRow o) => o -> m Int32 Source #

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

get actionRow #titleLines

setActionRowTitleLines :: (MonadIO m, IsActionRow o) => o -> Int32 -> m () Source #

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

set actionRow [ #titleLines := value ]

useUnderline

Whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic.

Since: 0.0.6

constructActionRowUseUnderline :: (IsActionRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> m Bool Source #

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

get actionRow #useUnderline

setActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> Bool -> m () Source #

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

set actionRow [ #useUnderline := value ]

Signals

activated

type ActionRowActivatedCallback = IO () Source #

This signal is emitted after the row has been activated.

Since: 1.0

afterActionRowActivated :: (IsActionRow a, MonadIO m) => a -> ((?self :: a) => ActionRowActivatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after actionRow #activated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onActionRowActivated :: (IsActionRow a, MonadIO m) => a -> ((?self :: a) => ActionRowActivatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on actionRow #activated callback