Widget highlighting and shortcut system implementation

data/themes/classic/style.css

@@ -11,6 +11,10 @@ QMdiArea {
 	background-image: url("resources:background_artwork.png");
 }
 
+lmms--gui--InteractiveModelView {
+	qproperty-highlightColor: rgb(38, 237, 231);
+}
+
 lmms--gui--Knob {
 	qproperty-lineInactiveColor: rgb(120, 120, 120);
 	qproperty-arcInactiveColor: rgba(120, 120, 120, 70);

data/themes/default/style.css

@@ -46,6 +46,10 @@ lmms--gui--FileBrowser QCheckBox
 	color: white;
 }
 
+lmms--gui--InteractiveModelView {
+	qproperty-highlightColor: rgb(42, 219, 49);
+}
+
 lmms--gui--Knob {
 	qproperty-lineInactiveColor: rgb(120, 120, 120);
 	qproperty-arcInactiveColor: rgba(120, 120, 120, 70);

include/AutomationClipView.h

@@ -67,12 +67,20 @@ protected slots:
 	void paintEvent( QPaintEvent * pe ) override;
 	void dragEnterEvent( QDragEnterEvent * _dee ) override;
 	void dropEvent( QDropEvent * _de ) override;
-
+
+	const std::vector<ModelShortcut>& getShortcuts() override;
+	void processShortcutPressed(size_t shortcutLocation, QKeyEvent* event) override;
+	QString getShortcutMessage() override;
+	bool canAcceptClipboardData(Clipboard::StringPairDataType dataType) override;
+	bool processPasteImplementation(Clipboard::StringPairDataType type, QString& value) override;
 
 private:
 	AutomationClip * m_clip;
 	QPixmap m_paintPixmap;
 
+	static QString m_shortcutMessage;
+	static std::vector<InteractiveModelView::ModelShortcut> s_shortcutArray;
+
 	QStaticText m_staticTextName;
 	void scaleTimemapToFit( float oldMin, float oldMax );
 } ;

include/ClipView.h

@@ -32,6 +32,7 @@
 #include "ModelView.h"
 #include "Rubberband.h"
 #include "Clip.h"
+#include "Clipboard.h"
 
 
 class QMenu;
@@ -125,6 +126,9 @@ class ClipView : public selectableObject, public ModelView
 
 	// Returns true if selection can be merged and false if not
 	static bool canMergeSelection(QVector<ClipView*> clipvs);
+
+	//! used for getting the correct clip `StringPairDataType` for a given track
+	static Clipboard::StringPairDataType getClipStringPairType(Track* track);
 
 	QColor getColorForDisplay( QColor );
 
@@ -174,6 +178,14 @@ public slots:
 		m_needsUpdate = true;
 		selectableObject::resizeEvent( re );
 	}
+
+	// InteractiveModelView methods
+	const std::vector<ModelShortcut>& getShortcuts() override;
+	void processShortcutPressed(size_t shortcutLocation, QKeyEvent* event) override;
+	QString getShortcutMessage() override;
+	bool canAcceptClipboardData(Clipboard::StringPairDataType dataType) override;
+	bool processPasteImplementation(Clipboard::StringPairDataType type, QString& value) override;
+	void overrideSetIsHighlighted(bool isHighlighted) override;
 
 	bool unquantizedModHeld( QMouseEvent * me );
 	TimePos quantizeSplitPos( TimePos, bool shiftMode );
@@ -191,7 +203,7 @@ protected slots:
 	void updateLength();
 	void updatePosition();
 
-
+	static QString getDefaultSortcutMessage();
 private:
 	enum class Action
 	{
@@ -206,6 +218,8 @@ protected slots:
 	} ;
 
 	static TextFloat * s_textFloat;
+	static QString m_shortcutMessage;
+	static std::vector<InteractiveModelView::ModelShortcut> s_shortcutArray;
 
 	Clip * m_clip;
 	Action m_action;

include/Clipboard.h

@@ -32,14 +32,51 @@
 
 class QMimeData;
 
