Vega strike Python Modules doc: GUIRoom Class Reference

All Data Structures Namespaces Files Functions Variables

Inheritance diagram for GUIRoom:

Public Member Functions
def	__init__

def	__repr__

def	__str__

def	getIndex

def	redrawIfNeeded

def	redraw

def	notifyNeedRedraw

def	getScreenDimensions

def	getScreenMargins

def	setScreenDimensions

def	setScreenMargins

Data Fields
	index

	needRedraw

	needPreserveZ

	screenDimensions

	screenMargins

Detailed Description

Definition at line 640 of file GUI.py.

Constructor & Destructor Documentation

def __init__	(	self,
		index
	)

Definition at line 641 of file GUI.py.

 
     def __init__(self,index):
         self.index = index
         self.needRedraw = 0
         self.needPreserveZ = 0
         self.screenDimensions = None
         self.screenMargins = None
         # add this GUIRoom to GUIRootSingleton
         GUIRootSingleton.registerRoom(self)

Member Function Documentation

def __repr__ ( self)

Definition at line 650 of file GUI.py.

References Tokenizer.index, ListReader.index, and GUIRoom.index.

 
     def __repr__(self):
         return "<room %r>" % self.index

def __str__ ( self)

Definition at line 653 of file GUI.py.

References Tokenizer.index, ListReader.index, and GUIRoom.index.

 
     def __str__(self):
         return "Room %s" % self.index

def getIndex ( self)

Definition at line 656 of file GUI.py.

References Tokenizer.index, ListReader.index, and GUIRoom.index.

 
     def getIndex(self):
         return self.index

def getScreenDimensions ( self)

Definition at line 678 of file GUI.py.

References GUIRoom.screenDimensions.

 
     def getScreenDimensions(self):
         global GUIRootSingleton
         if self.screenDimensions:
             return self.screenDimensions
         else:
             return GUIRootSingleton.getScreenDimensions()

def getScreenMargins ( self)

Definition at line 685 of file GUI.py.

References GUIRoom.screenDimensions, and GUIRoom.screenMargins.

 
     def getScreenMargins(self):
         global GUIRootSingleton
         if self.screenDimensions:
             return self.screenMargins
         else:
             return GUIRootSingleton.getScreenMargins()

def notifyNeedRedraw	(	self,
		preserveZ = `1`
	)

Definition at line 673 of file GUI.py.

References GUIRoom.needPreserveZ, GUIRoot.needRedraw, and GUIRoom.needRedraw.

 
     def notifyNeedRedraw(self,preserveZ=1):
         self.needRedraw = 1
         if preserveZ != 0:
             self.needPreserveZ = 1

def redraw ( self)

Definition at line 663 of file GUI.py.

References GUIRoom.getIndex(), GUIRoom.needPreserveZ, GUIRoot.needRedraw, and GUIRoom.needRedraw.

 
     def redraw(self):
         if self.needPreserveZ != 0:
             """ Sadly, this mess is required to preserve z-order - some day we'll have a proper redraw in place """
             GUIRootSingleton.broadcastRoomMessage(self.getIndex(),'undraw',None)
             GUIRootSingleton.broadcastRoomMessage(self.getIndex(),'draw',None)
         else:
             GUIRootSingleton.broadcastRoomMessage(self.getIndex(),'redraw',None)
         self.needRedraw = 0
         self.needPreserveZ = 0

def redrawIfNeeded ( self)

Definition at line 659 of file GUI.py.

References GUIRoot.needRedraw, GUIRoom.needRedraw, and GUIRoom.redraw().

 
     def redrawIfNeeded(self):
         if self.needRedraw != 0:
             self.redraw()

def setScreenDimensions	(	self,
		dimensions
	)

Definition at line 692 of file GUI.py.

References GUIRoot.getScreenDimensions(), GUIRoom.getScreenDimensions(), Tokenizer.index, ListReader.index, GUIRoom.index, and GUIRoom.screenDimensions.

 
     def setScreenDimensions(self,dimensions):
         global GUIRootSingleton
         self.screenDimensions = dimensions
         dims = self.getScreenDimensions()
         GUIRootSingleton.broadcastRoomMessage(self.index,'changedScreenDimensions', {'screenX':dims[0],'screenY':dims[1]} )

def setScreenMargins	(	self,
		margins
	)

Definition at line 698 of file GUI.py.

References GUIRoot.getScreenMargins(), GUIRoom.getScreenMargins(), Tokenizer.index, ListReader.index, GUIRoom.index, and GUIRoom.screenMargins.

 
     def setScreenMargins(self,margins):
         global GUIRootSingleton
         self.screenMargins = margins
         mars = self.getScreenMargins()
         GUIRootSingleton.broadcastMessage(self.index,'changedScreenMargins', {'marginX':mars[0],'marginY':mars[1]} )
 
 
 """----------------------------------------------------------------"""
 """                                                                """
 """ GUIElement - it's the base class for all GUI elements          """
 """     Implements standard methods and message handling           """
 """                                                                """
 """----------------------------------------------------------------"""
 

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation