ecvShortcutDecorator Class Reference

Decorate a widget by highlighting its frame when keyboard shortcuts are active. More...

#include <ecvShortcutDecorator.h>

Inheritance diagram for ecvShortcutDecorator:

Collaboration diagram for ecvShortcutDecorator:

Public Types
using	Superclass = QObject

Public Slots
virtual void	setEnabled (bool enable, bool refocusWhenEnabling=false)

Public Member Functions
	ecvShortcutDecorator (QFrame *parent)
	~ecvShortcutDecorator () override=default
void	addShortcut (ecvModalShortcut *shortcut)
bool	isEnabled () const

Protected Slots
virtual void	onShortcutEnabled ()
virtual void	onShortcutDisabled ()

Protected Member Functions
QFrame *	decoratedFrame () const
bool	eventFilter (QObject *obj, QEvent *event) override
void	markFrame (bool active, const QColor &frameColor)

Protected Attributes
QList< QPointer< ecvModalShortcut > >	m_shortcuts
bool	m_pressed
bool	m_silent
	Prevent recursive signaling inside onShortcutEnabled/onShortcutDisabled. More...
bool	m_allowRefocus

Detailed Description

Decorate a widget by highlighting its frame when keyboard shortcuts are active.

This class provides visual feedback for widgets that have modal shortcuts attached. Features:

• Highlights the widget's border when shortcuts are active
• Allows users to click on the border to activate/deactivate shortcuts
• Monitors mouse enter/exit events for visual feedback
• Manages multiple shortcuts as a group (all enabled/disabled together)

Usage:

auto* decorator = new ecvShortcutDecorator(myWidget);
auto* shortcut = ecvKeySequences::instance().addModalShortcut(...);
decorator->addShortcut(shortcut);

Definition at line 41 of file ecvShortcutDecorator.h.

Member Typedef Documentation

Superclass

using ecvShortcutDecorator::Superclass = QObject

Definition at line 45 of file ecvShortcutDecorator.h.

Constructor & Destructor Documentation

ecvShortcutDecorator()

ecvShortcutDecorator::ecvShortcutDecorator ( QFrame *  parent )

explicit

Create a decorator for the given widget.

Parameters

parent

The widget to decorate (must be a QFrame or subclass)

Definition at line 21 of file ecvShortcutDecorator.cpp.

References CVLog::Error(), and markFrame().

~ecvShortcutDecorator()

ecvShortcutDecorator::~ecvShortcutDecorator ( )

overridedefault

Destructor.

Member Function Documentation

addShortcut()

void ecvShortcutDecorator::addShortcut

(

ecvModalShortcut *

shortcut

)

Add a shortcut to this decorator. All shortcuts attached to a decorator are enabled/disabled as a group.

Parameters

shortcut

The modal shortcut to attach

Definition at line 41 of file ecvShortcutDecorator.cpp.

References ecvModalShortcut::disabled(), ecvModalShortcut::enabled(), ecvModalShortcut::keySequence(), m_shortcuts, onShortcutDisabled(), onShortcutEnabled(), CVLog::Print(), and CVLog::Warning().

decoratedFrame()

QFrame * ecvShortcutDecorator::decoratedFrame ( ) const

protected

Get the decorated widget as a QFrame.

Definition at line 138 of file ecvShortcutDecorator.cpp.

Referenced by eventFilter(), markFrame(), and onShortcutEnabled().

eventFilter()

bool ecvShortcutDecorator::eventFilter ( QObject *  obj, QEvent *  event  )

overrideprotected

Monitor mouse events to allow users to enable/disable shortcuts.

Definition at line 143 of file ecvShortcutDecorator.cpp.

References decoratedFrame(), event, frame, ecvKeySequences::instance(), isEnabled(), m_pressed, m_shortcuts, markFrame(), ecvKeySequences::reorder(), and setEnabled().

isEnabled()

bool ecvShortcutDecorator::isEnabled

(

)

const

Check if any attached shortcuts are enabled.

Returns

True if at least one shortcut is enabled

Definition at line 64 of file ecvShortcutDecorator.cpp.

References m_shortcuts.

Referenced by eventFilter().

markFrame()

void ecvShortcutDecorator::markFrame ( bool  active, const QColor &  frameColor  )

protected

Show/hide and color the frame border.

Parameters

active	True if the shortcut is active
frameColor	The color to use for the border

Definition at line 197 of file ecvShortcutDecorator.cpp.

References decoratedFrame(), and frame.

Referenced by ecvShortcutDecorator(), eventFilter(), onShortcutDisabled(), and onShortcutEnabled().

onShortcutDisabled

void ecvShortcutDecorator::onShortcutDisabled ( )

protectedvirtualslot

Called when any shortcut is disabled. Ensures all shortcuts are disabled and marks the widget as inactive.

Definition at line 105 of file ecvShortcutDecorator.cpp.

References m_shortcuts, m_silent, and markFrame().

Referenced by addShortcut(), and setEnabled().

onShortcutEnabled

void ecvShortcutDecorator::onShortcutEnabled ( )

protectedvirtualslot

Called when any shortcut is enabled. Ensures all shortcuts are enabled and marks the widget as active.

Definition at line 81 of file ecvShortcutDecorator.cpp.

References decoratedFrame(), frame, m_allowRefocus, m_shortcuts, m_silent, and markFrame().

Referenced by addShortcut(), and setEnabled().

setEnabled

void ecvShortcutDecorator::setEnabled ( bool  enable, bool  refocusWhenEnabling = false  )

virtualslot

Enable or disable all attached shortcuts.

Parameters

enable	True to enable, false to disable
refocusWhenEnabling	If true, focus will shift to the context widget

Definition at line 125 of file ecvShortcutDecorator.cpp.

References m_allowRefocus, onShortcutDisabled(), and onShortcutEnabled().

Referenced by eventFilter().

Member Data Documentation

m_allowRefocus

bool ecvShortcutDecorator::m_allowRefocus

protected

Should shortcuts set the keyboard focus to their context widget? This is set to true when users explicitly click on the widget frame and false otherwise.

Definition at line 130 of file ecvShortcutDecorator.h.

Referenced by onShortcutEnabled(), and setEnabled().

m_pressed

bool ecvShortcutDecorator::m_pressed

protected

Note when the user has pressed the mouse inside the widget and not released it.

Definition at line 122 of file ecvShortcutDecorator.h.

Referenced by eventFilter().

m_shortcuts

QList<QPointer<ecvModalShortcut> > ecvShortcutDecorator::m_shortcuts

protected

All the shortcuts that decorate the widget. These will all be enabled/disabled en banc.

Definition at line 118 of file ecvShortcutDecorator.h.

Referenced by addShortcut(), eventFilter(), isEnabled(), onShortcutDisabled(), and onShortcutEnabled().

m_silent

bool ecvShortcutDecorator::m_silent

protected

Prevent recursive signaling inside onShortcutEnabled/onShortcutDisabled.

Definition at line 125 of file ecvShortcutDecorator.h.

Referenced by onShortcutDisabled(), and onShortcutEnabled().

---

The documentation for this class was generated from the following files:

• /root/ACloudViewer/libs/CV_db/include/Shortcuts/ecvShortcutDecorator.h
• /root/ACloudViewer/libs/CV_db/src/Shortcuts/ecvShortcutDecorator.cpp