-namespace lmms::Clipboard
+namespace lmms
+{
+
+class AutomatableModel;
+
+namespace Clipboard
 {
 
 	enum class MimeType
 	{
 		StringPair,
 		Default
 	};
+
+	enum StringPairDataType
+	{
+		None, //!< only use for error handling
+		FloatValue,
+		AutomatableModelLink,
+		Instrument,
+
+		PresetFile,
+		PluginPresetFile,
+		SampleFile,
+		SoundFontFile,
+		PatchFile,
+		VstPluginFile,
+		ImportedProject,
+		ProjectFile,
+
+		SampleData,
+
+		InstrumentTrack,
+		PatternTrack,
+		SampleTrack,
+		AutomationTrack,
+		HiddenAutomationTrack,
+
+		MidiClip,
+		PatternClip,
+		SampleClip,
+		AutomationClip,
+
+		Count //!< utility, do not use
+	};
 
 	// Convenience Methods
 	const QMimeData * getMimeData();
@@ -50,10 +87,14 @@ namespace lmms::Clipboard
 	QString getString( MimeType mT );
 
 	// Helper methods for String Pair data
-	void copyStringPair( const QString & key, const QString & value );
-	QString decodeKey( const QMimeData * mimeData );
+	QString getStringPairKeyName(StringPairDataType type);
+	void copyStringPair(StringPairDataType key, const QString& value);
+	StringPairDataType decodeKey(const QMimeData* mimeData);
 	QString decodeValue( const QMimeData * mimeData );
 
+	QString encodeFloatValue(float value);
+	QString encodeAutomatableModelLink(const AutomatableModel& model);
+
 	inline const char * mimeType( MimeType type )
 	{
 		switch( type )
@@ -67,7 +108,8 @@ namespace lmms::Clipboard
 				break;
 		}
 	}
+} // namespace Clipboard
 
-} // namespace lmms::Clipboard
+} // namespace lmms
 
 #endif // LMMS_CLIPBOARD_H

include/FloatModelEditorBase.h

@@ -30,14 +30,15 @@
 #include <QPoint>
 
 #include "AutomatableModelView.h"
