Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
GUIElement Class Reference
Inheritance diagram for GUIElement:
GUIGroup GUIMouseOver GUISimpleListPicker GUIStaticImage GUIStaticText GUILineEdit GUITextInputDialog GUIButton GUIVideoStream GUIVideoTexture GUICheckButton GUICompButton GUIRoomButton GUIRadioButton

Public Member Functions

def __init__
 
def __str__
 
def __repr__
 
def show
 
def hide
 
def notifyNeedRedraw
 
def draw
 
def undraw
 
def redraw
 
def onMessage
 
def onClick
 
def onShow
 
def onHide
 
def onDraw
 
def onUndraw
 
def onRedraw
 
def focus
 
def setModal
 
def isInteractive
 

Data Fields

 room
 
 owner
 
 visible
 
 redrawPreservesZ
 
 id
 

Detailed Description

Definition at line 713 of file GUI.py.

Constructor & Destructor Documentation

def __init__ (   self,
  room,
  owner = None 
)

Definition at line 714 of file GUI.py.

714 
715  def __init__(self,room,owner=None):
716  self.room = room
717  self.owner = owner
718  self.visible = 1
719  self.redrawPreservesZ = 0
720  self.id = GUIRootSingleton.registerObject(room.getIndex(),self)

Member Function Documentation

def __repr__ (   self)

Definition at line 724 of file GUI.py.

References sre_parse.dir.

724 
725  def __repr__(self):
726  # this needs work
727  # would like it to say <GUI.GUIElementSubclass a = 1, b= 2, ...> for any subclass of GUIElement
728  r = "<%s: " %(type(self)) #, self.room, self.visible, self.redrawPreservesZ, self.id)
729  for key in dir(self):
730  try:
731  value = getattr(self, key)
732  if callable(value):
733  value = ''
734  except:
735  value = ''
736  if value != '':
737  r = r + "%s = %s, " %(key, value)
738  r = r + ">"
739  return r
def __str__ (   self)

Definition at line 721 of file GUI.py.

References DialogBox.Item.id, DialogBox.id, GUIElement.id, GUIElement.redrawPreservesZ, GUIElement.room, and GUIElement.visible.

721 
722  def __str__(self):
723  return "GUIElement: room = %s, visible = %s, redrawPreservesZ = %s, id = %s" %(self.room, self.visible, self.redrawPreservesZ, self.id)
def draw (   self) 
Intentionally blank

Definition at line 752 of file GUI.py.

752 
753  def draw(self):
754  """ Intentionally blank """
def focus (   self,
  dofocus 
)

Definition at line 805 of file GUI.py.

805 
806  def focus(self,dofocus):
807  if dofocus:
808  GUIRootSingleton.keyTarget=self
809  elif GUIRootSingleton.keyTarget==self:
810  GUIRootSingleton.keyTarget=None
def hide (   self) 
Usually does not need a full redraw

Definition at line 744 of file GUI.py.

References DialogBox.Item.undraw(), DialogBox.Row.undraw(), DialogBox.undraw(), GUIElement.undraw(), and GUIElement.visible.

744 
745  def hide(self):
746  """ Usually does not need a full redraw """
747  self.visible=0
748  self.undraw()
def isInteractive (   self)

Definition at line 822 of file GUI.py.

822 
823  def isInteractive(self):
824  return GUIRootSingleton.modalElement==self or GUIRootSingleton.modalElement==None
825 
826 
827 """----------------------------------------------------------------"""
828 """ """
829 """ GUIGroup - allows grouping of elements. Notice that GUIGroup """
830 """ will relay messages to its attached elements, and will """
831 """ keep them alive (by holding references to them) """
832 """ """
833 """----------------------------------------------------------------"""
834 
def notifyNeedRedraw (   self,
  preserveZ = 1 
)

Definition at line 749 of file GUI.py.

749 
750  def notifyNeedRedraw(self,preserveZ=1):
751  self.room.notifyNeedRedraw(preserveZ)
def onClick (   self,
  params 
) 
Intentionally blank

