pyui.desktop
index
c:\projects\pyuicvs\pyui\desktop.py

# PyUI
# Copyright (C) 2001-2002 Sean C. Riley

# This library is free software; you can redistribute it and/or
# modify it under the terms of version 2.1 of the GNU Lesser General Public
# License as published by the Free Software Foundation.

# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 
Modules
            
copy
pyui
 
Classes
            
Desktop
guiCallback
guiEvent
 
class Desktop
      The Desktop. I am the container for all global PyUI data.
 
   Methods defined here:
__init__(self, renderer, width, height, fullscreen, theme)
activateWindow(self, window)
This adds a window to the set of windows and puts it on top, except
for any topMost widgets on the screen.
addCallback(self, method, interval=0)
addWindow(self, window)
This adds a window to the set of windows and puts it on top, except
for any topMost widgets on the screen.
collideRects(self, rect1, rect2)
destroyWidget(self, widget)
cleanup all global references to widget. This is called by destroy() so don't call it twice.
(internal)
dirtyCollidingWindows(self, inRect)
If a dirty rect collides with any other rects, they should be dirty also. This recurses
so that all colliding rects get dirtied. the second parameter to setDirty() prevents infinite
recursion.
draw(self)
Called to draw the widgets!
enableTooltip(self, interval)
findWidget(self, id)
Lookup a widget by its ID.
(public)
findWindowByHandle(self, handle)
getFocus(self)
return the current focused widget.
getModal(self)
getMustFill(self)
getTheme(self)
return the global theme object
handleEvent(self, event)
Process all outstanding events.
(private)
nextID(self)
postEvent(self, type, id=0)
Post an event object into the system. Comes from a widget object.
(internal)
postUserEvent(self, type, x=0, y=0, key=0, mods=0)
Post a user event into the system. This comes from a non-widget object
(public)
quit(self)
Called to destroy all the windows on shutdown.
readTimer(self)
registerHandler(self, eventType, handler)
Register a user defined handler for an event.
(public)
registerWidget(self, widget)
Register a top level window instance with the system.
(internal)
removeCallback(self, callback)
removeWidget(self, widget)
Remove a widget previously registered from the top-level widget list
setFocus(self, widget)
Set the focus to this widget.
setModal(self, window)
Sets the modal window.
(internal)
setMustFill(self)
tell the UI the screen must be cleared. if this is not set, only dirt rects get updated.
Setting this means that all the windows will redraw.
setTheme(self, theme)
sets the global theme object
setWaiting(self, value)
update(self)
Called constantly by the application to process PyUI events and scheduled callbacks.
updateModal(self, event)
in modal mode, only the modal dialog gets mouse events
updateToolTips(self, event)

Data and non-method functions defined here:
__doc__ = 'The Desktop. I am the container for all global PyUI data.\n '
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
__module__ = 'pyui.desktop'
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
lastEvent = 1000
int(x[, base]) -> integer
 
Convert a string or number to an integer, if possible.  A floating point
argument will be truncated towards zero (this does not include a string
representation of a floating point number!)  When converting a string, use
the optional base.  It is an error to supply a base when converting a
non-string.
theDesktop = None
 
class guiCallback
      a timed callback object. If the callback method returns a logical true, then the callback will
automatically be removed. This makes it easy to provide 1-shot timed callbacks. A callback with an interval
of 0 will be called on every frame.
 
   Methods defined here:
__init__(self, method, interval, lastTrigger)
process(self, time)

Data and non-method functions defined here:
__doc__ = 'a timed callback object. If the callback method ...rval\n of 0 will be called on every frame.\n '
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
__module__ = 'pyui.desktop'
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
 
class guiEvent
      an event that can be processed by the system.
 
   Methods defined here:
__init__(self, type, id=0, x=0, y=0, key=0, mods=0)

Data and non-method functions defined here:
__doc__ = 'an event that can be processed by the system.\n '
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
__module__ = 'pyui.desktop'
str(object) -> string
 
Return a nice string representation of the object.
If the argument is a string, the return value is the same object.
 
Functions
            
getDesktop()
getRenderer()
getTheme()
getUserEvent()
Request an event ID in the user event space.
NOTE: this is not part of the desktop as it can be called before the desktop object
is created.
(public)
readTimer()
 
Data
             __file__ = r'.\pyui\desktop.pyc'
__name__ = 'pyui.desktop'