+#include "InteractiveModelView.h"
 
 
 namespace lmms::gui
 {
 
 class SimpleTextFloat;
 
-class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
+class LMMS_EXPORT FloatModelEditorBase : public InteractiveModelView, public FloatModelView
 {
 	Q_OBJECT
 
@@ -84,6 +85,13 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 	void enterEvent(QEvent *event) override;
 	void leaveEvent(QEvent *event) override;
 
+	// InteractiveModelView methods
+	const std::vector<ModelShortcut>& getShortcuts() override;
+	void processShortcutPressed(size_t shortcutLocation, QKeyEvent* event) override;
+	QString getShortcutMessage() override;
+	bool canAcceptClipboardData(Clipboard::StringPairDataType dataType) override;
+	bool processPasteImplementation(Clipboard::StringPairDataType type, QString& value) override;
+
 	virtual float getValue(const QPoint & p);
 
 private slots:
@@ -105,6 +113,8 @@ private slots:
 	}
 
 	static SimpleTextFloat * s_textFloat;
+	static QString m_shortcutMessage;
+	static std::vector<InteractiveModelView::ModelShortcut> s_shortcutArray;
 
 	BoolModel m_volumeKnob;
 	FloatModel m_volumeRatio;

include/InteractiveModelView.h

@@ -0,0 +1,161 @@
+/*
+ * InteractiveModelView.h - TODO
+ *
+ * Copyright (c) 2024 szeli1 <TODO/at/gmail/dot/com>
+ *
+ * This file is part of LMMS - https://lmms.io
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program (see COPYING); if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA.
+ *
+ */
+
+#ifndef LMMS_GUI_INTERACTIVE_MODEL_VIEW_H
+#define LMMS_GUI_INTERACTIVE_MODEL_VIEW_H
+
+#include <list>
+#include <memory>
+#include <vector>
+
+#include <QApplication>
+#include <QWidget>
+#include <QColor>
+
+#include "Clipboard.h"
+#include "lmms_export.h"
+#include "ModelView.h"
+
+class QColor;
+class QMimeData;
+class QPainter;
+class QTimer;
+
+namespace lmms::gui
+{
+
+class SimpleTextFloat;
+
+class LMMS_EXPORT InteractiveModelView : public QWidget
+{
+Q_OBJECT
+	Q_PROPERTY(QColor highlightColor READ getHighlightColor WRITE setHighlightColor)
+public:
+	InteractiveModelView(QWidget* widget);
+	~InteractiveModelView() override;
+
+	//! highlight every InteractiveModelView that accepts dataType
+	static void startHighlighting(Clipboard::StringPairDataType dataType);
+	static void stopHighlighting();
+	static void showMessage(QString& message);
+	static void hideMessage();
+
+	static QColor getHighlightColor();
+	static void setHighlightColor(QColor& color);
+
+	// returns true if successful
+	bool HandleKeyPress(QKeyEvent* event);
+protected:
+	struct ModelShortcut
+	{
+		ModelShortcut() {}
+		ModelShortcut(Qt::Key key, Qt::KeyboardModifier modifier, unsigned int times, QString description, bool shouldLoop) :
+			key(key),
+			modifier(modifier),
+			times(times),
+			shortcutDescription(description),
+			shouldLoop(shouldLoop)
+		{
+		}
+
+		bool operator==(ModelShortcut& rhs)
+		{
+			return key == rhs.key
+				&& modifier == rhs.modifier
+				&& times == rhs.times
+				&& shouldLoop == rhs.shouldLoop;
+		}
+
+		void reset()
+		{
+			key = Qt::Key_F35;
+			modifier = Qt::NoModifier;
+			times = 0;
+			shortcutDescription = "";
+			shouldLoop = false;
+		}
+
+		Qt::Key key = Qt::Key_F35;
+		Qt::KeyboardModifier modifier = Qt::NoModifier;
+		//! how many times do the keys need to be pressed to activate this shortcut
+		unsigned int times = 0;
+		//! what the shortcut does
+		QString shortcutDescription = "";
+		//! should it loop back if m_times is reached
+		bool shouldLoop = false;
+	};
+
+	void keyPressEvent(QKeyEvent* event) override;
+	void enterEvent(QEvent* event) override;
+	void leaveEvent(QEvent* event) override;
+
+	//! return the avalible shortcuts for the widget
+	virtual const std::vector<ModelShortcut>& getShortcuts() = 0;
+	//! called when a shortcut from `getShortcuts()` is pressed
+	virtual void processShortcutPressed(size_t shortcutLocation, QKeyEvent* event) = 0;
+	//! called when a shortcut message needs to be displayed
+	//! shortcut messages can be generated with `buildShortcutMessage()` (but it can be unoptimized to return `buildShortcutMessage()`)
+	virtual QString getShortcutMessage() = 0;
+	//! return true if the widget supports pasting / dropping `dataType` (used for StringPairDrag and Copying)
+	virtual bool canAcceptClipboardData(Clipboard::StringPairDataType dataType) = 0;
+	//! should implement dragging and dropping widgets or pasting from clipboard
+	//! should return if `QDropEvent` event can be accepted
+	//! force implement this method
+	virtual bool processPasteImplementation(Clipboard::StringPairDataType type, QString& value) = 0;
+	//! calls `processPasteImplementation()` to process paste
+	bool processPaste(const QMimeData* mimeData);
+	//! override this if the widget requires custom updating code
+	virtual void overrideSetIsHighlighted(bool isHighlighted);
+
+	//! draws the highlight automatically for the widget if highilighted
+	void drawAutoHighlight(QPainter* painter);
+	//! builds a string from `getShortcuts()`
+	QString buildShortcutMessage();
+
+	bool getIsHighlighted() const;
+	void setIsHighlighted(bool isHighlighted);
+private slots:
+	inline static void timerStopHighlighting()
+	{
+		stopHighlighting();
+	}
+private:
+	bool doesShortcutMatch(const ModelShortcut* shortcut, QKeyEvent* event) const;
+	bool doesShortcutMatch(const ModelShortcut* shortcutA, const ModelShortcut* shortcutB) const;
+
+
+	bool m_isHighlighted;
+
+	ModelShortcut m_lastShortcut;
+	unsigned int m_lastShortcutCounter;
+
+	static std::unique_ptr<QColor> s_highlightColor;
+	static QTimer* s_highlightTimer;
+	static SimpleTextFloat* s_simpleTextFloat;
+	static std::list<InteractiveModelView*> s_interactiveWidgets;
+};
+
+} // namespace lmms::gui
+
+#endif // LMMS_GUI_INTERACTIVE_MODEL_VIEW_H