GI.Dazzle.Interfaces.DockItem

No description available in the introspection data.

Exported types

newtype DockItem

Memory-managed wrapper type.

Constructors

DockItem (ManagedPtr DockItem)

Instances

Eq DockItem

Defined in GI.Dazzle.Interfaces.DockItem

Methods

(==) :: DockItem -> DockItem -> Bool

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

GObject DockItem

Defined in GI.Dazzle.Interfaces.DockItem

ManagedPtrNewtype DockItem

Defined in GI.Dazzle.Interfaces.DockItem

Methods

toManagedPtr :: DockItem -> ManagedPtr DockItem

TypedObject DockItem

Defined in GI.Dazzle.Interfaces.DockItem

Methods

glibType :: IO GType

HasParentTypes DockItem

Defined in GI.Dazzle.Interfaces.DockItem

IsGValue (Maybe DockItem)

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

Defined in GI.Dazzle.Interfaces.DockItem

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes DockItem

Defined in GI.Dazzle.Interfaces.DockItem

type ParentTypes DockItem = '[Object, Widget]

class (GObject o, IsDescendantOf DockItem o) => IsDockItem o

Type class for types which can be safely cast to DockItem, for instance with toDockItem.

Instances

(GObject o, IsDescendantOf DockItem o) => IsDockItem o

Defined in GI.Dazzle.Interfaces.DockItem

toDockItem :: (MonadIO m, IsDockItem o) => o -> m DockItem

Cast to DockItem, 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, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, adopt, bindProperty, bindPropertyFull, canActivateAccel, childFocus, childNotify, classPath, close, 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, emitPresented, ensureStyle, errorBell, event, forceFloating, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hasWidgets, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, minimize, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, needsAttention, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, present, presentChild, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refGicon, refSink, regionIntersect, registerWindow, release, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetStateFlags, updateVisibility, watchClosure.

Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getCanClose, getCanDefault, getCanFocus, getCanMinimize, getChildRequisition, getChildVisible, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getIconName, getInternalChild, getManager, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setAllocation, setAppPaintable, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setManager, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReceivesDefault, setRedrawOnAllocate, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

adopt

dockItemAdopt :: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b) => a -> b -> m Bool

No description available in the introspection data.

close

dockItemClose

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m Bool

Returns: True if the dock item was closed

This function will request that the dock item close itself.

emitPresented

dockItemEmitPresented

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m ()

Emits the DockItem::presented signal.

Containers should emit this when their descendant has been presented as the current visible child. This allows dock items to do lazy initialization of content once the widgetry is visible to the user.

Currently, this is best effort, as there are a number of situations that make covering all cases problematic.

Since: 3.30

getCanClose

dockItemGetCanClose

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m Bool

Returns: True if the dock item can be closed by the user, otherwise False.

If this dock item can be closed by the user, this virtual function should be implemented by the panel and return True.

getCanMinimize

dockItemGetCanMinimize

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m Bool

Returns: True if the widget can be minimized.

No description available in the introspection data.

getChildVisible

dockItemGetChildVisible :: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b) => a -> b -> m Bool

No description available in the introspection data.

getIconName

dockItemGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: A DockItem

-> m (Maybe Text)

Returns: A newly allocated string or Nothing.

Gets the icon_name for the DockItem.

Generally, you want to use a DockWidget which has a "icon-name" property you can set. But this can be helpful for integration of various container widgets.

getManager

dockItemGetManager

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: A DockItem

-> m (Maybe DockManager)

Returns: A DzlDockmanager.

Gets the dock manager for this dock item.

getParent

dockItemGetParent

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

-> m (Maybe DockItem)

Returns: A DockItem or Nothing.

Gets the parent DockItem, or Nothing.

getTitle

dockItemGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: A DockItem

-> m (Maybe Text)

Returns: A newly allocated string or Nothing.

Gets the title for the DockItem.

Generally, you want to use a DockWidget which has a "title" property you can set. But this can be helpful for integration of various container widgets.

hasWidgets

dockItemHasWidgets :: (HasCallStack, MonadIO m, IsDockItem a) => a -> m Bool

No description available in the introspection data.

minimize

dockItemMinimize

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b)

=> a

self: a DockItem

-> b

child: A DockItem that is a child of self

-> PositionType

position: A location for a PositionType

-> m (Bool, PositionType)

Returns: True if child was minimized. Otherwise False and position may be updated to a suggested position.

This requests that self minimize child if it knows how.

If not, it should suggest the gravity for child if it knows how to determine that. For example, a DockBin might know if the widget was part of the right panel and therefore may set position to PositionTypeRight.

needsAttention

dockItemNeedsAttention

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m ()

Emits the "needs-attention" signal.

Since: 3.34

present

dockItemPresent

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: A DockItem

-> m ()

This widget will walk the widget hierarchy to ensure that the dock item is visible to the user.

presentChild

dockItemPresentChild :: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b) => a -> b -> m ()

No description available in the introspection data.

refGicon

dockItemRefGicon

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a)

=> a

self: a DockItem

-> m (Maybe Icon)

Returns: a Icon or Nothing

Gets a Icon for the dock item, if any has been set.

If an icon-name has been set, a new Icon for that icon-name may be returned.

Since: 3.34

release

dockItemRelease

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b)

=> a

self: A DockItem

-> b

-> m ()

This virtual method should remove child from self if the dock item knows how to do so. For example, the DockStack will remove child from it's internal Stack.

After the virtual function has been executed, child tracking will be removed so that DockItem implementations do not need to implement themselves.

setChildVisible

dockItemSetChildVisible :: (HasCallStack, MonadIO m, IsDockItem a, IsDockItem b) => a -> b -> Bool -> m ()

No description available in the introspection data.

setManager

dockItemSetManager

Arguments

:: (HasCallStack, MonadIO m, IsDockItem a, IsDockManager b)

=> a

self: A DockItem

-> Maybe b

manager: A DockManager

-> m ()

Sets the dock manager for this DockItem.

updateVisibility

dockItemUpdateVisibility :: (HasCallStack, MonadIO m, IsDockItem a) => a -> m ()

No description available in the introspection data.

Signals

managerSet

type DockItemManagerSetCallback = DockManager -> IO ()

No description available in the introspection data.

afterDockItemManagerSet :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemManagerSetCallback) -> m SignalHandlerId

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

after dockItem #managerSet 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.

onDockItemManagerSet :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemManagerSetCallback) -> m SignalHandlerId

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

on dockItem #managerSet callback

needsAttention

type DockItemNeedsAttentionCallback = IO ()

No description available in the introspection data.

afterDockItemNeedsAttention :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemNeedsAttentionCallback) -> m SignalHandlerId

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

after dockItem #needsAttention 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.

onDockItemNeedsAttention :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemNeedsAttentionCallback) -> m SignalHandlerId

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

on dockItem #needsAttention callback

presented

type DockItemPresentedCallback = IO ()

No description available in the introspection data.

afterDockItemPresented :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemPresentedCallback) -> m SignalHandlerId

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

after dockItem #presented 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.

onDockItemPresented :: (IsDockItem a, MonadIO m) => a -> ((?self :: a) => DockItemPresentedCallback) -> m SignalHandlerId

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

on dockItem #presented callback