1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
|
"""
"""
import pygame
import style
class Widget:
"""Template object - base for all widgets.
<pre>Widget(**params)</pre>
<p>A number of optional params may be passed to the Widget initializer.</p>
<dl>
<dt>decorate<dd>defaults to True. If true, will call <tt>theme.decorate(self)</tt> to allow the theme a chance to decorate the widget.
<dt>style<dd>a dict of style parameters.
<dt>x, y, width, height<dd>position and size parameters, passed along to style
<dt>align, valign<dd>alignment parameters, passed along to style
<dt>font, color, background<dd>other common parameters that are passed along to style
<dt>cls<dd>class name as used by Theme
<dt>name<dd>name of widget as used by Form. If set, will call <tt>form.add(self,name)</tt> to add the widget to the most recently created Form.
<dt>focusable<dd>True if this widget can receive focus via Tab, etc. Defaults to True.
<dt>disabled<dd>True of this widget is disabled. Defaults to False.
<dt>value<dd>initial value
</dl>
<strong>Example - Creating your own Widget</strong>
<p>This example shows which methods are template methods.</p>
<code>
class Draw(gui.Widget):
def paint(self,s):
#paint the pygame.Surface
return
def update(self,s):
#update the pygame.Surface and return the update rects
return [pygame.Rect(0,0,self.rect.w,self.rect.h)]
def event(self,e):
#handle the pygame.Event
return
def resize(self,width=None,height=None):
#return the width and height of this widget
return 256,256
</code>
"""
def __init__(self,**params):
#object.Object.__init__(self)
self.connects = {}
params.setdefault('decorate',True)
params.setdefault('style',{})
params.setdefault('focusable',True)
params.setdefault('disabled',False)
self.focusable = params['focusable']
self.disabled = params['disabled']
self.rect = pygame.Rect(params.get('x',0),params.get('y',0),params.get('width',0),params.get('height',0))
s = params['style']
#some of this is a bit "theme-ish" but it is very handy, so these
#things don't have to be put directly into the style.
for att in ('align','valign','x','y','width','height','color','font','background'):
if att in params: s[att] = params[att]
self.style = style.Style(self,s)
self.cls = 'default'
if 'cls' in params: self.cls = params['cls']
if 'name' in params:
import form
self.name = params['name']
if hasattr(form.Form,'form') and form.Form.form != None:
form.Form.form.add(self)
self.form = form.Form.form
if 'value' in params: self.value = params['value']
self.pcls = ""
if params['decorate'] != False:
import app
if not hasattr(app.App,'app'):
print 'gui.widget: creating an App'
app.App.app = app.App()
app.App.app.theme.decorate(self,params['decorate'])
def focus(self):
"""Focus this Widget.
<pre>Widget.focus()</pre>
"""
if getattr(self,'container',None) != None:
if self.container.myfocus != self: ## by Gal Koren
self.container.focus(self)
def blur(self):
"""Blur this Widget.
<pre>Widget.blur()</pre>
"""
if getattr(self,'container',None) != None: self.container.blur(self)
def open(self):
"""Open this Widget as a modal dialog.
<pre>Widget.open()</pre>
"""
if getattr(self,'container',None) != None: self.container.open(self)
def close(self):
"""Close this Widget (if it is a modal dialog.)
<pre>Widget.close()</pre>
"""
if getattr(self,'container',None) != None: self.container.close(self)
def resize(self,width=None,height=None):
"""Template method - return the size and width of this widget.
<p>Responsible for also resizing all sub-widgets.</p>
<pre>Widget.resize(width,height): return width,height</pre>
<dl>
<dt>width<dd>suggested width
<dt>height<dd>suggested height
</dl>
<p>If not overridden, will return self.style.width, self.style.height</p>
"""
return self.style.width, self.style.height
def chsize(self):
"""Change the size of this widget.
<p>Calling this method will cause a resize on all the widgets,
including this one.</p>
<pre>Widget.chsize()</pre>
"""
if not hasattr(self,'_painted'): return
if not hasattr(self,'container'): return
import app
if hasattr(app.App,'app'):
if app.App.app._chsize: return
app.App.app.chsize()
return
#if hasattr(app.App,'app'):
# w,h = self.rect.w,self.rect.h
# w2,h2 = self.resize()
# if w2 != w or h2 != h:
# app.App.app.chsize()
# else:
# self.repaint()
def update(self,s):
"""Template method - update the surface
<pre>Widget.update(s): return list of pygame.Rect(s)</pre>
<dl>
<dt>s<dd>pygame.Surface to update
</dl>
<p>return - a list of the updated areas as pygame.Rect(s).</p>
"""
return
def paint(self,s):
"""Template method - paint the surface
<pre>Widget.paint(s)</pre>
<dl>
<dt>s<dd>pygame.Surface to paint
</dl>
"""
return
def repaint(self):
"""Request a repaint of this Widget.
<pre>Widget.repaint()</pre>
"""
if getattr(self,'container',None) != None: self.container.repaint(self)
def repaintall(self):
"""Request a repaint of all Widgets.
<pre>Widget.repaintall()</pre>
"""
if getattr(self,'container',None) != None: self.container.repaintall()
def reupdate(self):
"""Request a reupdate of this Widget
<pre>Widget.reupdate()</pre>
"""
if getattr(self,'container',None) != None: self.container.reupdate(self)
def next(self):
"""Pass focus to next Widget.
<p>Widget order determined by the order they were added to their container.</p>
<pre>Widget.next()</pre>
"""
if getattr(self,'container',None) != None: self.container.next(self)
def previous(self):
"""Pass focus to previous Widget.
<p>Widget order determined by the order they were added to their container.</p>
<pre>Widget.previous()</pre>
"""
if getattr(self,'container',None) != None: self.container.previous(self)
def get_abs_rect(self):
"""Get the absolute rect of this widget on the App screen
<pre>Widget.get_abs_rect(): return pygame.Rect</pre>
"""
x, y = self.rect.x , self.rect.y
x += self._rect_content.x
y += self._rect_content.y
c = getattr(self,'container',None)
while c:
x += c.rect.x
y += c.rect.y
if hasattr(c,'_rect_content'):
x += c._rect_content.x
y += c._rect_content.y
c = getattr(c,'container',None)
return pygame.Rect(x, y, self.rect.w, self.rect.h)
def connect(self,code,fnc,*values):
"""Connect a event code to a callback function.
<p>There may only be one callback per event code.</p>
<pre>Object.connect(code,fnc,value)</pre>
<dl>
<dt>code<dd>event type [[gui-const]]
<dt>fnc<dd>callback function
<dt>*values<dd>values to pass to callback. Please note that callbacks may also have "magicaly" parameters. Such as:
<dl>
<dt>_event<dd>receive the event
<dt>_code<dd>receive the event code
<dt>_widget<dd>receive the sending widget
</dl>
</dl>
<strong>Example</strong>
<code>
def onclick(value):
print 'click',value
w = Button("PGU!")
w.connect(gui.CLICK,onclick,'PGU Button Clicked')
</code>
"""
self.connects[code] = {'fnc':fnc,'values':values}
def send(self,code,event=None):
"""Send a code, event callback trigger.
<pre>Object.send(code,event=None)</pre>
<dl>
<dt>code<dd>event code
<dt>event<dd>event
</dl>
"""
if code in self.connects:
con = self.connects[code]
#con['fnc'](*con['values'])
fnc = con['fnc']
values = list(con['values'])
nargs = fnc.func_code.co_argcount
names = list(fnc.func_code.co_varnames)[:nargs]
if hasattr(fnc,'im_class'): names.pop(0)
args = []
magic = {'_event':event,'_code':code,'_widget':self}
for name in names:
if name in magic.keys():
args.append(magic[name])
elif len(values):
args.append(values.pop(0))
else:
break
args.extend(values)
fnc(*args)
def _event(self,e):
if self.disabled: return
self.send(e.type,e)
return self.event(e)
# return
# import app
# if hasattr(app.App,'app'):
# app.App.app.events.append((self,e))
def event(self,e):
"""Template method - called when an event is passed to this object.
<p>Please note that if you use an event, returning the value True
will stop parent containers from also using the event. (For example, if
your widget handles TABs or arrow keys, and you don't want those to
also alter the focus.)</p>
<dl>
<dt>e<dd>event
</dl>
"""
return
|