| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Interfaces.Root
Description
Root is the interface implemented by all widgets that can act as a toplevel
widget to a hierarchy of widgets. The root widget takes care of providing the
connection to the windowing system and manages layout, drawing and event delivery
for its widget hierarchy.
Synopsis
- newtype Root = Root (ManagedPtr Root)
- class (GObject o, IsDescendantOf Root o) => IsRoot o
- toRoot :: (MonadIO m, IsRoot o) => o -> m Root
- rootGetDisplay :: (HasCallStack, MonadIO m, IsRoot a) => a -> m Display
- rootGetFocus :: (HasCallStack, MonadIO m, IsRoot a) => a -> m (Maybe Widget)
- rootSetFocus :: (HasCallStack, MonadIO m, IsRoot a, IsWidget b) => a -> Maybe b -> m ()
Exported types
Memory-managed wrapper type.
Instances
| Eq Root Source # | |
| GObject Root Source # | |
Defined in GI.Gtk.Interfaces.Root | |
| ManagedPtrNewtype Root Source # | |
Defined in GI.Gtk.Interfaces.Root Methods toManagedPtr :: Root -> ManagedPtr Root | |
| TypedObject Root Source # | |
Defined in GI.Gtk.Interfaces.Root | |
| HasParentTypes Root Source # | |
Defined in GI.Gtk.Interfaces.Root | |
| IsGValue (Maybe Root) Source # | Convert |
Defined in GI.Gtk.Interfaces.Root Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Root -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Root) | |
| type ParentTypes Root Source # | |
Defined in GI.Gtk.Interfaces.Root | |
class (GObject o, IsDescendantOf Root o) => IsRoot o Source #
Instances
| (GObject o, IsDescendantOf Root o) => IsRoot o Source # | |
Defined in GI.Gtk.Interfaces.Root | |
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, 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, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRenderer, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getSurface, getSurfaceTransform, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocus, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.
getDisplay
Arguments
| :: (HasCallStack, MonadIO m, IsRoot a) | |
| => a |
|
| -> m Display | Returns: the display of |
Returns the display that this GtkRoot is on.
getFocus
Arguments
| :: (HasCallStack, MonadIO m, IsRoot a) | |
| => a |
|
| -> m (Maybe Widget) | Returns: the currently focused widget,
or |
Retrieves the current focused widget within the root.
Note that this is the widget that would have the focus
if the root is active; if the root is not focused then
gtk_widget_has_focus (widget) will be False for the
widget.
setFocus
Arguments
| :: (HasCallStack, MonadIO m, IsRoot a, IsWidget b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
If focus is not the current focus widget, and is focusable, sets
it as the focus widget for the root. If focus is Nothing, unsets
the focus widget for the root.
To set the focus to a particular widget in the root, it is usually
more convenient to use widgetGrabFocus instead of this function.