notifications

package

v0.17.2 Latest Latest Go to latest Published: Feb 26, 2024 License: GPL-3.0 Imports: 3 Imported by: 10

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/libretro/ludo

Links

Open Source Insights

Documentation ¶

Overview ¶

Package notifications exposes functions to display messages in toast widgets.

Index ¶

Constants
func Clear()
func Process(dt float32)
type Notification
- func (n *Notification) Update(severity Severity, message string, vars ...interface{})
type Severity

Constants ¶

View Source

const Medium float32 = 4

Medium is the standard duration for a notification

Variables ¶

This section is empty.

Functions ¶

func Clear ¶

func Clear()

Clear empties the notification list

func Process ¶

func Process(dt float32)

Process iterates over the notifications, update them, delete the old ones.

Types ¶

type Notification ¶

type Notification struct {
	Severity Severity
	Message  string
	Duration float32
}

Notification is a message that will be displayed on the screen during a certain time.

func Display ¶

func Display(severity Severity, message string, duration float32) *Notification

Display creates a new notification.

func DisplayAndLog ¶

func DisplayAndLog(severity Severity, prefix, message string, vars ...interface{}) *Notification

DisplayAndLog creates a new notification and also logs the message to stdout.

func List ¶

func List() []*Notification

List lists the current notifications.

func (*Notification) Update ¶ added in v0.9.9

func (n *Notification) Update(severity Severity, message string, vars ...interface{})

Update the message of a given notification. Also resets the delay before disapearing.

type Severity ¶ added in v0.2.8

type Severity uint8

Severity represents the severity of a notification message. It will affect the color of the notification text in the UI.

const (
	// Info is for informative message, when everything is fine
	Info Severity = iota
	// Success is for successful actions
	Success
	// Warning is also for informative messages, when something is not right
	// for example, if a menu entry has not been implemented.
	Warning
	// Error is for failed actions. For example, trying to load a game that
	// doesn't exists.
	Error
)

Source Files ¶

View all Source files

notifications.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL