gi-dbusmenugtk3-0.4.16: DbusmenuGtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.DbusmenuGtk3.Objects.Menu

Contents

- Exported types
- Methods
  - getClient
  - new
- Properties
  - dbusName
  - dbusObject

Description

A `Menu` that is built using an abstract tree built from a `Client`.

Synopsis

- newtype Menu = Menu (ManagedPtr Menu)
- class (GObject o, IsDescendantOf Menu o) => IsMenu o
- toMenu :: (MonadIO m, IsMenu o) => o -> m Menu
- menuGetClient :: (HasCallStack, MonadIO m, IsMenu a) => a -> m Client
- menuNew :: (HasCallStack, MonadIO m) => Text -> Text -> m Menu
- constructMenuDbusName :: (IsMenu o, MonadIO m) => Text -> m (GValueConstruct o)
- getMenuDbusName :: (MonadIO m, IsMenu o) => o -> m (Maybe Text)
- constructMenuDbusObject :: (IsMenu o, MonadIO m) => Text -> m (GValueConstruct o)
- getMenuDbusObject :: (MonadIO m, IsMenu o) => o -> m (Maybe Text)

# Exported types

newtype Menu Source #

Memory-managed wrapper type.

Constructors

Menu (ManagedPtr Menu) |

#### Instances

Instances details

Eq Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods (==) :: Menu -> Menu -> Bool Source # (/=) :: Menu -> Menu -> Bool Source #
GObject Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu
ManagedPtrNewtype Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods toManagedPtr :: Menu -> ManagedPtr Menu Source #
TypedObject Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods glibType :: IO GType Source #
HasParentTypes Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu
IsGValue (Maybe Menu) Source # | Convert `Menu` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe Menu -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe Menu) Source #
type ParentTypes Menu Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu type ParentTypes Menu = '[Menu, MenuShell, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf Menu o) => IsMenu o Source #

Type class for types which can be safely cast to `Menu`, for instance with `toMenu`.

#### Instances

Instances details

(GObject o, IsDescendantOf Menu o) => IsMenu o Source # |
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu

toMenu :: (MonadIO m, IsMenu o) => o -> m Menu Source #

Cast to `Menu`, 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, activateItem, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, append, attach, attachToWidget, bindModel, bindProperty, bindPropertyFull, canActivateAccel, cancel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, deactivate, deselect, destroy, destroyed, detach, 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, insert, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, 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, placeOnMonitor, popdown, popup, popupAtPointer, popupAtRect, popupAtWidget, popupForDevice, prepend, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChild, reparent, reposition, resetRcStyles, resetStyle, resizeChildren, runDispose, selectFirst, selectItem, 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

getAccelGroup, getAccelPath, getAccessible, getActionGroup, getActive, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getAttachWidget, getBorderWidth, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getChildren, getClient, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getMonitor, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentShell, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getReserveToggleSize, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSelectedItem, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTakeFocus, getTearoffState, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelGroup, setAccelPath, setActive, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMonitor, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setReserveToggleSize, setResizeMode, setScreen, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTakeFocus, setTearoffState, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## getClient

menuGetClient Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenu a) |
=> a | `menu`: The `Menu` to get the client from
-> m Client | Returns: A valid `Client` or NULL on error.

An accessor for the client that this menu is using to communicate with the server.

## new

menuNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> Text | `dbusName`: Name of the `Server` on DBus
-> Text | `dbusObject`: Name of the object on the `Server`
-> m Menu | Returns: A new `Menu` sync'd with a server

Creates a new `Menu` object and creates a `Client` that connects across DBus to a `Server`.

# Properties

## dbusName

No description available in the introspection data.

constructMenuDbusName :: (IsMenu o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getMenuDbusName :: (MonadIO m, IsMenu o) => o -> m (Maybe Text) Source #

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

    get menu #dbusName

## dbusObject

No description available in the introspection data.

constructMenuDbusObject :: (IsMenu o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getMenuDbusObject :: (MonadIO m, IsMenu o) => o -> m (Maybe Text) Source #

Get the value of the “`dbus-object`” property. When overloading is enabled, this is equivalent to

    get menu #dbusObject