1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" Abstract base class for a node in a preference dialog.
A preference node has a label and an image which are used to represent the node
in a preference dialog (usually in the form of a tree).
"""
# Enthought library imports.
from enthought.pyface.viewer.tree_item import TreeItem
from enthought.traits.api import Str
class PreferenceNode(TreeItem):
""" Abstract base class for a node in a preference dialog.
A preference node has a name and an image which are used to represent the
node in a preference dialog (usually in the form of a tree).
"""
#### 'PreferenceNode' interface ###########################################
# The node's unique Id.
id = Str
# The node's image.
image = Str
# The node name.
name = Str
# The Id of the help topic for the node.
help_id = Str
###########################################################################
# 'object' interface.
###########################################################################
def __str__(self):
""" Returns the string representation of the item. """
return self.name
###########################################################################
# 'PreferenceNode' interface.
###########################################################################
def create_page(self):
""" Creates the preference page for this node. """
raise NotImplementedError
def lookup(self, id):
""" Returns the child of this node with the specified Id.
Returns None if no such child exists.
"""
for node in self.children:
if node.id == id:
break
else:
node = None
return node
#### EOF ######################################################################
|