File: FileEdit.py

package info (click to toggle)
pyfai 0.20.0%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 78,460 kB
  • sloc: python: 49,743; lisp: 7,059; sh: 225; ansic: 165; makefile: 119
file content (241 lines) | stat: -rw-r--r-- 8,811 bytes parent folder | download | duplicates (4)
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# coding: utf-8
# /*##########################################################################
#
# Copyright (C) 2016-2018 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/

__authors__ = ["V. Valls"]
__license__ = "MIT"
__date__ = "16/10/2020"

import logging

from silx.gui import qt

from ..model.DataModel import DataModel
from ..model.ImageModel import ImageFromFilenameModel
from ..model.ImageModel import ImageFilenameModel
import pyFAI.io.image

_logger = logging.getLogger(__name__)


class FileEdit(qt.QLineEdit):
    """
    QLineEdit connected to a DataModel containing a file or nothing.

    It allows to edit a float value which can be nonified (by the use of an
    empty string).
    """

    sigValueAccepted = qt.Signal()
    """Emitted when a file was accepted.

    In case the value is still the same, no signal is sent from the DataModel,
    but this signal is emitted."""

    def __init__(self, parent=None):
        super(FileEdit, self).__init__(parent)
        self.__model = None
        self.__applyedWhenFocusOut = True
        self.__previousText = None
        self.__wasModified = False

        self.editingFinished.connect(self.__editingFinished)
        self.returnPressed.connect(self.__returnPressed)

    def event(self, event):
        if event.type() == 207:
            if self.__previousText != self.text():
                # TODO: This tries to capture Linux copy-paste using middle mouse
                # button. But this event do not match exactly what it is intented.
                # None of the available events capture this special copy-paste.
                self.__wasModified = True
        return qt.QLineEdit.event(self, event)

    def focusInEvent(self, event):
        self.__previousText = self.text()
        self.__wasModified = False
        super(FileEdit, self).focusInEvent(event)

    def dragEnterEvent(self, event):
        if self.__model is not None:
            if event.mimeData().hasFormat("text/uri-list"):
                event.acceptProposedAction()
            elif event.mimeData().hasFormat("application/x-silx-uri"):
                event.acceptProposedAction()

    def dropEvent(self, event):
        mimeData = event.mimeData()
        if mimeData.hasFormat("application/x-silx-uri"):
            byteString = event.mimeData().data("application/x-silx-uri")
            path = byteString.data().decode("utf-8")
        elif mimeData.hasUrls():
            urls = mimeData.urls()
            if len(urls) > 1:
                qt.QMessageBox.critical(self, "Drop cancelled", "A single file is expected")
                return
            path = urls[0].toLocalFile()
        else:
            qt.QMessageBox.critical(self, "Drop cancelled", "A file is expected")
            return

        old = self.blockSignals(True)
        self.setText(path)
        self.blockSignals(old)
        self.__applyFilename(path)

    def setModel(self, model):
        if self.__model is not None:
            self.__model.changed.disconnect(self.__modelChanged)
        self.__model = model
        if self.__model is not None:
            self.__model.changed.connect(self.__modelChanged)
        self.__modelChanged()

    def model(self):
        return self.__model

    def keyPressEvent(self, event):
        if event.key() in (qt.Qt.Key_Return, qt.Qt.Key_Enter):
            self.__returnPressed()
            event.accept()
        elif event.key() == qt.Qt.Key_Escape:
            self.__cancelText()
            event.accept()
        else:
            result = super(FileEdit, self).keyPressEvent(event)
            if event.isAccepted():
                self.__wasModified = True
            return result

    def __modelChanged(self):
        self.__cancelText()

    def __editingFinished(self):
        if not self.__wasModified:
            self.__cancelText()
        elif self.__applyedWhenFocusOut:
            self.__applyText()
        else:
            self.__cancelText()

    def __returnPressed(self):
        self.__applyText()

    def __applyText(self):
        text = self.text()
        if text == self.__previousText:
            self.sigValueAccepted.emit()
            return

        if text.strip() == "":
            value = None
        else:
            value = text

        try:
            self.__applyFilename(value)
            # Avoid sending further signals
            self.__previousText = text
            self.sigValueAccepted.emit()
        except Exception as e:
            _logger.debug(e, exc_info=True)
            self.__cancelText()

    def __cancelText(self):
        """Reset the edited value to the original one"""
        value = self.__getFilename()
        if value is None:
            text = ""
        else:
            text = value
        old = self.blockSignals(True)
        self.setText(text)
        # Avoid sending further signals
        self.__previousText = text
        self.blockSignals(old)

    def isApplyedWhenFocusOut(self):
        return self.__applyedWhenFocusOut

    def setApplyedWhenFocusOut(self, isApplyed):
        self.__applyedWhenFocusOut = isApplyed

    applyedWhenFocusOut = qt.Property(bool, isApplyedWhenFocusOut, setApplyedWhenFocusOut)
    """Apply the current edited value to the widget when it lose the
    focus. By default the previous value is displayed.
    """

    def __getFilename(self):
        model = self.__model
        if isinstance(model, (ImageFromFilenameModel, ImageFilenameModel)):
            return self.__model.filename()
        elif isinstance(model, DataModel):
            return self.__model.value()
        else:
            assert(False)

    def __applyFilename(self, filename):
        model = self.__model
        errorInfo = None
        try:
            # Avoid reentrant signal from model
            model.changed.disconnect(self.__modelChanged)
            # Avoid focuslost if a message is displayed
            self.editingFinished.disconnect(self.__editingFinished)

            if isinstance(model, ImageFromFilenameModel):
                if filename is not None:
                    try:
                        data = pyFAI.io.image.read_image_data(filename)
                    except Exception as e:
                        message = "Filename '%s' not supported.<br />%s" % (filename, str(e))
                        title = "Loading image error"
                        errorInfo = title, message
                        _logger.error("Error while loading %s" % filename)
                        _logger.debug("Backtrace", exc_info=True)
                        data = None
                else:
                    data, filename = None, None
                with model.lockContext():
                    model.setValue(data)
                    model.setFilename(filename)
                    model.setSynchronized(True)
                if errorInfo is not None:
                    title, message = errorInfo
                    qt.QMessageBox.critical(self, title, message)

            elif isinstance(model, (DataModel, ImageFilenameModel)):
                previous = model.value()
                try:
                    model.setValue(filename)
                except Exception as e:
                    if model.value() is not previous:
                        model.setValue(previous)
                    message = "Filename '%s' not supported.<br />%s" % (filename, str(e))
                    qt.QMessageBox.critical(self, "Unsupported filename", message)
            else:
                assert(False)
        finally:
            model.changed.connect(self.__modelChanged)
            self.editingFinished.connect(self.__editingFinished)