enlighten.ui.Marquee.Message Class Reference

Public Member Functions
	__init__ (self, msg, persist=False, token=None, benign=None, immediate=False, extra_ms=0, period_sec=None, link=None)
	__repr__ (self)
	is_error (self)

Public Attributes
bool	benign = benign
	extra_ms = extra_ms
	immediate = immediate
	link = link
	msg = msg
	period_sec = period_sec
	persist = persist
	token = token

Constructor & Destructor Documentation

__init__()

enlighten.ui.Marquee.Message.__init__	(		self,
			msg,
			persist = False,
			token = None,
			benign = None,
			immediate = False,
			extra_ms = 0,
			period_sec = None,
			link = None )

Parameters

persist	leave message on-screen until explicitly cleared or replaced
token	allows "message types / sources" to be associated, for instance so the message "Tip: enable baseline correction" with token "enable_baseline_correction" allows different objects to cancel (close) open messages tagged "enable_baseline_correction" when that condition has been satisfied, IF the currently-displayed message has that tag

Member Function Documentation

__repr__()

enlighten.ui.Marquee.Message.__repr__

(

self

)

is_error()

enlighten.ui.Marquee.Message.is_error

(

self

)

Member Data Documentation

benign

bool enlighten.ui.Marquee.Message.benign = benign

extra_ms

enlighten.ui.Marquee.Message.extra_ms = extra_ms

immediate

enlighten.ui.Marquee.Message.immediate = immediate

link

enlighten.ui.Marquee.Message.link = link

msg

enlighten.ui.Marquee.Message.msg = msg

period_sec

enlighten.ui.Marquee.Message.period_sec = period_sec

persist

enlighten.ui.Marquee.Message.persist = persist

token

enlighten.ui.Marquee.Message.token = token

---

The documentation for this class was generated from the following file:

• enlighten/ui/Marquee.py