Differential D12626 Diff 47561 src/QuickEditor/QuickEditor.h

Changeset View

Standalone View

src/QuickEditor/QuickEditor.h

1	/*	1		/*
2	* Copyright (C) 2016 Boudhayan Gupta <bgupta@kde.org>	2		* Copyright (C) 2016 Boudhayan Gupta <bgupta@kde.org>
		3		* Copyright (C) 2018 Ambareesh "Amby" Balaji <ambareeshbalaji@gmail.com>
3	*	4		*
4	* This program is free software; you can redistribute it and/or modify	5		* 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		* 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		* the Free Software Foundation; either version 2 of the License, or
7	* (at your option) any later version.	8		* (at your option) any later version.
8	*	9		*
9	* This program is distributed in the hope that it will be useful,	10		* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of	11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12	* GNU General Public License for more details.	13		* GNU General Public License for more details.
13	*	14		*
14	* You should have received a copy of the GNU Lesser General Public License	15		* 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		* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor,	17		* Foundation, Inc., 51 Franklin Street, Fifth Floor,
17	* Boston, MA 02110-1301, USA.	18		* Boston, MA 02110-1301, USA.
18	*/	19		*/
19		20
20	#ifndef QUICKEDITOR_H	21		#ifndef QUICKEDITOR_H
21	#define QUICKEDITOR_H	22		#define QUICKEDITOR_H
22		23
23	#include <QObject>	24		#include <QKeyEvent>
		25		#include <QPainter>
		26		#include <QStaticText>
			broulikUnsubmitted Done Forward-declare, you only use them as pointers/references, no need to include: class QMouseEvent; broulik: Forward-declare, you only use them as pointers/references, no need to include: ``` class…
		27		#include <QWidget>
		28		#include <utility>
		29		#include <vector>
24		30
25	class QuickEditor : public QObject	31		class QMouseEvent;
		32
		33		class QuickEditor : public QWidget
26	{	34		{
27	Q_OBJECT	35		Q_OBJECT
28		36
29	public:	37		public:
30		38		explicit QuickEditor(const QPixmap &pixmap);
			broulikUnsubmitted Done Previous was correct: `QObject parent`, also doesn't this need to be a `QWidget `? broulik: Previous was correct: `QObject parent`, also doesn't this need to be a `QWidget `?
			abalajiAuthorUnsubmitted Done Well, I didn't intend to make this stupid change haha. I wrote this file from scratch and the lines happened to line up in the diff. And I think `QObject ` is correct since `QuickEditor` is created by `X11ImageGrabber`, which is a `QObject` abalaji:* Well, I didn't intend to make this stupid change haha. I wrote this file from scratch and the…
31	explicit QuickEditor(const QPixmap &pixmap, QObject *parent = nullptr);
32	virtual ~QuickEditor();
33
34	Q_SIGNALS:
35
36	void grabDone(const QPixmap &pixmap, const QRect &cropRegion);
37	void grabCancelled();
38
39	private Q_SLOTS:
40
41	void acceptImageHandler(int x, int y, int width, int height);
42		39
43	private:	40		private:
		41		enum MouseState : short {
		42		None = 0, // 0000
		43		Inside = 1 << 0, // 0001
			broulikUnsubmitted Done Can you use bit shifting/manipulation here maybe? e.g. `1<<0`, `1<<1` broulik: Can you use bit shifting/manipulation here maybe? e.g. `1<<0`, `1<<1`
			abalajiAuthorUnsubmitted Done Sure yeah, makes sense abalaji: Sure yeah, makes sense
		44		Outside = 1 << 1, // 0010
		45		TopLeft = 5, //101
		46		Top = 17, // 10001
		47		TopRight = 9, // 1001
		48		Right = 33, // 100001
		49		BottomRight = 6, // 110
		50		Bottom = 18, // 10010
		51		BottomLeft = 10, // 1010
		52		Left = 34, // 100010
		53		TopLeftOrBottomRight = TopLeft & BottomRight, // 100
			broulikUnsubmitted Done Can't you or them together? `TopLeft \| BottomRight`? broulik: Can't you or them together? `TopLeft \| BottomRight`?
		54		TopRightOrBottomLeft = TopRight & BottomLeft, // 1000
		55		TopOrBottom = Top & Bottom, // 10000
		56		RightOrLeft = Right & Left, // 100000
		57		};
44		58
45	struct ImageStore;	59		void acceptSelection();
46	ImageStore *mImageStore;	60		int boundsLeft(int newTopLeftX, const bool mouse = true);
		61		int boundsRight(int newTopLeftX, const bool mouse = true);
		62		int boundsUp(int newTopLeftY, const bool mouse = true);
		63		int boundsDown(int newTopLeftY, const bool mouse = true);
		64		void keyPressEvent(QKeyEvent* event) override;
		65		void keyReleaseEvent(QKeyEvent* event) override;
		66		void mousePressEvent(QMouseEvent* event) override;
		67		void mouseMoveEvent(QMouseEvent* event) override;
		68		void mouseReleaseEvent(QMouseEvent* event) override;
		69		void mouseDoubleClickEvent(QMouseEvent* event) override;
		70		void paintEvent(QPaintEvent*) override;
		71		void drawBottomHelpText(QPainter& painter);
		72		void drawDragHandles(QPainter& painter);
			broulikUnsubmitted Done `mousePosition` or `mouseLocation`? broulik: `mousePosition` or `mouseLocation`?
			abalajiAuthorUnsubmitted Done 👍 abalaji: :+1:
		73		void drawMagnifier(QPainter& painter);
		74		void drawMidHelpText(QPainter& painter);
		75		void drawSelectionSizeTooltip(QPainter& painter);
		76		void layoutBottomHelpText();
		77		void setMouseCursor(const QPointF& pos);
		78		MouseState mouseLocation(const QPointF& pos);
		79
		80		static const qreal mouseAreaSize;
		81		static const qreal cornerHandleRadius;
		82		static const qreal midHandleRadius;
		83		static const int selectionSizeThreshold;
		84
		85		static const int selectionBoxPaddingX;
		86		static const int selectionBoxPaddingY;
		87		static const int selectionBoxMarginY;
		88
		89		static constexpr int bottomHelpLength = 5;
			alexeyminUnsubmitted Done Some constants are initialized in .cpp-file, some here in header, why so inconsistent? And this line is also using constexpr, while others don't alexeymin: Some constants are initialized in .cpp-file, some here in header, why so inconsistent? And…
			abalajiAuthorUnsubmitted Done So, I'm trying to keep all constants in the .cpp file since they are implementation details. But, since `bottomHelpText` is an array, and the length of an array is necessary (variable-length arrays not allowed in C++), I'm forced to leave this constant in the header file. `constexpr` is not really needed here tho, so I can make it just `const`. abalaji: So, I'm trying to keep all constants in the .cpp file since they are implementation details.
		90		static std::pair<QStaticText, std::vector<QStaticText>> bottomHelpText[bottomHelpLength];
		91		static bool bottomHelpTextPrepared;
		92		static const int bottomHelpBoxPaddingX;
		93		static const int bottomHelpBoxPaddingY;
		94		static const int bottomHelpBoxPairSpacing;
		95		static const int bottomHelpBoxMarginBottom;
		96		static const int midHelpTextFontSize;
		97
		98		static const int magnifierLargeStep;
		99
		100		static const int magZoom;
		101		static const int magPixels;
		102		static const int magOffset;
			broulikUnsubmitted Done Color without a u; I know that's been wrong in the original code, too. broulik: Color without a u; I know that's been wrong in the original code, too.
			abalajiAuthorUnsubmitted Done Okay, fair enough in computer land I guess, although colour > color imo haha abalaji: Okay, fair enough in computer land I guess, although colour > color imo haha
		103
		104		QColor mMaskColor;
		105		QColor mStrokeColor;
		106		QColor mCrossColor;
		107		QColor mLabelBackgroundColor;
		108		QColor mLabelForegroundColor;
		109		QRectF mSelection;
		110		QPointF mStartPos;
		111		QPointF mInitialTopLeft;
		112		QString mMidHelpText;
		113		QFont mMidHelpTextFont;
		114		QFont mBottomHelpTextFont;
		115		QRect mBottomHelpBorderBox;
		116		QPoint mBottomHelpContentPos;
		117		int mBottomHelpGridLeftWidth;
		118		MouseState mMouseDragState;
		119		QPixmap mPixmap;
		120		qreal dprI;
		121		QPointF mMousePos;
		122		bool mMagnifierAllowed;
		123		bool mShowMagnifier;
		124		bool mToggleMagnifier;
47		125
48	class QuickEditorPrivate;	126		Q_SIGNALS:
49	Q_DECLARE_PRIVATE(QuickEditor)	127		void grabDone(const QPixmap &pixmap);
50	QuickEditorPrivate *d_ptr;	128		void grabCancelled();
			broulikUnsubmitted Done Doesn't compile, probably needs to be `Q_SIGNALS`? broulik: Doesn't compile, probably needs to be `Q_SIGNALS`?
51	};	129		};
52		130
53	#endif // QUICKEDITOR_H	131		#endif // QUICKEDITOR_H