File: data_wrapper.py

package info (click to toggle)
python-pyface 8.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,944 kB
  • sloc: python: 54,107; makefile: 82
file content (84 lines) | stat: -rw-r--r-- 2,716 bytes parent folder | download
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
# (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!

from wx import CustomDataObject, DataFormat, DataObject, DataObjectComposite

from traits.api import Instance, provides

from pyface.data_view.i_data_wrapper import IDataWrapper, MDataWrapper


@provides(IDataWrapper)
class DataWrapper(MDataWrapper):
    """ WxPython implementaton of IDataWrapper.

    This wraps a DataObjectComposite which is assumed to contain a collection
    of CustomDataObjects that store data associated by mimetype.  Any other
    DataObjects in the DataObjectComposite are ignored.
    """

    #: We always have a a composite data object with custom data objects in it
    toolkit_data = Instance(
        DataObjectComposite,
        args=(),
        allow_none=False,
    )

    def mimetypes(self):
        """ Return a set of mimetypes holding data.

        Returns
        -------
        mimetypes : set of str
            The set of mimetypes currently storing data in the toolkit data
            object.
        """
        return {
            wx_format.GetId()
            for wx_format in self.toolkit_data.GetAllFormats()
        }

    def get_mimedata(self, mimetype):
        """ Get raw data for the given media type.

        Parameters
        ----------
        mimetype : str
            The mime media type to be extracted.

        Returns
        -------
        mimedata : bytes
            The mime media data as bytes.
        """
        wx_format = DataFormat(mimetype)
        if self.toolkit_data.IsSupported(wx_format):
            data_object = self.toolkit_data.GetObject(wx_format)
            if isinstance(data_object, CustomDataObject):
                return bytes(data_object.GetData())
        return None

    def set_mimedata(self, mimetype, raw_data):
        """ Set raw data for the given media type.

        Parameters
        ----------
        mimetype : str
            The mime media type to be extracted.
        mimedata : bytes
            The mime media data encoded as bytes..
        """
        wx_format = DataFormat(mimetype)
        if self.toolkit_data.IsSupported(wx_format, dir=DataObject.Set):
            data_object = self.toolkit_data.GetObject(wx_format)
        else:
            data_object = CustomDataObject(wx_format)
            self.toolkit_data.Add(data_object)
        data_object.SetData(raw_data)