Source code for pyface.resource.resource_reference
# (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!
""" Resource references. """
from traits.api import Any, HasTraits, Instance
from pyface.resource.resource_factory import ResourceFactory
[docs]class ResourceReference(HasTraits):
""" Abstract base class for resource references.
Resource references are returned from calls to 'locate_reference' on the
resource manager.
"""
# The resource factory that will be used to load the resource.
resource_factory = Instance(ResourceFactory) # ReadOnly
# ------------------------------------------------------------------------
# 'ResourceReference' interface.
# ------------------------------------------------------------------------
[docs] def load(self):
""" Loads the resource. """
raise NotImplementedError()
[docs]class ImageReference(ResourceReference):
""" A reference to an image resource. """
# Iff the image was found in a file then this is the name of that file.
filename = Any # ReadOnly
# Iff the image was found in a zip file then this is the image data that
# was read from the zip file.
data = Any # ReadOnly
def __init__(self, resource_factory, filename=None, data=None):
""" Creates a new image reference. """
self.resource_factory = resource_factory
self.filename = filename
self.data = data
return
# ------------------------------------------------------------------------
# 'ResourceReference' interface.
# ------------------------------------------------------------------------
[docs] def load(self):
""" Loads the resource. """
if self.filename is not None:
image = self.resource_factory.image_from_file(self.filename)
elif self.data is not None:
image = self.resource_factory.image_from_data(self.data)
else:
raise ValueError("Image reference has no filename OR data")
return image