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
|
#------------------------------------------------------------------------------
# Copyright (c) 2005-2009 by 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!
#------------------------------------------------------------------------------
""" The interface for an image resource. """
import operator
from enthought.pyface.resource_manager import resource_manager
from enthought.resource.resource_path import resource_module, resource_path
from enthought.traits.api import Interface, List, Unicode
class IImageResource(Interface):
""" The interface for an image resource.
An image resource describes the location of an image and provides a way
to create a toolkit-specific image on demand.
"""
#### 'ImageResource' interface ############################################
# The absolute path to the image.
absolute_path = Unicode
# The name of the image.
name = Unicode
# A list of directories, classes or instances that will be used to search
# for the image (see the resource manager for more details).
search_path = List
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, name, search_path=None):
""" Creates a new image resource. """
###########################################################################
# 'ImageResource' interface.
###########################################################################
def create_image(self, size=None):
""" Creates a toolkit specific image for this resource. """
# FIXME v3: The need to distinguish between bitmaps and images is toolkit
# specific so, strictly speaking, the conversion to a bitmap should be done
# wherever the toolkit actually needs it.
def create_bitmap(self, size=None):
""" Creates a toolkit specific bitmap for this resource. """
def create_icon(self, size=None):
""" Creates a toolkit-specific icon for this resource. """
class MImageResource(object):
""" The mixin class that contains common code for toolkit specific
implementations of the IImageResource interface.
Implements: __init__(), create_image()
"""
#### Private interface ####################################################
# The image-not-found image. Note that it is not a trait.
_image_not_found = None
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, name, search_path=None):
self.name = name
if search_path is not None and operator.isSequenceType(search_path):
_path = search_path
elif search_path is not None:
_path = [search_path]
else:
_path = [resource_path()]
self.search_path = _path + [resource_module()]
###########################################################################
# 'ImageResource' interface.
###########################################################################
def create_image(self, size=None):
""" Creates a toolkit specific image for this resource. """
ref = self._get_ref(size)
if ref is not None:
image = ref.load()
else:
image = self._get_image_not_found_image()
return image
###########################################################################
# Private interface.
###########################################################################
def _get_ref(self, size=None):
""" Return the resource manager reference to the image. """
if self._ref is None:
self._ref = resource_manager.locate_image(self.name,
self.search_path, size)
return self._ref
def _get_image_not_found_image(self):
""" Returns the 'image not found' image. """
not_found = self._get_image_not_found()
if self is not not_found:
image = not_found.create_image()
else:
raise ValueError("cannot locate the file for 'image_not_found'")
return image
def _get_image_not_found(cls):
""" Returns the 'image not found' image resource. """
if cls._image_not_found is None:
from enthought.pyface.image_resource import ImageResource
cls._image_not_found = ImageResource('image_not_found')
return cls._image_not_found
_get_image_not_found = classmethod(_get_image_not_found)
#### EOF ######################################################################
|
