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
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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 cache. """
from traits.api import HasTraits, Interface
class IImageCache(Interface):
""" The interface for an image cache. """
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __init__(self, width, height):
""" Creates a new image cache for images of the given size.
Parameters
----------
width : int
The width of the images in pixels
height : int
The height of the images in pixels
"""
# ------------------------------------------------------------------------
# 'ImageCache' interface.
# ------------------------------------------------------------------------
def get_image(self, filename):
""" Returns the scaled image specified.
Parameters
----------
filename : str
The name of the file containing the image.
Returns
-------
scaled : toolkit image
The image referred to in the file, scaled to the cache's width
and height.
"""
# 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 get_bitmap(self, filename):
""" Returns the scaled image specified as a bitmap.
Parameters
----------
filename : str
The name of the file containing the image.
Returns
-------
scaled : toolkit bitmap
The image referred to in the file, scaled to the cache's width
and height, as a bitmap.
"""
class MImageCache(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the IImageCache interface.
"""
|
