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

GI.DbusmenuGtk3.Objects.Menu

Contents

Exported types
Methods
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
noMenu :: Maybe Menu
menuGetClient :: (HasCallStack, MonadIO m, IsMenu a) => a -> m Client
menuNew :: (HasCallStack, MonadIO m) => Text -> Text -> m Menu
constructMenuDbusName :: IsMenu o => Text -> IO (GValueConstruct o)
getMenuDbusName :: (MonadIO m, IsMenu o) => o -> m (Maybe Text)
constructMenuDbusObject :: IsMenu o => Text -> IO (GValueConstruct o)
getMenuDbusObject :: (MonadIO m, IsMenu o) => o -> m (Maybe Text)

Exported types

newtype Menu Source #

Memory-managed wrapper type.

Constructors

(ManagedPtr Menu)

Instances

Instances details

Eq Menu Source #
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods (==) :: Menu -> Menu -> Bool # (/=) :: Menu -> Menu -> Bool #
IsGValue Menu Source #	Convert `Menu` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods toGValue :: Menu -> IO GValue # fromGValue :: GValue -> IO Menu #
GObject Menu Source #
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu Methods gobjectType :: IO GType #
HasParentTypes Menu Source #
Instance details Defined in GI.DbusmenuGtk3.Objects.Menu
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.

noMenu :: Maybe Menu Source #

A convenience alias for Nothing :: Maybe Menu.

Methods

Overloaded methods

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 => Text -> IO (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 => Text -> IO (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