gi-gtk4-4.0.12: Gtk 4.x bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.ListBase

Description

The abstract base class for GTK's list widgets.

Shortcuts and Gestures

GtkListBase supports the following keyboard shortcuts:

  • <kbd>Ctrl</kbd>+<kbd>A</kbd> or <kbd>Ctrl</kbd>+<kbd>&sol;</kbd> selects all items.
  • <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>A</kbd> or <kbd>Ctrl</kbd>+<kbd>&bsol;</kbd> unselects all items.

The focused item is controlled by the navigation keys below, combined with the <kbd>Ctrl</kbd> modifier to prevent moving the selection, and the <kbd>Shift</kbd> modifier to extend the current selection.

  • <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd> move the focus on the next item in the designed direction.
  • <kbd>Home</kbd> and <kbd>End</kbd> focus the first or last item.
  • <kbd>PgUp</kbd> and <kbd>PgDn</kbd> move the focus one page up or down.

List item widgets support the following keyboard shortcuts:

  • <kbd>Enter</kbd> activates the item.
  • <kbd>␣</kbd> selects the item, with the same <kbd>Ctrl</kbd> and <kbd>Shift</kbd> modifiers combinations as the navigation keys.

Actions

GtkListBase defines a set of built-in actions:

  • list.scroll-to-item moves the visible area to the item at given position with the minimum amount of scrolling required. If the item is already visible, nothing happens.
  • list.select-item changes the selection.
  • list.select-all selects all items in the model, if the selection model supports it.
  • list.unselect-all unselects all items in the model, if the selection model supports it.

List item widgets install the following actions:

  • listitem.select changes selection if the item is selectable.
  • listitem.scroll-to moves the visible area of the list to this item with the minimum amount of scrolling required.
Synopsis

Exported types

newtype ListBase Source #

Memory-managed wrapper type.

Constructors

ListBase (ManagedPtr ListBase) 

Instances

Instances details
Eq ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

Methods

(==) :: ListBase -> ListBase -> Bool #

(/=) :: ListBase -> ListBase -> Bool #

GObject ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

ManagedPtrNewtype ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

Methods

toManagedPtr :: ListBase -> ManagedPtr ListBase #

TypedObject ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

Methods

glibType :: IO GType #

HasParentTypes ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

IsGValue (Maybe ListBase) Source #

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

Instance details

Defined in GI.Gtk.Objects.ListBase

Methods

gvalueGType_ :: IO GType #

gvalueSet_ :: Ptr GValue -> Maybe ListBase -> IO () #

gvalueGet_ :: Ptr GValue -> IO (Maybe ListBase) #

type ParentTypes ListBase Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

type ParentTypes ListBase = '[Widget, Object, Accessible, Buildable, ConstraintTarget, Orientable, Scrollable]

class (GObject o, IsDescendantOf ListBase o) => IsListBase o Source #

Type class for types which can be safely cast to ListBase, for instance with toListBase.

Instances

Instances details
(GObject o, IsDescendantOf ListBase o) => IsListBase o Source # 
Instance details

Defined in GI.Gtk.Objects.ListBase

toListBase :: (MonadIO m, IsListBase o) => o -> m ListBase Source #

Cast to ListBase, 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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBorder, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHscrollPolicy, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getVadjustment, getValign, getVexpand, getVexpandSet, getVisible, getVscrollPolicy, getWidth.

Setters

setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHexpand, setHexpandSet, setHscrollPolicy, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOrientation, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVscrollPolicy.

Properties

orientation

The orientation of the list. See GtkOrientable:orientation for details.

constructListBaseOrientation :: (IsListBase o, MonadIO m) => Orientation -> m (GValueConstruct o) Source #

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

getListBaseOrientation :: (MonadIO m, IsListBase o) => o -> m Orientation Source #

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

get listBase #orientation

setListBaseOrientation :: (MonadIO m, IsListBase o) => o -> Orientation -> m () Source #

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

set listBase [ #orientation := value ]