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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
#-------------------------------------------------------------------------------
#
# Manages saving/restoring the state of an object. Any traits with metadata
# 'save_state = True' are automatically restored when the feature is applied
# and saved when they are changed. The traits are saved under the id
# specified by a trait with metadata 'save_state_id = True'. If no such trait
# exists, an id of the form: 'unknown.plugins.?.state', where ? = the name of
# the object's associated DockControl.
#
# Written by: David C. Morrill
#
# Date: 07/04/2006
#
# (c) Copyright 2006 by David C. Morrill
#
#-------------------------------------------------------------------------------
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import shelve
from os.path \
import join
from enthought.traits.api \
import HasTraits, List, Str
from enthought.traits.trait_base \
import traits_home
from enthought.pyface.dock.api \
import DockWindowFeature
#-------------------------------------------------------------------------------
# Returns a reference to the traits UI preference database:
#-------------------------------------------------------------------------------
def get_ui_db ( mode = 'r' ):
""" Returns a reference to the traits UI preference database.
"""
try:
return shelve.open( join( traits_home(), 'traits_ui' ),
flag = mode, protocol = -1 )
except:
return None
#-------------------------------------------------------------------------------
# 'SaveStateFeature' class:
#-------------------------------------------------------------------------------
class SaveStateFeature ( DockWindowFeature ):
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# The persistence id to save the data under:
id = Str
# List of traits to save/restore:
names = List( Str )
#---------------------------------------------------------------------------
# Performs any clean-up needed when the feature is being removed:
#---------------------------------------------------------------------------
def dispose ( self ):
""" Performs any clean-up needed when the feature is being removed.
"""
self.set_listeners( True )
#---------------------------------------------------------------------------
# Saves the current state of the plugin:
#---------------------------------------------------------------------------
def save_state ( self ):
""" Saves the current state of the plugin.
"""
db = get_ui_db( mode = 'c' )
if db is not None:
db[ self.id ] = self.dock_control.object.get( *self.names )
db.close()
#---------------------------------------------------------------------------
# Handles the 'names' trait being changed:
#---------------------------------------------------------------------------
def _names_changed ( self, names ):
""" Handles the 'names' trait being changed.
"""
self.set_listeners( False )
#---------------------------------------------------------------------------
# Sets/Resets all listeners:
#---------------------------------------------------------------------------
def set_listeners ( self, remove ):
object = self.dock_control.object
for name in self.names:
object.on_trait_change( self.save_state, name, remove = remove )
trait = object.base_trait( name )
if ((trait.handler is not None) and
hasattr( trait.handler, 'items_event' )):
object.on_trait_change( self.save_state, name + '_items',
remove = remove )
#-- Overidable Class Methods ---------------------------------------------------
#---------------------------------------------------------------------------
# Returns a feature object for use with the specified DockControl (or None
# if the feature does not apply to the DockControl object):
#---------------------------------------------------------------------------
def feature_for ( cls, dock_control ):
""" Returns a feature object for use with the specified DockControl (or
None if the feature does not apply to the DockControl object).
"""
object = dock_control.object
if isinstance( object, HasTraits ):
names = object.trait_names( save_state = True )
if len( names ) > 0:
# Get the id to save the options under:
ids = object.trait_names( save_state_id = True )
id = ''
if len( ids ) == 1:
id = getattr( object, ids[0] )
if id == '':
id = 'unknown.plugins.%s.state' % dock_control.name
# Assign the current saved state (if any) to the object:
db = get_ui_db()
if db is not None:
try:
state = db.get( id )
if state is not None:
for name, value in state.items():
try:
setattr( object, name, value )
except:
pass
except:
pass
db.close()
# Create and return the feature:
return cls( dock_control = dock_control,
id = id ).set(
names = names )
return None
feature_for = classmethod( feature_for )
|
