1802830467

Build Type

github-actions

Committed by GitHub

Commit Message

<a href="https://github.com/dynobo/normcap/commit/<a class=hub.com/dynobo/normcap/commit/<a class="double-link" href="https://git"><a class=hub.com/dynobo/normcap/commit/<a class="double-link" href="https://git"><a class=hub.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453bef7">16437acef<a href="https://github.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453bef7">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453bef7&quot;&gt;16437acef&lt;/a&gt;&lt;a href=&quot;https://github.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453bef7&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f&lt;/a&gt;1453bef7">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/<a class="double-link" href="https://github.com/dynobo/normcap/commit/c7af6a71c8db03816308ebd7ed0c9732d1dfd713">c7af6a71c</a><a href="https://github.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453bef7">&amp;quot;&amp;gt;c7af6a71c&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;c7af6a71c&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/16437acef743c609a8e523c7460ff32f1453b&lt;/a&gt;ef7&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/<a class="double-link" href="https://github.com/dynobo/normcap/commit/8b70f052a">8b70f052a">8b70f052a</a>

Pull Request Pull Request #171: Pyside6

Run Details

974 of 974 new or added lines in 41 files covered. (100.0%)

1534 of 1930 relevant lines covered (79.48%)

0.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.76

/src/normcap/gui/base_window.py

"""Normcap base window.

Inherited for the main window, instantiated for the child windows (which get created
in multi display setups).
"""

import logging
import sys
from typing import Optional

from PySide6 import QtCore, QtGui, QtWidgets

from normcap import system_info
from normcap.gui.utils import get_icon, move_active_window_to_position_on_gnome
from normcap.models import CaptureMode, Rect

logger = logging.getLogger(__name__)


