Description

Defines the GPanel that is used in the GPanelApp framework (see grail.widgets.gpanelapp).

The idea here is that if you inherit from a GPanel, and override the makewidgets attribute, then we have a consistent method for constructing panels.

Example

The following code illustrates creating a panel for use with a the standard Compass panel application.

Notice that in our example that self (a reference to our particular instance of a GPanel), is the parent frame for all our widgets.

GPanel Widget

The GPanel widget inherits from,

• gwidget.GWidget (grail.widgets.gwidget)
• objsignal.Emitter (grail.objsignal)

class GPanel([parent, **keywords])

As a user of the MineSight® Grail library will never create an instance of the GPanel class directly. Instead you would supply your sub-class definitions of a GPanel to the a GPanelApp instance.

Arguments:

parent : Tkinter.Frame

Parent widget, widget we insert into.

keywords

Variable keyword list defined below.

Keywords:

title : string

The title for the panel.

widgets : list of widgets

Provides the list of widgets for the given panel.

Methods to Override or Extend:

makewidgets

Override this to define the layout of your panel.

onshow

Extend this method to do any processing prior to displaying the panel.

onhide

Extend this method to do any processing after the panel has hidden itself.

Data to Overide:

NAME

Overide this value to indicate the name for your panel.

disable()

Calls disable() on remembered widgets.

enable()

Calls enable() on remembered widgets.

forget(widgetlist)

Removes widgets from the remembered list. Walks the input list and removes widgets from the remembered list.

forgetall()

Allows you to quickly forget every widget previously remembered.

makewidgets()

Override this method to design your panel.

Note

The class itself is should be your parent frame for your widgets.

onshow()

Extend this method to do any processing prior to displaying the panel. This function should return 1 if the hide event is to proceed, and return 0 if you do not want the panel to show.

The default return value is always 1.

onhide()

Extend this method to do any processing after the panel has disappeared. This function should return 1 if the hide event is to proceed, and return 0 if you do not want the panel to hide.

The default return value is always 1.

remember(widgetlist)

Allows composers to remember their widgets.

Remembered widgets can be disabled/enabled, and validation checks can be made on widgets that have been remembered.

Thats about all. So if you have a list of labels, there's no need to remember those, because Labels are rather benign creatures.

In addition, you should only remember G* widgets, because these widgets only have the required additional methods. Other, Tkinter widgets, like Tkinter.Button, will essentially only be useful in causing a performance hit in your application because we have to look at them to realize that we can't do anything interesting with them.

updatevars()

Calls updatevars() on remembered widgets.

NAME

Override this value to indicate the name for your panel.