GUIButton Class Reference

Inheritance diagram for GUIButton:

Public Member Functions
def	__init__
def	onMouseUp
def	onMouseDown
def	onMouseEnter
def	onMouseLeave
def	onMouseMove
def	onClick
def	draw
def	setNeutralState
def	undraw
def	hide
def	show
def	redraw
def	setCaption
def	setState
def	getState
def	hasState
def	isEnabled
def	enable
def	disable
def	setEnable
def	getGroup
def	setGroup
def	onMessage
Public Member Functions inherited from GUIStaticImage
def	__init__
def	spriteIsValid
def	draw
def	undraw
def	redraw
def	setSprite
Public Member Functions inherited from GUIElement
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
	sprites
	hotspot
	linkdesc
	linkstate
	state
	group
	enabled
	clickHandler
	textOverlay
	textcolor
	textbgcolor
	textfontsize
	pythonstr
	visible
Data Fields inherited from GUIStaticImage
	sprite
	index
	spritestate
	redrawPreservesZ
	visible
Data Fields inherited from GUIElement
	room
	owner
	visible
	redrawPreservesZ
	id

Detailed Description

Definition at line 1100 of file GUI.py.

Constructor & Destructor Documentation

def __init__	(		self,
			room,
			linkdesc,
			index,
			spritefiles,
			hotspot,
			initialstate = 'enabled',
			clickHandler = None,
			textcolor = GUIColor.white(),
			textbgcolor = None,
			textfontsize = 1.0,
			kwarg
	)

Initializes the button (but does not draw it; use drawobjs())  

spritefiles: a dictionary, mapping states to sprites           

'enabled' : normal, default, enabled state                 

'disabled': disabled (grayed) state                        

'hot'     : hot state (mouse over)                         

'down'    : down state (mouse clicking)                    

'*'       : fallback state                                 

Each state in spriteifiles must be a tuple of the form:        

( path , location )                                        

or ( path, location, text [,textattrs] )                   

( ) - empty, for "no change"                               

with 'location' being a GUIRect                           

and  'text' being an optional overlaid text element       

Definition at line 1101 of file GUI.py.

    def __init__(self,room,linkdesc,index,spritefiles,hotspot,initialstate='enabled',clickHandler=None,textcolor=GUIColor.white(),textbgcolor=None,textfontsize=1.0,**kwarg):
        """ Initializes the button (but does not draw it; use drawobjs())  """
        """ spritefiles: a dictionary, mapping states to sprites           """
        """     'enabled' : normal, default, enabled state                 """
        """     'disabled': disabled (grayed) state                        """
        """     'hot'     : hot state (mouse over)                         """
        """     'down'    : down state (mouse clicking)                    """
        """     '*'       : fallback state                                 """
        """ Each state in spriteifiles must be a tuple of the form:        """
        """     ( path , location )                                        """
        """     or ( path, location, text [,textattrs] )                   """
        """     ( ) - empty, for "no change"                               """
        """      with 'location' being a GUIRect                           """
        """      and  'text' being an optional overlaid text element       """

        self.sprites=spritefiles
        self.hotspot=hotspot
        self.linkdesc=linkdesc
        self.linkstate=0
        self.state=initialstate
        self.group=index
        self.enabled=(initialstate!='disabled')
        self.clickHandler = clickHandler
        self.textOverlay = None
        self.textcolor = textcolor
        self.textbgcolor = textbgcolor
        self.textfontsize = textfontsize

        """ Init base class """
        GUIStaticImage.__init__(self,room,index,self._getStateSprite(self.state),**kwarg)
        self.textOverlay = GUIStaticText(self.room,self.index+"__text_overlay","",
            self.hotspot,self.textcolor,self.textfontsize,self.textbgcolor)
        self.textOverlay.hide()

        self.pythonstr = \
                  "# <-- this disables precompiled python objects\n" \
                 +"from GUI import GUIRootSingleton\n" \
             +"evData = Base.GetEventData()\n" \
             +"typeToMessage = {'click':'click','up':'up','down':'down','move':'move','enter':'enter','leave':'leave'}\n" \
             +"if ('type' in evData) and (evData['type'] in typeToMessage):\n" \
                 +"\tGUIRootSingleton.dispatchMessage("+str(self.id)+",typeToMessage[evData['type']],evData)\n" \
                 +"\tGUIRootSingleton.redrawIfNeeded()\n"