Differential D21042 Diff 57657 src/Platforms/Platform.h

Changeset View

Standalone View

src/Platforms/Platform.h

This file was added.

		1		/* This file is part of Spectacle, the KDE screenshot utility
		2		* Copyright (C) 2019 Boudhayan Gupta <bgupta@kde.org>
		3		*
		4		* This program is free software; you can redistribute it and/or modify
		5		* it under the terms of the GNU Lesser General Public License as published by
		6		* the Free Software Foundation; either version 2 of the License, or
		7		* (at your option) any later version.
		8		*
		9		* This program is distributed in the hope that it will be useful,
		10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
		11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		12		* GNU General Public License for more details.
		13		*
		14		* You should have received a copy of the GNU Lesser General Public License
		15		* along with this program; if not, write to the Free Software
		16		* Foundation, Inc., 51 Franklin Street, Fifth Floor,
		17		* Boston, MA 02110-1301, USA.
		18		*
		19		* SPDX-License-Identifier: LGPL-2.0-or-later
		20		*/
		21
		22		#pragma once
		23
		24		#include <QObject>
		25		#include <QFlags>
		26
		27		class Platform: public QObject
		28		{
		29		Q_OBJECT
		30
		31		public:
		32
		33		enum class GrabMode {
		34		InvalidChoice = 0x00,
		35		AllScreens = 0x01,
		36		CurrentScreen = 0x02,
		37		ActiveWindow = 0x04,
		38		WindowUnderCursor = 0x08,
		39		TransientWithParent = 0x10
		40		};
		41		using GrabModes = QFlags<GrabMode>;
		42		Q_FLAG(GrabModes)
		43
		44		enum class ShutterMode {
		45		Immediate = 0x01,
		46		OnClick = 0x02
		47		};
		48		using ShutterModes = QFlags<ShutterMode>;
		49		Q_FLAG(ShutterModes)
		50
		51		explicit Platform(QObject *parent = nullptr);
		52		virtual ~Platform() = default;
		53
		54		virtual QString platformName() const = 0;
		55		virtual GrabModes supportedGrabModes() const = 0;
		56		virtual ShutterModes supportedShutterModes() const = 0;
		57
		58		public Q_SLOTS:
		59
		60		virtual void doGrab(ShutterMode theShutterMode, GrabMode theGrabMode, bool theIncludePointer, bool theIncludeDecorations) = 0;
		61
		62		Q_SIGNALS:
		63
		64		void newScreenshotTaken(const QPixmap &thePixmap);
		65		void newScreenshotFailed();
		66		void windowTitleChanged(const QString &theWindowTitle);
		67		};
		68
		69		Q_DECLARE_OPERATORS_FOR_FLAGS(Platform::GrabModes)
		70		Q_DECLARE_OPERATORS_FOR_FLAGS(Platform::ShutterModes)