Definition at line 783 of file GUI.py.

783 
784  def onClick(self,params):
785  """ Intentionally blank """
def onDraw (   self,
  params 
)

Definition at line 792 of file GUI.py.

References DialogBox.Item.draw(), DialogBox.List.draw(), DialogBox.Row.draw(), DialogBox.draw(), GUIElement.draw(), and GUIElement.visible.

792 
793  def onDraw(self,params):
794  if self.visible:
795  self.draw()
def onHide (   self,
  params 
)

Definition at line 789 of file GUI.py.

References dircmp.hide, and GUIElement.hide().

789 
790  def onHide(self,params):
791  self.hide()
def onMessage (   self,
  message,
  params 
) 
Standard message dispatch

Definition at line 764 of file GUI.py.

References GUIElement.onClick(), GUIElement.onDraw(), GUIElement.onHide(), GUIElement.onRedraw(), GUIElement.onShow(), and GUIElement.onUndraw().

764 
765  def onMessage(self,message,params):
766  """Standard message dispatch"""
767  if (message=='click'):
768  self.onClick(params)
769  elif (message=='show'):
770  self.onShow(params)
771  elif (message=='hide'):
772  self.onHide(params)
773  elif (message=='draw'):
774  self.onDraw(params)
775  elif (message=='undraw'):
776  self.onUndraw(params)
777  elif (message=='redraw'):
778  self.onRedraw(params)
779  else:
780  return False
781  return True
782 
def onRedraw (   self,
  params 
) 
WARNING! does not necessarily preserve z-order, so only issue if you don't care about z-order

Definition at line 800 of file GUI.py.

References GUIRoom.redraw(), GUIElement.redraw(), and GUIElement.visible.

800 
801  def onRedraw(self,params):
802  """ WARNING! does not necessarily preserve z-order, so only issue if you don't care about z-order """
803  if self.visible:
804  self.redraw()
def onShow (   self,
  params 
)

Definition at line 786 of file GUI.py.

786 
787  def onShow(self,params):
788  self.show()
def onUndraw (   self,
  params 
)

Definition at line 796 of file GUI.py.

References DialogBox.Item.undraw(), DialogBox.Row.undraw(), DialogBox.undraw(), GUIElement.undraw(), and GUIElement.visible.

796 
797  def onUndraw(self,params):
798  if self.visible:
799  self.undraw()
def redraw (   self) 
override to preserve Z-order if possible 
(if so, mark self.redrawPreservesZ)

Definition at line 758 of file GUI.py.

758 
759  def redraw(self):
760  """ override to preserve Z-order if possible """
761  """ (if so, mark self.redrawPreservesZ) """
762  self.undraw()
763  self.draw()
def setModal (   self,
  modal 
)

Definition at line 811 of file GUI.py.

References sre_parse.dir, Breakpoint.enable(), and GUIButton.enable().

811 
812  def setModal(self,modal):
813  if modal:
814  GUIRootSingleton.modalElement=self
815  GUIRootSingleton.broadcastMessage('disable',{})
816  if 'enable' in dir(self):
817  self.enable()
818  GUIRootSingleton.broadcastRoomMessage('redraw',{})
819  elif GUIRootSingleton.modalElement == self:
820  GUIRootSingleton.modalElement=None
821  GUIRootSingleton.broadcastMessage('enable',{})
def show (   self)

Definition at line 740 of file GUI.py.

References GUIRoom.notifyNeedRedraw(), GUIElement.notifyNeedRedraw(), and GUIElement.visible.

740 
741  def show(self):
742  self.visible=1
743  self.notifyNeedRedraw()
def undraw (   self) 
Intentionally blank

Definition at line 755 of file GUI.py.

755 
756  def undraw(self):
757  """ Intentionally blank """

Field Documentation

id

Definition at line 719 of file GUI.py.

owner

Definition at line 716 of file GUI.py.

redrawPreservesZ

Definition at line 718 of file GUI.py.

room

Definition at line 715 of file GUI.py.

visible

Definition at line 717 of file GUI.py.

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