class BaseWindow(QtWidgets.QMainWindow):
    """Used for child windows and as base class for MainWindow."""

    # Helper window to extend the red border
    macos_border: Optional[QtWidgets.QMainWindow] = None

    def __init__(self, screen_idx: int, color: str, parent=None):
        """Initialize window."""
        super().__init__()
        self.screen_idx: int = screen_idx
        self.primary_color: QtGui.QColor = QtGui.QColor(color)
        self.main_window: QtWidgets.QMainWindow = parent or self

        # Window properties
        self.setObjectName(f"window-{self.screen_idx}")
        self.setWindowTitle("NormCap")
        self.setWindowIcon(get_icon("normcap.png"))
        self.setAnimated(False)
        self.setEnabled(True)

        # Prepare selection rectangle
        self.selection: Rect = Rect()
        self.is_positioned: bool = False
        self.pen_width: int = 2
        self.is_selecting: bool = False
        self.mode_indicator: str = "?"
        self.mode_indicator_font = QtGui.QFont()
        self.mode_indicator_font.setPixelSize(24)

        # Setup widgets and show
        logger.debug("Create window for screen %s", self.screen_idx)
        self._add_central_widget()
        self.set_fullscreen()

    def _add_central_widget(self):
        self.frame = QtWidgets.QFrame()
        self.frame.setObjectName("central_widget")
        self.frame.setEnabled(True)
        self.frame.setAutoFillBackground(True)
        self.frame.setStyleSheet(
            f"QFrame {{border: 3px solid {self.primary_color.name()};}}"
        )
        self.frame.setFrameShape(QtWidgets.QFrame.StyledPanel)
        self.frame.setFrameShadow(QtWidgets.QFrame.Plain)
        self.frame.setLineWidth(0)
        self.frame.setCursor(QtCore.Qt.CrossCursor)
        self.setCentralWidget(self.frame)

    ##################
    # Utility
    ##################
    def _get_mode_indicator_char(self):
        if self.main_window.capture.mode is CaptureMode.RAW:
            return "☰"
        if self.main_window.capture.mode is CaptureMode.PARSE:
            return "★"
        return ""

    ##################
    # Events
    ##################

    def paintEvent(self, _):
        """Draw screenshot and selection rectangle on window."""
        painter = QtGui.QPainter(self)

        window_size = self.centralWidget().size()
        screen = self.main_window.screens[self.screen_idx]
        image = screen.get_scaled_screenshot(window_size)

        painter.drawImage(0, 0, image)

        if not self.is_selecting:
            return

        # Draw selection rectangle
        painter.setPen(
            QtGui.QPen(self.primary_color, self.pen_width, QtCore.Qt.DashLine)
        )
        painter.drawRect(*self.selection.geometry)

        # Draw Mode indicator
        painter.setFont(self.mode_indicator_font)
        painter.drawText(
            max(self.selection.right, self.selection.left) - 18,
            min(self.selection.bottom, self.selection.top) - 8,
            self.mode_indicator,
        )
        painter.end()

    def keyPressEvent(self, event):
        """Handle ESC key pressed."""
        if event.key() == QtCore.Qt.Key_Escape:
            if self.is_selecting:
                # Abort selection process, allowing to reselect
                self.is_selecting = False
                self.update()
            else:
                # Quit application
                self.main_window.com.on_quit_or_hide.emit("esc button pressed")

    def mousePressEvent(self, event):
        """Handle left mouse button clicked."""
        if event.button() == QtCore.Qt.LeftButton:
            self.is_selecting = True
            self.mode_indicator = self._get_mode_indicator_char()
            self.selection.top = self.selection.bottom = event.position().y()
            self.selection.left = self.selection.right = event.position().x()
            self.update()

    def mouseMoveEvent(self, event):
        """Update selection on mouse move."""
        self.selection.bottom = event.position().y()
        self.selection.right = event.position().x()
        self.update()

    def mouseReleaseEvent(self, event):
        """Start OCR workflow on left mouse button release."""
        if (event.button() == QtCore.Qt.LeftButton) and self.is_selecting:
            self.selection.bottom = event.position().y()
            self.selection.right = event.position().x()

            self.is_selecting = False
            self.main_window.com.on_set_cursor_wait.emit()
            self.main_window.com.on_minimize_windows.emit()

            factor = self.main_window.screens[self.screen_idx].screen_window_ratio
            self.selection.scale(factor)
            self.selection.normalize()

            self.main_window.com.on_region_selected.emit(
                (self.selection, self.screen_idx)
            )

            self.selection = Rect()
            self.update()

    def changeEvent(self, event) -> None:
        """Update position on Wayland."""
        if (
            event.type() == QtCore.QEvent.Type.ActivationChange
            and system_info.display_manager_is_wayland()
            and self.isActiveWindow()
            and not self.is_positioned
        ):
            self._position_windows_on_wayland()
            self.main_window.com.on_window_positioned.emit()
        return super().changeEvent(event)

    def hideEvent(self, _) -> None:
        """Make sure MacOS border window is hidden."""
        if self.macos_border:
            self.macos_border.hide()

    ##################
    # Adjust UI
    ##################

    def set_fullscreen(self):
        """Set window to full screen using platform specific methods."""
        logger.debug("Set window for screen %s to fullscreen", self.screen_idx)

        if sys.platform == "linux":
            self._set_fullscreen_linux()
        elif sys.platform == "darwin":
            self._set_fullscreen_macos()
        elif sys.platform == "win32":
            self._set_fullscreen_windows()
        else:
            raise NotImplementedError(f"Platform {sys.platform} not supported")

    def _set_fullscreen_linux(self):
        self.setWindowFlags(
            QtCore.Qt.FramelessWindowHint | QtCore.Qt.BypassWindowManagerHint
        )

        self.setFocusPolicy(QtCore.Qt.StrongFocus)
        self.setWindowState(QtCore.Qt.WindowActive)

        screen_geometry = self.main_window.screens[self.screen_idx].geometry
        self.move(screen_geometry.left, screen_geometry.top)
        self.setMinimumSize(QtCore.QSize(screen_geometry.width, screen_geometry.height))
        self.showFullScreen()

    def _set_fullscreen_macos(self):
        self.setWindowFlags(
            QtCore.Qt.FramelessWindowHint
            | QtCore.Qt.CustomizeWindowHint
            # | QtCore.Qt.WindowStaysOnTopHint
            # | QtCore.Qt.NoDropShadowWindowHint
        )
        self.setFocusPolicy(QtCore.Qt.StrongFocus)

        screen_geometry = self.main_window.screens[self.screen_idx].geometry
        self.setGeometry(
            screen_geometry.left,
            screen_geometry.top,
            screen_geometry.width,
            screen_geometry.height,
        )
        self.showFullScreen()

    def _set_fullscreen_windows(self):
        self.setWindowFlags(
            QtCore.Qt.FramelessWindowHint
            | QtCore.Qt.CustomizeWindowHint
            | QtCore.Qt.WindowStaysOnTopHint
        )
        screen_geometry = self.main_window.screens[self.screen_idx].geometry
        self.move(screen_geometry.left, screen_geometry.top)
        self.showFullScreen()

    def _position_windows_on_wayland(self):
        self.setFocus()
        screen_geometry = self.main_window.screens[self.screen_idx].geometry
        logger.debug("Move window %s to position  %s", self.screen_idx, screen_geometry)
        move_active_window_to_position_on_gnome(screen_geometry)
        self.is_positioned = True

