enlighten.ui.GuideFeature.GuideFeature Class Reference

Recommends "tips" that might be suggested to the user through the Marquee. More...

Public Member Functions
	__init__ (self, ctl)
	clear (self, token=None)
	stop (self)
	suggest (self, msg, persist=False, period_sec=10, token=None, link=None)
	update_visibility (self)

Public Attributes
	bt_enable = cfu.pushButton_guide
	ctl = ctl
	current_tip = None
bool	enabled = True
	last_tipped = None
list	queue = []
	shown = set()
	timer = QtCore.QTimer()

Static Public Attributes
int	MIN_DISPLAY_SEC = 8
int	POLL_SEC = 3

Protected Attributes
	_enable_callback
	_tick

Private Member Functions
	_enable_callback (self)
	_reset_timer (self)
	_tick (self)

Detailed Description

Recommends "tips" that might be suggested to the user through the Marquee.

Constructor & Destructor Documentation

__init__()

enlighten.ui.GuideFeature.GuideFeature.__init__	(		self,
			ctl )

Member Function Documentation

_enable_callback()

enlighten.ui.GuideFeature.GuideFeature._enable_callback ( self )

private

_reset_timer()

enlighten.ui.GuideFeature.GuideFeature._reset_timer ( self )

private

_tick()

enlighten.ui.GuideFeature.GuideFeature._tick ( self )

private

clear()

enlighten.ui.GuideFeature.GuideFeature.clear	(		self,
			token = None )

stop()

enlighten.ui.GuideFeature.GuideFeature.stop

(

self

)

suggest()

enlighten.ui.GuideFeature.GuideFeature.suggest	(		self,
			msg,
			persist = False,
			period_sec = 10,
			token = None,
			link = None )

update_visibility()

enlighten.ui.GuideFeature.GuideFeature.update_visibility

(

self

)

Member Data Documentation

_enable_callback

enlighten.ui.GuideFeature.GuideFeature._enable_callback

protected

_tick

enlighten.ui.GuideFeature.GuideFeature._tick

protected

bt_enable

enlighten.ui.GuideFeature.GuideFeature.bt_enable = cfu.pushButton_guide

ctl

enlighten.ui.GuideFeature.GuideFeature.ctl = ctl

current_tip

enlighten.ui.GuideFeature.GuideFeature.current_tip = None

enabled

enlighten.ui.GuideFeature.GuideFeature.enabled = True

last_tipped

enlighten.ui.GuideFeature.GuideFeature.last_tipped = None

MIN_DISPLAY_SEC

enlighten.ui.GuideFeature.GuideFeature.MIN_DISPLAY_SEC = 8

static

POLL_SEC

int enlighten.ui.GuideFeature.GuideFeature.POLL_SEC = 3

static

queue

enlighten.ui.GuideFeature.GuideFeature.queue = []

shown

enlighten.ui.GuideFeature.GuideFeature.shown = set()

timer

enlighten.ui.GuideFeature.GuideFeature.timer = QtCore.QTimer()

---

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

• enlighten/ui/GuideFeature.py