Package pygsear :: Module Widget :: Class Dialog_LineInput
[show private | hide private]
[frames | no frames]

Class Dialog_LineInput

object --+                    
         |                    
    Sprite --+                
             |                
      Drawable --+            
                 |            
         Layer --+            
                 |            
             Layer --+        
                     |        
            Widget --+        
                     |        
                Dialog --+    
                         |    
                 Dialog_OK --+
                             |
                            Dialog_LineInput


Used to get a single line of input
Method Summary
  __init__(self, window, size, message, default, callback, group)
Initialize the line input dialog.
a new object with type S, a subtype of T __new__(S, ...)
  __repr__(self)
(inherited from Sprite)
  activate(self)
(inherited from Widget)
  add(self, group)
add(group) add a sprite to container (inherited from Sprite)
  add_internal(self, group)
(inherited from Sprite)
  alive(self)
alive() -> bool ask the life of a sprite (inherited from Sprite)
  border(self, width, color, left, right, top, bottom)
Draw a border around the screen (inherited from Layer)
bool can_see(self, target, blocking_rects_list)
Performs a los (line of sight) check from the center of the source to the center of the target. (inherited from Drawable)
  cancel(self, pygame_event)
(inherited from Dialog)
  center(self, x, y, dx, dy)
center the Drawable in its layer (inherited from Layer)
  clear(self, surface)
erase image to background, returning affected rect (inherited from Layer)
bool collide(self, other)
return True if this sprite and other sprite overlap. (inherited from Drawable)
Drawable or False collidelist(self, lothers)
return True if this sprite and any in list of others collide. (inherited from Drawable)
List collidelistall(self, lothers)
return True if this sprite and any in list of others collide. (inherited from Drawable)
  deactivate(self)
(inherited from Widget)
  direction(self, point)
return the direction from the sprite to a point (inherited from Drawable)
  distance(self, point)
return the distance from the sprite to a point (inherited from Drawable)
  draw(self, surface)
draw image, returning affected rect (inherited from Layer)
  finished(self, text)
Default callback when text input is complete.
  get_position(self)
return a copy of the sprite's position (inherited from Drawable)
  get_size(self)
return size of sprite's rect. (inherited from Drawable)
  groups(self)
groups() -> list list used sprite containers (inherited from Sprite)
  kill(self)
kill() end life of sprite, remove from all groups (inherited from Sprite)
  modal(self)
  move(self)
set position to next position on path (inherited from Drawable)
  nop(self, arg)
(inherited from Widget)
  nudge(self, dx, dy)
Move sprite. (inherited from Drawable)
  ok(self, pygame_event)
Called when OK button is clicked.
  onscreen(self, slack, **kw)
return True if image is on the screen or layer. (inherited from Drawable)
  pause(self)
stop moving along Path (inherited from Drawable)
  remove(self, group)
remove(group) remove a sprite from container (inherited from Sprite)
  remove_internal(self, group)
(inherited from Sprite)
  runPath(self, frames)
call move() continuously (inherited from Drawable)
  set_background(self, filename, img, tilename, tile, color)
Set the background. (inherited from Layer)
  set_callback(self, callback)
(inherited from Widget)
  set_crect(self, crect)
set the collision pygame.Rectused for collision checking. (inherited from Drawable)
  set_path(self, path)
set which path to follow (inherited from Drawable)
  set_position(self, location, *args)
Move sprite to location. (inherited from Drawable)
  set_positionRandom(self, slack)
Move sprite to a random location on screen (inherited from Drawable)
  set_size(self, size)
Set size of sprite's rect. (inherited from Drawable)
  solid(self, other, move_both)
move sprite so that it does not overlap with other sprite (inherited from Drawable)
  stretch(self, dx, dy, size, keepAspectRatio)
Change the size of sprite's image, and rect. (inherited from Drawable)
  teardown(self)
(inherited from Dialog)
  uclear(self, surface)
clear sprite and update display (inherited from Drawable)
  udraw(self, surface)
Draw image and update display. (inherited from Drawable)
  unpause(self)
start moving along Path (inherited from Drawable)
  update(self, *args)
(inherited from Sprite)
  updateContents(self)
move and re-draw all the sprites that use this layer (inherited from Layer)
  _quit(self, pygame_event)
(inherited from Widget)
  _set_position(self, location)
Move sprite to location. (inherited from Drawable)
  _stop(self, pygame_event)
(inherited from Widget)

Method Details

__init__(self, window=None, size=None, message='', default='', callback=None, group=None)
(Constructor)

Initialize the line input dialog.
Parameters:
window - Layer in which to draw the dialog box.
message - Text message to print above the input box.
callback - Function to call when input is finished. returns the input text to the callback function.
group - Other event group in which to include this widget's events, in addition to its own event group.

__new__(S, ...)

Returns:
a new object with type S, a subtype of T

finished(self, text)

Default callback when text input is complete.

ok(self, pygame_event)

Called when OK button is clicked. Also called when widget is active and ENTER key is pressed.
Parameters:
pygame_event - The pygame event that triggered the callback.

Generated by Epydoc 1.1 on Sun Jan 25 19:10:13 2004 http://epydoc.sf.net