"""
AppShell provides a GUI application framework.
This is an adaption of AppShell.py found in Python and Tkinter Programming
by John E. Grayson which is a streamlined adaptation of GuiAppD.py, originally
created by Doug Hellmann (doughellmann@mindspring.com).
"""
__all__ = ['AppShell']
from direct.showbase.DirectObject import DirectObject
from . import Dial
from . import Floater
from . import Slider
from . import EntryScale
from . import VectorWidgets
from . import ProgressBar
import Pmw
import tkinter as tk
import builtins
# Create toplevel widget dictionary
if not hasattr(builtins, "widgetDict"):
builtins.widgetDict = {} # type: ignore[attr-defined]
# Create toplevel variable dictionary
if not hasattr(builtins, "variableDict"):
builtins.variableDict = {} # type: ignore[attr-defined]
[docs]def resetVariableDict():
builtins.variableDict = {}
# Inherit from MegaWidget instead of Toplevel so you can pass in a toplevel
# to use as a container if you wish. If no toplevel passed in, create one
[docs]class AppShell(Pmw.MegaWidget, DirectObject):
appversion = '1.0'
appname = 'Generic Application Frame'
copyright = ('Copyright 2004 Walt Disney Imagineering.' +
' All Rights Reserved')
contactname = 'Mark R. Mine'
contactphone = '(818) 544-2921'
contactemail = 'Mark.Mine@disney.com'
frameWidth = 450
frameHeight = 320
padx = 5
pady = 5
usecommandarea = 0
usestatusarea = 0
balloonState = 'none'
panelCount = 0
[docs] def __init__(self, parent = None, **kw):
optiondefs = (
('title', self.appname, None),
('padx', 1, Pmw.INITOPT),
('pady', 1, Pmw.INITOPT),
('framewidth', self.frameWidth, Pmw.INITOPT),
('frameheight', self.frameHeight, Pmw.INITOPT),
('usecommandarea', self.usecommandarea, Pmw.INITOPT),
('usestatusarea', self.usestatusarea, Pmw.INITOPT),
)
self.defineoptions(kw, optiondefs)
# If no toplevel passed in, create one
if parent is None:
self.parent = tk.Toplevel()
else:
self.parent = parent
# Initialize the base class
Pmw.MegaWidget.__init__(self, self.parent)
# Set window size
self.parent.geometry('%dx%d' % (self.frameWidth, self.frameHeight))
self.parent.title(self['title'])
# Create unique id
AppShell.panelCount += 1
self.id = self.appname + '-' + repr(AppShell.panelCount)
# Create a dictionary in the widgetDict to hold this panel's widgets
self.widgetDict = builtins.widgetDict[self.id] = {}
# And one to hold this panel's variables
self.variableDict = builtins.variableDict[self.id] = {}
# Get handle to the toplevels hull
self._hull = self.component('hull')
# Initialize the application
self.appInit()
# create the interface
self.__createInterface()
# Set focus to ourselves
self.focus_set()
# initialize our options
self.initialiseoptions(AppShell)
self.pack(fill = tk.BOTH, expand = 1)
def __createInterface(self):
self.__createBalloon()
self.__createMenuBar()
self.__createDataArea()
self.__createCommandArea()
self.__createMessageBar()
self.__createAboutBox()
# Add binding for panel cleanup code
self.interior().bind('<Destroy>', self.onDestroy)
#
# Create the parts of the interface
# which can be modified by subclasses
#
self.createMenuBar()
self.createInterface()
def __createBalloon(self):
# Create the balloon help manager for the frame.
# Create the manager for the balloon help
self.__balloon = self.createcomponent('balloon', (), None,
Pmw.Balloon, (self._hull,))
self.__balloon.configure(state = self.balloonState)
def __createMenuBar(self):
self.menuFrame = tk.Frame(self._hull)
self.menuBar = self.createcomponent('menubar', (), None,
Pmw.MenuBar,
(self.menuFrame,),
hull_relief=tk.FLAT,
hull_borderwidth=0,
balloon=self.balloon())
self.menuBar.addmenu('Help', 'About %s' % self.appname, side = 'right')
self.menuBar.addmenu('File', 'File commands and Quit')
self.menuBar.pack(fill=tk.X, side = tk.LEFT)
# Force some space between pull down menus and other widgets
spacer = tk.Label(self.menuFrame, text = ' ')
spacer.pack(side = tk.LEFT, expand = 0)
self.menuFrame.pack(fill = tk.X)
def __createDataArea(self):
# Create data area where data entry widgets are placed.
self.dataArea = self.createcomponent('dataarea',
(), None,
tk.Frame, (self._hull,),
relief=tk.GROOVE,
bd=1)
self.dataArea.pack(side=tk.TOP, fill=tk.BOTH, expand=tk.YES,
padx=self['padx'], pady=self['pady'])
def __createCommandArea(self):
# Create a command area for application-wide buttons.
self.__commandFrame = self.createcomponent('commandframe', (), None,
tk.Frame,
(self._hull,),
relief=tk.SUNKEN,
bd=1)
self.__buttonBox = self.createcomponent('buttonbox', (), None,
Pmw.ButtonBox,
(self.__commandFrame,),
padx=0, pady=0)
self.__buttonBox.pack(side=tk.TOP, expand=tk.NO, fill=tk.X)
if self['usecommandarea']:
self.__commandFrame.pack(side=tk.TOP,
expand=tk.NO,
fill=tk.X,
padx=self['padx'],
pady=self['pady'])
def __createMessageBar(self):
# Create the message bar area for help and status messages.
frame = self.createcomponent('bottomtray', (), None,
tk.Frame, (self._hull,), relief=tk.SUNKEN)
self.__messageBar = self.createcomponent('messagebar',
(), None,
Pmw.MessageBar,
(frame,),
#entry_width = 40,
entry_relief=tk.SUNKEN,
entry_bd=1,
labelpos=None)
self.__messageBar.pack(side=tk.LEFT, expand=tk.YES, fill=tk.X)
self.__progressBar = ProgressBar.ProgressBar(
frame,
fillColor='slateblue',
doLabel=1,
width=150)
self.__progressBar.frame.pack(side=tk.LEFT, expand=tk.NO, fill=tk.NONE)
self.updateProgress(0)
if self['usestatusarea']:
frame.pack(side=tk.BOTTOM, expand=tk.NO, fill=tk.X)
self.__balloon.configure(statuscommand = \
self.__messageBar.helpmessage)
def __createAboutBox(self):
Pmw.aboutversion(self.appversion)
Pmw.aboutcopyright(self.copyright)
Pmw.aboutcontact(
'For more information, contact:\n %s\n Phone: %s\n Email: %s' % \
(self.contactname, self.contactphone, self.contactemail))
self.about = Pmw.AboutDialog(self._hull,
applicationname=self.appname)
self.about.withdraw()
[docs] def toggleBalloon(self):
if self.toggleBalloonVar.get():
self.__balloon.configure(state = 'both')
else:
self.__balloon.configure(state = 'status')
[docs] def showAbout(self):
# Create the dialog to display about and contact information.
self.about.show()
self.about.focus_set()
[docs] def quit(self):
self.parent.destroy()
### USER METHODS ###
# To be overridden
[docs] def appInit(self):
# Called before interface is created (should be overridden).
pass
[docs] def createInterface(self):
# Override this method to create the interface for the app.
pass
[docs] def onDestroy(self, event):
# Override this method with actions to be performed on panel shutdown
pass
# Getters
[docs] def interior(self):
# Retrieve the interior site where widgets should go.
return self.dataArea
[docs] def balloon(self):
# Retrieve the panel's balloon widget
return self.__balloon
[docs] def messageBar(self):
# Retieve the message bar
return self.__messageBar
# Utility functions
[docs] def bind(self, child, balloonHelpMsg, statusHelpMsg=None):
# Bind a help message and/or status message to a widget.
self.__balloon.bind(child, balloonHelpMsg, statusHelpMsg)
[docs] def updateProgress(self, newValue=0, newMax=0):
# Used to update progress bar
self.__progressBar.updateProgress(newValue, newMax)
## WIDGET UTILITY FUNCTIONS ##
[docs] def addVariable(self, category, text, variable):
self.variableDict[category + '-' + text] = variable
[docs] def getVariable(self, category, text):
return self.variableDict.get(category + '-' + text, None)
[docs] def newCreateLabeledEntry(self, parent, category, text, help = '',
command = None, value = '',
width = 12, relief = tk.SUNKEN,
side = tk.LEFT, fill = tk.X, expand = 0):
""" createLabeledEntry(parent, category, text, [options]) """
# Create labeled entry
frame = tk.Frame(parent)
variable = tk.StringVar()
variable.set(value)
label = tk.Label(frame, text = text)
label.pack(side = tk.LEFT, fill = tk.X, expand = 0)
entry = tk.Entry(frame, width = width, relief = relief,
textvariable = variable)
entry.pack(side = tk.LEFT, fill = tk.X, expand = 1)
frame.pack(side = side, fill = tk.X, expand = expand)
if command:
entry.bind('<Return>', command)
# Add balloon help
self.bind(label, help)
self.bind(entry, help)
# Record widgets and variable
self.addWidget(category, text, entry)
self.addWidget(category, text + '-Label', label)
self.addVariable(category, text, variable)
return entry
[docs] def newCreateFloater(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
Floater.Floater,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateDial(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
Dial.Dial,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateSider(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
Slider.Slider,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateEntryScale(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
EntryScale.EntryScale,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateVector2Entry(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
VectorWidgets.Vector2Entry,
help, command, side, fill, expand, kw)
[docs] def newCreateVector3Entry(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
VectorWidgets.Vector3Entry,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateColorEntry(self, parent, category, text,
help = '', command = None,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Create the widget
widget = self.createWidget(parent, category, text,
VectorWidgets.ColorEntry,
help, command, side, fill, expand, kw)
return widget
[docs] def newCreateComboBox(self, parent, category, text,
help = '', command = None,
items = [], state = tk.DISABLED, history = 0,
labelpos = tk.W, label_anchor = tk.W,
label_width = 16, entry_width = 16,
side = tk.LEFT, fill = tk.X, expand = 0, **kw):
# Update kw to reflect user inputs
kw['label_text'] = text
kw['labelpos'] = labelpos
kw['label_anchor'] = label_anchor
kw['label_width'] = label_width
kw['entry_width'] = entry_width
kw['scrolledlist_items'] = items
kw['entryfield_entry_state'] = state
# Create widget
widget = Pmw.ComboBox(parent, **kw)
# Bind selection command
widget['selectioncommand'] = command
# Select first item if it exists
if len(items) > 0:
widget.selectitem(items[0])
# Pack widget
widget.pack(side = side, fill = fill, expand = expand)
# Bind help
self.bind(widget, help)
# Record widget
self.addWidget(category, text, widget)
return widget
[docs]class TestAppShell(AppShell):
# Override class variables here
appname = 'Test Application Shell'
usecommandarea = 1
usestatusarea = 1
[docs] def __init__(self, parent = None, **kw):
# Call superclass initialization function
AppShell.__init__(self)
self.initialiseoptions(TestAppShell)
[docs] def createMain(self):
self.label = self.createcomponent('label', (), None,
tk.Label,
(self.interior(),),
text='Data Area')
self.label.pack()
self.bind(self.label, 'Space taker')
[docs] def createInterface(self):
self.createButtons()
self.createMain()
