DirectWaitBar Class Reference

Inheritance diagram for DirectWaitBar:

Public Member Functions
	__init__ (self, parent=None, **kw)
	destroy (self)
	finish (self, N=10)
	getPercent (self)
	setBarBorderWidth (self)
	setBarColor (self)
	setBarRelief (self)
	setBarTexture (self)
	setRange (self)
	setValue (self)
	update (self, value)
	updateBarStyle (self)
Public Member Functions inherited from DirectFrame
	__init__ (self, parent=None, **kw)
	clearGeom (self)
	clearImage (self)
	clearText (self)
	setGeom (self, geom=None)
	setImage (self, image=None)
	setText (self, text=None)
Public Member Functions inherited from DirectGuiWidget
	__init__ (self, parent=None, **kw)
	copyOptions (self, other)
	disableEdit (self)
	editStart (self, event)
	editStop (self, event)
	enableEdit (self)
	frameInitialiseFunc (self)
	getBounds (self, state=0)
	getCenter (self)
	getFrameType (self, state=0)
	getHeight (self)
	getWidth (self)
	guiDragTask (self, state)
	guiScaleTask (self, state)
	printConfig (self, indent=0)
	resetFrameSize (self)
	setBorderUvWidth (self)
	setBorderWidth (self)
	setFrameColor (self)
	setFrameSize (self, fClearFrame=0)
	setFrameTexture (self)
	setFrameVisibleScale (self)
	setProp (self, propString, value)
	setRelief (self, fSetStyle=1)
	setState (self)
	taskName (self, idString)
	uniqueName (self, idString)
	updateFrameStyle (self)
Public Member Functions inherited from DirectGuiBase
	__init__ (self)
	__setitem__ (self, key, value)
	addoptions (self, optionDefs, optionkeywords)
	bind (self, event, command, extraArgs=[])
	cget (self, option)
	component (self, name)
	components (self)
	configure (self, option=None, **kw)
	createcomponent (self, componentName, componentAliases, componentGroup, widgetClass, *widgetArgs, **kw)
	defineoptions (self, keywords, optionDefs, dynamicGroups=())
	destroycomponent (self, name)
	hascomponent (self, component)
	initialiseoptions (self, myClass)
	isinitoption (self, option)
	options (self)
	postInitialiseFunc (self)
	unbind (self, event)
Public Member Functions inherited from DirectObject
	__init__ (self)
	accept (self, event, method, extraArgs=[])
	acceptOnce (self, event, method, extraArgs=[])
	addTask (self, *args, **kwargs)
	detectLeaks (self)
	doMethodLater (self, *args, **kwargs)
	getAllAccepting (self)
	ignore (self, event)
	ignoreAll (self)
	isAccepting (self, event)
	isIgnoring (self, event)
	removeAllTasks (self)
	removeTask (self, taskOrName)

Public Attributes
	barStyle = PGFrameStyle()
Public Attributes inherited from DirectGuiWidget
list	bounds = self['frameSize']
	editStart
	editStop
	ll
	printConfig
	stateNodePath = self.guiDict.get(parts[-1])
	ur
Public Attributes inherited from DirectGuiBase
int	fInit = 1
str	guiId = 'guiObject'
list	postInitialiseFuncList = []

Additional Inherited Members
Static Public Attributes inherited from DirectFrame
tuple	DefDynGroups = ('text', 'geom', 'image')
Static Public Attributes inherited from DirectGuiWidget
float	gridSpacing = 0.05
dict	guiDict = {}
	guiEdit = ShowBaseGlobal.config.GetBool('direct-gui-edit', False)
	inactiveInitState = DGG.NORMAL
int	snapToGrid = 0
Static Public Attributes inherited from DirectObject
	accept_once = acceptOnce
	add_task = addTask
	detect_leaks = detectLeaks
	do_method_later = doMethodLater
	get_all_accepting = getAllAccepting
	ignore_all = ignoreAll
	is_accepting = isAccepting
	is_ignoring = isIgnoring
	remove_all_tasks = removeAllTasks
	remove_task = removeTask
Protected Member Functions inherited from DirectObject
	_addTask (self, task)
	_clearTask (self, task)
Protected Attributes inherited from DirectGuiBase
dict	_constructorKeywords = tmp
tuple	_dynamicGroups = ()
dict	_optionInfo = {}
Protected Attributes inherited from DirectObject
dict	_taskList = {}

Detailed Description

 DirectWaitBar - A DirectWidget that shows progress completed
towards a task.  

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			parent = None,
		**	kw )

Member Function Documentation

destroy()

destroy

(

self

)

Reimplemented from DirectFrame.

Reimplemented in DWBPackageInstaller.

finish()

finish	(		self,
			N = 10 )

Fill the bar in N frames. This call is blocking.

getPercent()

getPercent

(

self

)

Returns the percentage complete.

setBarBorderWidth()

setBarBorderWidth

(

self

)

Updates the bar's border width, which you can set using bar['barBorderWidth'].

setBarColor()

setBarColor

(

self

)

Updates the bar color, which you can set using bar['barColor'].

setBarRelief()

setBarRelief

(

self

)

Updates the bar relief, which you can set using bar['barRelief'].

setBarTexture()

setBarTexture

(

self

)

Updates the bar texture, which you can set using bar['barTexture'].

setRange()

setRange

(

self

)

Updates the bar range which you can set using bar['range'].
This is the value at which the WaitBar indicates 100%.

setValue()

setValue

(

self

)

Updates the bar value which you can set using bar['value'].
The value should range between 0 and bar['range'].

update()

update	(		self,
			value )

Updates the bar with the given value and renders a frame.

updateBarStyle()

updateBarStyle

(

self

)

Member Data Documentation

barStyle

barStyle = PGFrameStyle()