gi-dbusmenugtk3-0.4.8: DbusmenuGtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.DbusmenuGtk3.Objects.Client

Description

A subclass of Client to add functionality with regarding building GTK items out of the abstract tree.

Synopsis

Exported types

newtype Client Source #

Memory-managed wrapper type.

Constructors

Client (ManagedPtr Client) 

Instances

Instances details
Eq Client Source # 
Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

Methods

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

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

IsGValue Client Source #

Convert Client to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

GObject Client Source # 
Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

Methods

gobjectType :: IO GType #

HasParentTypes Client Source # 
Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

type ParentTypes Client Source # 
Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

type ParentTypes Client = '[Client, Object]

class (GObject o, IsDescendantOf Client o) => IsClient o Source #

Type class for types which can be safely cast to Client, for instance with toClient.

Instances

Instances details
(GObject o, IsDescendantOf Client o) => IsClient o Source # 
Instance details

Defined in GI.DbusmenuGtk3.Objects.Client

toClient :: (MonadIO m, IsClient o) => o -> m Client Source #

Cast to Client, for types for which this is known to be safe. For general casts, use castTo.

noClient :: Maybe Client Source #

A convenience alias for Nothing :: Maybe Client.

Methods

Overloaded methods

getAccelGroup

clientGetAccelGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsClient a) 
=> a

client: Client to query for an accelerator group

-> m AccelGroup

Returns: Either a valid group or NULL on error or none set.

Gets the accel group for this client.

menuitemGet

clientMenuitemGet Source #

Arguments

:: (HasCallStack, MonadIO m, IsClient a, IsMenuitem b) 
=> a

client: A Client with the item in it.

-> b

item: Menuitem to get associated MenuItem on.

-> m MenuItem

Returns: The MenuItem that can be played with.

This grabs the MenuItem that is associated with the Menuitem.

menuitemGetSubmenu

clientMenuitemGetSubmenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsClient a, IsMenuitem b) 
=> a

client: A Client with the item in it.

-> b

item: Menuitem to get associated Menu on.

-> m Menu

Returns: The Menu if there is one.

This grabs the submenu associated with the menuitem.

new

clientNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

dbusName: Name of the Server on DBus

-> Text

dbusObject: Name of the object on the Server

-> m Client

Returns: A new Client sync'd with a server

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

newitemBase

clientNewitemBase Source #

Arguments

:: (HasCallStack, MonadIO m, IsClient a, IsMenuitem b, IsMenuItem c, IsMenuitem d) 
=> a

client: The client handling everything on this connection

-> b

item: The Menuitem to attach the GTK-isms to

-> c

gmi: A MenuItem representing the GTK world's view of this menuitem

-> d

parent: The parent Menuitem

-> m () 

This function provides some of the basic connectivity for being in the GTK world. Things like visibility and sensitivity of the item are handled here so that the subclasses don't have to. If you're building your on GTK menu item you can use this function to apply those basic attributes so that you don't have to deal with them either.

This also handles passing the "activate" signal back to the Menuitem side of thing.

setAccelGroup

clientSetAccelGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsClient a, IsAccelGroup b) 
=> a

client: To set the group on

-> b

agroup: The new acceleration group

-> m () 

Sets the acceleration group for the menu items with accelerators on this client.