1	"""Normcap base window.
2
3	Inherited for the main window, instantiated for the child windows (which get created
4	in multi display setups).
5	"""
6
7	import logging	1✔
8	import sys	1✔
9	from typing import Optional	1✔
10
11	from PySide6 import QtCore, QtGui, QtWidgets	1✔
12
13	from normcap import system_info	1✔
14	from normcap.gui.utils import get_icon, move_active_window_to_position_on_gnome	1✔
15	from normcap.models import CaptureMode, Rect	1✔
16
17	logger = logging.getLogger(__name__)	1✔
18
19
20	class BaseWindow(QtWidgets.QMainWindow):	1✔
21	"""Used for child windows and as base class for MainWindow."""
22
23	# Helper window to extend the red border
24	macos_border: Optional[QtWidgets.QMainWindow] = None	1✔
25
26	def __init__(self, screen_idx: int, color: str, parent=None):	1✔
27	"""Initialize window."""
28	super().__init__()	1✔
29	self.screen_idx: int = screen_idx	1✔
30	self.primary_color: QtGui.QColor = QtGui.QColor(color)	1✔
31	self.main_window: QtWidgets.QMainWindow = parent or self	1✔
32
33	# Window properties
34	self.setObjectName(f"window-{self.screen_idx}")	1✔
35	self.setWindowTitle("NormCap")	1✔
36	self.setWindowIcon(get_icon("normcap.png"))	1✔
37	self.setAnimated(False)	1✔
38	self.setEnabled(True)	1✔
39
40	# Prepare selection rectangle
41	self.selection: Rect = Rect()	1✔
42	self.is_positioned: bool = False	1✔
43	self.pen_width: int = 2	1✔
44	self.is_selecting: bool = False	1✔
45	self.mode_indicator: str = "?"	1✔
46	self.mode_indicator_font = QtGui.QFont()	1✔
47	self.mode_indicator_font.setPixelSize(24)	1✔
48
49	# Setup widgets and show
50	logger.debug("Create window for screen %s", self.screen_idx)	1✔
51	self._add_central_widget()	1✔
52	self.set_fullscreen()	1✔
53
54	def _add_central_widget(self):	1✔
55	self.frame = QtWidgets.QFrame()	1✔
56	self.frame.setObjectName("central_widget")	1✔
57	self.frame.setEnabled(True)	1✔
58	self.frame.setAutoFillBackground(True)	1✔
59	self.frame.setStyleSheet(	1✔
60	f"QFrame {{border: 3px solid {self.primary_color.name()};}}"
61	)
62	self.frame.setFrameShape(QtWidgets.QFrame.StyledPanel)	1✔
63	self.frame.setFrameShadow(QtWidgets.QFrame.Plain)	1✔
64	self.frame.setLineWidth(0)	1✔
65	self.frame.setCursor(QtCore.Qt.CrossCursor)	1✔
66	self.setCentralWidget(self.frame)	1✔
67
68	##################
69	# Utility
70	##################
71	def _get_mode_indicator_char(self):	1✔
72	if self.main_window.capture.mode is CaptureMode.RAW:	1✔
73	return "☰"	×
74	if self.main_window.capture.mode is CaptureMode.PARSE:	1✔
75	return "★"	1✔
76	return ""	×
77
78	##################
79	# Events
80	##################
81
82	def paintEvent(self, _):	1✔
83	"""Draw screenshot and selection rectangle on window."""
84	painter = QtGui.QPainter(self)	1✔
85
86	window_size = self.centralWidget().size()	1✔
87	screen = self.main_window.screens[self.screen_idx]	1✔
88	image = screen.get_scaled_screenshot(window_size)	1✔
89
90	painter.drawImage(0, 0, image)	1✔
91
92	if not self.is_selecting:	1✔
93	return	1✔
94
95	# Draw selection rectangle
96	painter.setPen(	1✔
97	QtGui.QPen(self.primary_color, self.pen_width, QtCore.Qt.DashLine)
98	)
99	painter.drawRect(*self.selection.geometry)	1✔
100
101	# Draw Mode indicator
102	painter.setFont(self.mode_indicator_font)	1✔
103	painter.drawText(	1✔
104	max(self.selection.right, self.selection.left) - 18,
105	min(self.selection.bottom, self.selection.top) - 8,
106	self.mode_indicator,
107	)
108	painter.end()	1✔
109
110	def keyPressEvent(self, event):	1✔
111	"""Handle ESC key pressed."""
112	if event.key() == QtCore.Qt.Key_Escape:	×
113	if self.is_selecting:	×
114	# Abort selection process, allowing to reselect
115	self.is_selecting = False	×
116	self.update()	×
117	else:
118	# Quit application
119	self.main_window.com.on_quit_or_hide.emit("esc button pressed")	×
120
121	def mousePressEvent(self, event):	1✔
122	"""Handle left mouse button clicked."""
123	if event.button() == QtCore.Qt.LeftButton:	1✔
124	self.is_selecting = True	1✔
125	self.mode_indicator = self._get_mode_indicator_char()	1✔
126	self.selection.top = self.selection.bottom = event.position().y()	1✔
127	self.selection.left = self.selection.right = event.position().x()	1✔
128	self.update()	1✔
129
130	def mouseMoveEvent(self, event):	1✔
131	"""Update selection on mouse move."""
132	self.selection.bottom = event.position().y()	×
133	self.selection.right = event.position().x()	×
134	self.update()	×
135
136	def mouseReleaseEvent(self, event):	1✔
137	"""Start OCR workflow on left mouse button release."""
138	if (event.button() == QtCore.Qt.LeftButton) and self.is_selecting:	1✔
139	self.selection.bottom = event.position().y()	1✔
140	self.selection.right = event.position().x()	1✔
141
142	self.is_selecting = False	1✔
143	self.main_window.com.on_set_cursor_wait.emit()	1✔
144	self.main_window.com.on_minimize_windows.emit()	1✔
145
146	factor = self.main_window.screens[self.screen_idx].screen_window_ratio	1✔
147	self.selection.scale(factor)	1✔
148	self.selection.normalize()	1✔
149
150	self.main_window.com.on_region_selected.emit(	1✔
151	(self.selection, self.screen_idx)
152	)
153
154	self.selection = Rect()	1✔
155	self.update()	1✔
156
157	def changeEvent(self, event) -> None:	1✔
158	"""Update position on Wayland."""
159	if (	1✔
160	event.type() == QtCore.QEvent.Type.ActivationChange
161	and system_info.display_manager_is_wayland()
162	and self.isActiveWindow()
163	and not self.is_positioned
164	):
165	self._position_windows_on_wayland()	×
166	self.main_window.com.on_window_positioned.emit()	×
167	return super().changeEvent(event)	1✔
168
169	def hideEvent(self, _) -> None:	1✔
170	"""Make sure MacOS border window is hidden."""
171	if self.macos_border:	1✔
172	self.macos_border.hide()	×
173
174	##################
175	# Adjust UI
176	##################
177
178	def set_fullscreen(self):	1✔
179	"""Set window to full screen using platform specific methods."""
180	logger.debug("Set window for screen %s to fullscreen", self.screen_idx)	1✔
181
182	if sys.platform == "linux":	1✔
183	self._set_fullscreen_linux()	1✔
184	elif sys.platform == "darwin":	×
185	self._set_fullscreen_macos()	×
186	elif sys.platform == "win32":	×
187	self._set_fullscreen_windows()	×
188	else:
189	raise NotImplementedError(f"Platform {sys.platform} not supported")	×
190
191	def _set_fullscreen_linux(self):	1✔
192	self.setWindowFlags(	1✔
193	QtCore.Qt.FramelessWindowHint \| QtCore.Qt.BypassWindowManagerHint
194	)
195
196	self.setFocusPolicy(QtCore.Qt.StrongFocus)	1✔
197	self.setWindowState(QtCore.Qt.WindowActive)	1✔
198
199	screen_geometry = self.main_window.screens[self.screen_idx].geometry	1✔
200	self.move(screen_geometry.left, screen_geometry.top)	1✔
201	self.setMinimumSize(QtCore.QSize(screen_geometry.width, screen_geometry.height))	1✔
202	self.showFullScreen()	1✔
203
204	def _set_fullscreen_macos(self):	1✔
205	self.setWindowFlags(	×
206	QtCore.Qt.FramelessWindowHint
207	\| QtCore.Qt.CustomizeWindowHint
208	# \| QtCore.Qt.WindowStaysOnTopHint
209	# \| QtCore.Qt.NoDropShadowWindowHint
210	)
211	self.setFocusPolicy(QtCore.Qt.StrongFocus)	×
212
213	screen_geometry = self.main_window.screens[self.screen_idx].geometry	×
214	self.setGeometry(	×
215	screen_geometry.left,
216	screen_geometry.top,
217	screen_geometry.width,
218	screen_geometry.height,
219	)
220	self.showFullScreen()	×
221
222	def _set_fullscreen_windows(self):	1✔
223	self.setWindowFlags(	×
224	QtCore.Qt.FramelessWindowHint
225	\| QtCore.Qt.CustomizeWindowHint
226	\| QtCore.Qt.WindowStaysOnTopHint
227	)
228	screen_geometry = self.main_window.screens[self.screen_idx].geometry	×
229	self.move(screen_geometry.left, screen_geometry.top)	×
230	self.showFullScreen()	×
231
232	def _position_windows_on_wayland(self):	1✔
233	self.setFocus()	×
234	screen_geometry = self.main_window.screens[self.screen_idx].geometry	×
235	logger.debug("Move window %s to position %s", self.screen_idx, screen_geometry)	×
236	move_active_window_to_position_on_gnome(screen_geometry)	×
237	self.is_positioned = True	×

dynobo / normcap / 1802830467

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous