Package client :: Package Viewers :: Module Items :: Class TopRegion

Class TopRegion

Overview

This object is the graphical representation of one top-level Region under the RegionTree. To constitute a valid TopRegion, it must have a name and shellAccess. The shellAccess is a string of the ipython command needed to access the object. Their name is a shellAccess, where both object attributes still exist with the same value, since TopRegions are both basin objects and variables.

Any abstract object, including this one, may have an alias. An alias is nothing more than setting a variable to an Abstract object. The point being that some arbitrarily deep buried object might have an obscene shellAccess, but the user can assign it to a variable and the GUI will realize this and accomdate for it. Essentially top-level Regions are aliases themselves, but you are welcome to give it another alias name if you wish.

These objects are created by having passed it a list of strings that identify the entire tree structure. Rather than just the information specific to this tree branch, every node linearly "under" and including this node is listed. It will find its current depth, and only generate tree items based on that depth (and tree structure "deeper"), until it has no more. All mutations to the list of strings are permanent, so once a line generates a tree item, it disposes of itself.

Nested Classes

[hide private]

Inherited from PyQt4.QtGui.QTreeWidgetItem: ItemType

Instance Methods

[hide private]

__init__(self, parent, info, name)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

isTop(self)
TopRegion.isTop (self)

source code

Delete(self)
TopRegion.Delete (self)

source code

Inherited from PyQt4.QtGui.QTreeWidgetItem: __eq__, __ge__, __gt__, __le__, __lt__, __ne__, addChild, addChildren, background, backgroundColor, checkState, child, childCount, clone, columnCount, data, flags, font, foreground, icon, indexOfChild, insertChild, insertChildren, isExpanded, isHidden, isSelected, parent, read, setBackground, setBackgroundColor, setCheckState, setData, setExpanded, setFlags, setFont, setForeground, setHidden, setIcon, setSelected, setSizeHint, setStatusTip, setText, setTextAlignment, setTextColor, setToolTip, setWhatsThis, sizeHint, sortChildren, statusTip, takeChild, takeChildren, text, textAlignment, textColor, toolTip, treeWidget, type, whatsThis, write

Inherited from sip.wrapper: __delattr__, __getattribute__, __new__, __setattr__

Inherited from object: __hash__, __reduce__, __reduce_ex__, __repr__, __str__

Inherited from Region

Copy(self)
Just adds this object to the "clipboard", located on the RegionTree.

source code

CreateGrid(self)
This will prompt the user for a name.

source code

CreateList(self)
This will prompt the user for a name.

source code

CreateRegion(self)
This will prompt the user for a name.

source code

Display(self)
This function actually sets the text to screen.

source code

Paste(self)
This action assumes something has been copied.

source code

Type(self)
Returns: For Regions, this will always return "REGION".

source code

nameMe(self, parentShellAccess, info)

source code

setAlias(self, alias)
This method will take a given alias and set keep track of its reference to this Region.

source code

Class Variables

[hide private]

Inherited from PyQt4.QtGui.QTreeWidgetItem: UserType

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, parent, info, name)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

isTop(self)

source code

TopRegion.isTop (self)

For top-level Regions this will always return True.

Returns:: For sub-Regions this will always return False.
Overrides: Region.isTop

Delete(self)

source code

TopRegion.Delete (self)

This method will create a dialog that simply verifies that the user wishes to delete this region. Note, this deletes the actual data object behind the abstract model. The data can't be recovered after performing this action.

Overrides: Region.Delete

Class TopRegion

Overview

__init__(self, parent, info, name) (Constructor)

isTop(self)

Delete(self)

init(self, parent, info, name)
(Constructor)