dbus

Documentation

Overview

Package dbus provides access to DBUS APIs.

Index

• type Brightness
• type Client
  • func New(cfg *configv1.Config_DBUS, logger hclog.Logger) (*Client, <-chan *eventv1.Event, error)
  • func (c *Client) Brightness() Brightness
  • func (c *Client) Close() error
  • func (c *Client) Events() <-chan *eventv1.Event
  • func (c *Client) Notification() Notification
  • func (c *Client) Systray() Systray
• type Notification
• type NotificationHintKey
• type Systray

Types

type Brightness

type Brightness interface {
	Adjust(devName string, direction eventv1.Direction) error
}

Brightness DBUS API, may return nil if Brightness is disabled.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for DBUS.

func New

func New(cfg *configv1.Config_DBUS, logger hclog.Logger) (*Client, <-chan *eventv1.Event, error)

New instantiates a new DBUS client.

func (*Client) Brightness

func (c *Client) Brightness() Brightness

Brightness API.

func (*Client) Close

func (c *Client) Close() error

Close the client.

func (*Client) Events

func (c *Client) Events() <-chan *eventv1.Event

Events channel will deliver events from DBUS.

func (*Client) Notification

func (c *Client) Notification() Notification

Notification API.

func (*Client) Systray

func (c *Client) Systray() Systray

Systray API.

type Notification

type Notification interface {
	Closed(id uint32, reason hyprpanelv1.NotificationClosedReason) error
	Action(id uint32, actionKey string) error
}

Notification DBUS API, may return nil if Notifications are disabled.

type NotificationHintKey

type NotificationHintKey string

NotificationHintKey enum

const (

	// NotificationHintKeyActionIcons BOOLEAN	When set, a server that has the "action-icons" capability will attempt to interpret any action identifier as a named icon. The localized display name will be used to annotate the icon for accessibility purposes. The icon name should be compliant with the Freedesktop.org Icon Naming Specification.	>= 1.2
	NotificationHintKeyActionIcons NotificationHintKey = "action-icons"
	// NotificationHintKeyCategory STRING	The type of notification this is.
	NotificationHintKeyCategory NotificationHintKey = "category"
	// NotificationHintKeyDesktopEntry STRING	This specifies the name of the desktop filename representing the calling program. This should be the same as the prefix used for the application's .desktop file. An example would be "rhythmbox" from "rhythmbox.desktop". This can be used by the daemon to retrieve the correct icon for the application, for logging purposes, etc.
	NotificationHintKeyDesktopEntry NotificationHintKey = "desktop-entry"
	// NotificationHintKeyImageData (iiibiiay)	This is a raw data image format which describes the width, height, rowstride, has alpha, bits per sample, channels and image data respectively.	>= 1.2
	NotificationHintKeyImageData NotificationHintKey = "image-data"
	// NotificationHintKeyImageDataAlt (iiibiiay)	Deprecated. Use image-data instead.	= 1.1
	NotificationHintKeyImageDataAlt NotificationHintKey = "image_data"
	// NotificationHintKeyImagePath STRING	Alternative way to define the notification image. See Icons and Images.	>= 1.2
	NotificationHintKeyImagePath NotificationHintKey = "image-path"
	// NotificationHintKeyImagePathAlt STRING	Deprecated. Use image-path instead.	= 1.1
	NotificationHintKeyImagePathAlt NotificationHintKey = "image_path"
	// NotificationHintKeyIconDataAlt (iiibiiay)	Deprecated. Use image-data instead.	< 1.1
	NotificationHintKeyIconDataAlt NotificationHintKey = "icon_data"
	// NotificationHintKeyResident BOOLEAN	When set the server will not automatically remove the notification when an action has been invoked. The notification will remain resident in the server until it is explicitly removed by the user or by the sender. This hint is likely only useful when the server has the "persistence" capability.	>= 1.2
	NotificationHintKeyResident NotificationHintKey = "resident"
	// NotificationHintKeySoundFile STRING	The path to a sound file to play when the notification pops up.
	NotificationHintKeySoundFile NotificationHintKey = "sound-file"
	// NotificationHintKeySoundName STRING	A themeable named sound from the freedesktop.org sound naming specification to play when the notification pops up. Similar to icon-name, only for sounds. An example would be "message-new-instant".
	NotificationHintKeySoundName NotificationHintKey = "sound-name"
	// NotificationHintKeySuppressSound BOOLEAN	Causes the server to suppress playing any sounds, if it has that ability. This is usually set when the client itself is going to play its own sound.
	NotificationHintKeySuppressSound NotificationHintKey = "suppress-sound"
	// NotificationHintKeyTransient BOOLEAN	When set the server will treat the notification as transient and by-pass the server's persistence capability, if it should exist.	>= 1.2
	NotificationHintKeyTransient NotificationHintKey = "transient"
	// NotificationHintKeyX INT32	Specifies the X location on the screen that the notification should point to. The "y" hint must also be specified.
	NotificationHintKeyX NotificationHintKey = "x"
	// NotificationHintKeyY INT32	Specifies the Y location on the screen that the notification should point to. The "x" hint must also be specified.
	NotificationHintKeyY NotificationHintKey = "y"
	// NotificationHintKeyUrgency BYTE|UINT32	The urgency level.
	NotificationHintKeyUrgency NotificationHintKey = "urgency"
	// NotificationHintKeySenderPid NON-STANDARD INT64	process id of the sender
	NotificationHintKeySenderPid NotificationHintKey = "sender-pid"
)

type Systray

type Systray interface {
	Activate(busName string, x, y int32) error
	SecondaryActivate(busName string, x, y int32) error
	Scroll(busName string, delta int32, orientation hyprpanelv1.SystrayScrollOrientation) error
	MenuContextActivate(busName string, x, y int32) error
	MenuAboutToShow(busName string, menuItemID string) error
	MenuEvent(busName string, id int32, eventID hyprpanelv1.SystrayMenuEvent, data any, timestamp time.Time) error
}

Systray DBUS API, may return nil if Systray is disabled.