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

Description

No description available in the introspection data.

Synopsis

Exported types

newtype ComboRow Source #

Memory-managed wrapper type.

Constructors

ComboRow (ManagedPtr ComboRow) 

class (GObject o, IsDescendantOf ComboRow o) => IsComboRow o Source #

Type class for types which can be safely cast to ComboRow, for instance with toComboRow.

Instances

Instances details
(GObject o, IsDescendantOf ComboRow o) => IsComboRow o Source # 
Instance details

Defined in GI.Handy.Objects.ComboRow

toComboRow :: (MonadIO m, IsComboRow o) => o -> m ComboRow Source #

Cast to ComboRow, 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, bindModel, bindNameModel, 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, getModel, 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, getSelectedIndex, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSubtitle, getSubtitleLines, getSupportMultidevice, getTemplateChild, getTitle, getTitleLines, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseSubtitle, 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, setForEnum, setGetNameFunc, 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, setSelectedIndex, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSubtitle, setSubtitleLines, setSupportMultidevice, setTitle, setTitleLines, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseSubtitle, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

bindModel

comboRowBindModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b) 
=> a

self: a ComboRow

-> Maybe b

model: the ListModel to be bound to self

-> Maybe ListBoxCreateWidgetFunc

createListWidgetFunc: a function that creates widgets for items to display in the list, or Nothing in case you also passed Nothing as model

-> Maybe ListBoxCreateWidgetFunc

createCurrentWidgetFunc: a function that creates widgets for items to display as the selected item, or Nothing in case you also passed Nothing as model

-> m () 

Binds model to self.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

Since: 0.0.6

bindNameModel

comboRowBindNameModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsComboRow a, IsListModel b) 
=> a

self: a ComboRow

-> Maybe b

model: the ListModel to be bound to self

-> Maybe ComboRowGetNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m () 

Binds model to self.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

This is more convenient to use than comboRowBindModel if you want to represent items of the model with names.

Since: 0.0.6

getModel

comboRowGetModel Source #

Arguments

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

self: a ComboRow

-> m (Maybe ListModel)

Returns: the ListModel bound to self or Nothing

Gets the model bound to self, or Nothing if none is bound.

Since: 0.0.6

getSelectedIndex

comboRowGetSelectedIndex Source #

Arguments

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

self: a ListBoxRow

-> m Int32

Returns: the index of the selected item, or -1 if no item is selected

Gets the index of the selected item in its ListModel.

Since: 0.0.7

getUseSubtitle

comboRowGetUseSubtitle Source #

Arguments

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

self: a ListBoxRow

-> m Bool

Returns: whether the current value of self should be displayed as its subtitle

Gets whether the current value of self should be displayed as its subtitle.

Since: 0.0.10

new

comboRowNew Source #

Arguments

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

Returns: a new ComboRow

Creates a new ComboRow.

Since: 0.0.6

setForEnum

comboRowSetForEnum Source #

Arguments

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

self: a ComboRow

-> GType

enumType: the enumeration GType to be bound to self

-> Maybe ComboRowGetEnumValueNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m () 

Creates a model for enumType and binds it to self. The items of the model will be EnumValueObject objects.

If self was already bound to a model, that previous binding is destroyed.

The contents of self are cleared and then filled with widgets that represent items from model. self is updated whenever model changes. If model is Nothing, self is left empty.

This is more convenient to use than comboRowBindNameModel if you want to represent values of an enumeration with names.

See enumValueRowName.

Since: 0.0.6

setGetNameFunc

comboRowSetGetNameFunc Source #

Arguments

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

self: a ComboRow

-> Maybe ComboRowGetNameFunc

getNameFunc: a function that creates names for items, or Nothing in case you also passed Nothing as model

-> m () 

Sets a closure to convert items into names. See HdyComboRow:use-subtitle.

Since: 0.0.10

setSelectedIndex

comboRowSetSelectedIndex Source #

Arguments

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

self: a ComboRow

-> Int32

selectedIndex: the index of the selected item

-> m () 

Sets the index of the selected item in its ListModel.

Since: 0.0.7

setUseSubtitle

comboRowSetUseSubtitle Source #

Arguments

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

self: a ComboRow

-> Bool

useSubtitle: True to set the current value as the subtitle

-> m () 

Sets whether the current value of self should be displayed as its subtitle.

If True, you should not access HdyActionRow:subtitle.

Since: 0.0.10

Properties

selectedIndex

The index of the selected item in its ListModel.

Since: 0.0.7

constructComboRowSelectedIndex :: (IsComboRow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> m Int32 Source #

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

get comboRow #selectedIndex

setComboRowSelectedIndex :: (MonadIO m, IsComboRow o) => o -> Int32 -> m () Source #

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

set comboRow [ #selectedIndex := value ]

useSubtitle

True to set the current value as the subtitle.

If you use a custom widget creation function, you will need to give the row a name conversion closure with comboRowSetGetNameFunc.

If True, you should not access HdyActionRow:subtitle.

Since: 0.0.10

constructComboRowUseSubtitle :: (IsComboRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> m Bool Source #

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

get comboRow #useSubtitle

setComboRowUseSubtitle :: (MonadIO m, IsComboRow o) => o -> Bool -> m () Source #

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

set comboRow [ #useSubtitle := value ]