Inheritance diagram for Digikam::PersistentWidgetDelegateOverlay:

Public Slots
void	enterPersistentMode ()

void	leavePersistentMode ()

void	setPersistent (bool persistent)

void	storeFocus ()

Signals
void	hideNotification ()

void	requestNotification (const QModelIndex &index, const QString &message)

void	update (const QModelIndex &index)

Public Member Functions
virtual bool	acceptsDelegate (QAbstractItemDelegate *) const

QAbstractItemDelegate *	delegate () const

bool	isPersistent () const

virtual void	mouseMoved (QMouseEvent *e, const QRect &visualRect, const QModelIndex &index)

virtual void	paint (QPainter *p, const QStyleOptionViewItem &option, const QModelIndex &index)

	PersistentWidgetDelegateOverlay (QObject *const parent)

void	setActive (bool active) override

void	setDelegate (QAbstractItemDelegate *delegate)

void	setView (QAbstractItemView *view)

QAbstractItemView *	view () const

	~PersistentWidgetDelegateOverlay () override

Protected Slots
virtual void	visualChange ()

Protected Member Functions
QList< QModelIndex >	affectedIndexes (const QModelIndex &index) const

bool	affectsMultiple (const QModelIndex &index) const

virtual bool	checkIndex (const QModelIndex &index) const

bool	checkIndexOnEnter (const QModelIndex &index) const

virtual QWidget *	createWidget ()=0

bool	eventFilter (QObject obj, QEvent event) override

void	hide () override

QModelIndex	index () const

virtual QString	notifyMultipleMessage (const QModelIndex &, int number)

int	numberOfAffectedIndexes (const QModelIndex &index) const

QWidget *	parentWidget () const

void	restoreFocus ()

virtual void	setFocusOnWidget ()

virtual void	showOnIndex (const QModelIndex &index)
	see slotEntered() More...

void	slotEntered (const QModelIndex &index) override

void	slotLayoutChanged () override

void	slotReset () override

void	slotRowsRemoved (const QModelIndex &parent, int start, int end) override

void	slotViewportEntered () override

bool	viewHasMultiSelection () const

void	viewportLeaveEvent (QObject obj, QEvent event) override

virtual void	widgetEnterEvent ()

void	widgetEnterNotifyMultiple (const QModelIndex &index)

virtual void	widgetLeaveEvent ()

void	widgetLeaveNotifyMultiple ()

Protected Attributes
QAbstractItemDelegate *	m_delegate

bool	m_mouseButtonPressedOnWidget

QAbstractItemView *	m_view

QWidget *	m_widget

Constructor & Destructor Documentation

◆ PersistentWidgetDelegateOverlay()

Digikam::PersistentWidgetDelegateOverlay::PersistentWidgetDelegateOverlay ( QObject *const parent )

explicit

This class offers additional / modified behavior: When a "persistent" mode is entered, it will not move by mouse hover, but stay and only move on mouse click. If the overlay widget had focus, it will be restored on show.

◆ ~PersistentWidgetDelegateOverlay()

Digikam::PersistentWidgetDelegateOverlay::~PersistentWidgetDelegateOverlay ( )

override

Member Function Documentation

◆ acceptsDelegate()

virtual bool Digikam::ItemDelegateOverlay::acceptsDelegate ( QAbstractItemDelegate * ) const

inlinevirtualinherited

Referenced by Digikam::ItemDelegateOverlayContainer::installOverlay().

◆ affectedIndexes()

QList< QModelIndex > Digikam::ItemDelegateOverlay::affectedIndexes ( const QModelIndex & index ) const

protectedinherited

References Digikam::ItemDelegateOverlay::affectsMultiple(), and Digikam::ItemDelegateOverlay::view().

Referenced by Digikam::AssignNameOverlay::slotAssigned(), Digikam::FaceRejectionOverlay::slotClicked(), Digikam::AssignNameOverlay::slotIgnored(), Digikam::ItemRatingOverlay::slotRatingChanged(), Digikam::ImportRatingOverlay::slotRatingChanged(), Digikam::AssignNameOverlay::slotRejected(), and Digikam::AssignNameOverlay::slotUnknown().

◆ affectsMultiple()

bool Digikam::ItemDelegateOverlay::affectsMultiple ( const QModelIndex & index ) const

protectedinherited

For the context that an overlay can affect multiple items: Assuming the currently overlayed index is given. Will an operation affect only the single item, or multiple? If multiple, retrieve the affected selection.

References Digikam::ItemDelegateOverlay::view(), and Digikam::ItemDelegateOverlay::viewHasMultiSelection().

Referenced by Digikam::ItemDelegateOverlay::affectedIndexes(), Digikam::ItemDelegateOverlay::numberOfAffectedIndexes(), and Digikam::AbstractWidgetDelegateOverlay::widgetEnterNotifyMultiple().

◆ checkIndex()

bool Digikam::AbstractWidgetDelegateOverlay::checkIndex ( const QModelIndex & index ) const

protectedvirtualinherited

Return true here if you want to show the overlay for the given index. The default implementation returns true.

Reimplemented in Digikam::ImportRotateOverlay, Digikam::ImportDownloadOverlay, Digikam::ImportLockOverlay, Digikam::ImportCoordinatesOverlay, ShowFoto::ShowfotoCoordinatesOverlay, Digikam::ActionVersionsOverlay, Digikam::ShowHideVersionsOverlay, Digikam::ItemRotateOverlay, Digikam::ItemFullScreenOverlay, Digikam::ItemCoordinatesOverlay, Digikam::GroupIndicatorOverlay, Digikam::FaceRejectionOverlay, and Digikam::AssignNameOverlay.

Referenced by Digikam::AbstractWidgetDelegateOverlay::checkIndexOnEnter(), and Digikam::HoverButtonDelegateOverlay::slotEntered().

◆ checkIndexOnEnter()

bool Digikam::AbstractWidgetDelegateOverlay::checkIndexOnEnter ( const QModelIndex & index ) const

protectedinherited

Utility method called from slotEntered

References Digikam::AbstractWidgetDelegateOverlay::checkIndex().

Referenced by Digikam::AbstractWidgetDelegateOverlay::slotEntered(), and slotEntered().

◆ createWidget()

virtual QWidget* Digikam::AbstractWidgetDelegateOverlay::createWidget ( )

protectedpure virtualinherited

Create your widget here. When creating the object, pass parentWidget() as parent widget. Ownership of the object is passed. It will be deleted in setActive(false).

Implemented in Digikam::ImportRatingOverlay, Digikam::ImportDownloadOverlay, Digikam::ImportLockOverlay, Digikam::ImportCoordinatesOverlay, ShowFoto::ShowfotoCoordinatesOverlay, Digikam::HoverButtonDelegateOverlay, Digikam::TagsLineEditOverlay, Digikam::ItemRatingOverlay, Digikam::ItemCoordinatesOverlay, Digikam::GroupIndicatorOverlay, and Digikam::AssignNameOverlay.

Referenced by Digikam::AbstractWidgetDelegateOverlay::setActive().

◆ delegate()

QAbstractItemDelegate * Digikam::ItemDelegateOverlay::delegate ( ) const

inherited

References Digikam::ItemDelegateOverlay::m_delegate.

◆ enterPersistentMode

void Digikam::PersistentWidgetDelegateOverlay::enterPersistentMode ( )

slot

References setPersistent().

Referenced by Digikam::AssignNameOverlay::eventFilter(), and Digikam::AssignNameOverlay::setActive().

◆ eventFilter()

bool Digikam::AbstractWidgetDelegateOverlay::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

overrideprotectedinherited

References Digikam::AbstractWidgetDelegateOverlay::m_mouseButtonPressedOnWidget, Digikam::AbstractWidgetDelegateOverlay::m_widget, Digikam::AbstractWidgetDelegateOverlay::viewportLeaveEvent(), Digikam::AbstractWidgetDelegateOverlay::widgetEnterEvent(), and Digikam::AbstractWidgetDelegateOverlay::widgetLeaveEvent().

Referenced by Digikam::AssignNameOverlay::eventFilter().

◆ hide()

void Digikam::PersistentWidgetDelegateOverlay::hide ( )

overrideprotectedvirtual

Called when the widget shall be hidden (mouse cursor left index, viewport, uninstalled etc.). Default implementation hide()s m_widget.

Reimplemented from Digikam::AbstractWidgetDelegateOverlay.

References Digikam::AbstractWidgetDelegateOverlay::hide(), and Digikam::AbstractWidgetDelegateOverlay::m_widget.

Referenced by Digikam::AssignNameOverlay::hide(), setPersistent(), and slotEntered().

◆ hideNotification

void Digikam::ItemDelegateOverlay::hideNotification ( )

signalinherited

Referenced by Digikam::AbstractWidgetDelegateOverlay::widgetLeaveNotifyMultiple().

◆ index()

QModelIndex Digikam::PersistentWidgetDelegateOverlay::index ( ) const

protected

Referenced by Digikam::AssignNameOverlay::checkIndex(), showOnIndex(), Digikam::AssignNameOverlay::showOnIndex(), Digikam::AssignNameOverlay::slotAssigned(), slotEntered(), Digikam::AssignNameOverlay::slotIgnored(), Digikam::AssignNameOverlay::slotRejected(), Digikam::AssignNameOverlay::slotUnknown(), Digikam::AssignNameOverlay::updateFace(), Digikam::AssignNameOverlay::updatePosition(), and Digikam::AssignNameOverlay::widgetEnterEvent().

◆ isPersistent()

bool Digikam::PersistentWidgetDelegateOverlay::isPersistent ( ) const

Referenced by Digikam::AssignNameOverlay::viewportLeaveEvent().

◆ leavePersistentMode

void Digikam::PersistentWidgetDelegateOverlay::leavePersistentMode ( )

slot

References setPersistent().

Referenced by Digikam::AssignNameOverlay::eventFilter(), setActive(), and Digikam::AssignNameOverlay::setActive().

◆ mouseMoved()

void Digikam::ItemDelegateOverlay::mouseMoved	(	QMouseEvent *	e,
		const QRect &	visualRect,
		const QModelIndex &	index
	)

virtualinherited

Only these two methods are implemented as virtual methods. For all other events, connect to the view's signals. There are a few signals specifically for overlays and all QAbstractItemView standard signals.

Referenced by Digikam::ItemDelegateOverlayContainer::mouseMoved().

◆ notifyMultipleMessage()

QString Digikam::AbstractWidgetDelegateOverlay::notifyMultipleMessage	(	const QModelIndex &	,
		int	number
	)

protectedvirtualinherited

Referenced by Digikam::AbstractWidgetDelegateOverlay::widgetEnterNotifyMultiple().

◆ numberOfAffectedIndexes()

int Digikam::ItemDelegateOverlay::numberOfAffectedIndexes ( const QModelIndex & index ) const

protectedinherited

References Digikam::ItemDelegateOverlay::affectsMultiple(), and Digikam::ItemDelegateOverlay::view().

Referenced by Digikam::AbstractWidgetDelegateOverlay::widgetEnterNotifyMultiple().

◆ paint()

void Digikam::ItemDelegateOverlay::paint	(	QPainter *	p,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)

virtualinherited

Referenced by Digikam::ItemDelegateOverlayContainer::drawOverlays().

◆ parentWidget()

QWidget * Digikam::AbstractWidgetDelegateOverlay::parentWidget ( ) const

protectedinherited

Returns the widget to be used as parent for your widget created in createWidget()

References Digikam::ItemDelegateOverlay::m_view.

Referenced by Digikam::AssignNameOverlay::createWidget(), Digikam::GroupIndicatorOverlay::createWidget(), Digikam::ItemCoordinatesOverlay::createWidget(), Digikam::ItemRatingOverlay::createWidget(), Digikam::TagsLineEditOverlay::createWidget(), ShowFoto::ShowfotoCoordinatesOverlay::createWidget(), Digikam::ImportCoordinatesOverlay::createWidget(), Digikam::ImportLockOverlay::createWidget(), Digikam::ImportDownloadOverlay::createWidget(), and Digikam::ImportRatingOverlay::createWidget().

◆ requestNotification

void Digikam::ItemDelegateOverlay::requestNotification	(	const QModelIndex &	index,
		const QString &	message
	)

signalinherited

Referenced by Digikam::AbstractWidgetDelegateOverlay::widgetEnterNotifyMultiple().

◆ restoreFocus()

void Digikam::PersistentWidgetDelegateOverlay::restoreFocus ( )

protected

References setFocusOnWidget().

Referenced by showOnIndex().

◆ setActive()

void Digikam::PersistentWidgetDelegateOverlay::setActive ( bool active )

overridevirtual

If active is true, this will call createWidget(), initialize the widget for use, and setup connections for the virtual slots. If active is false, this will delete the widget and disconnect all signal from model and view to this object (!)

Reimplemented from Digikam::AbstractWidgetDelegateOverlay.

References leavePersistentMode(), Digikam::ItemDelegateOverlay::m_view, and Digikam::AbstractWidgetDelegateOverlay::setActive().

Referenced by Digikam::AssignNameOverlay::setActive().

◆ setDelegate()

void Digikam::ItemDelegateOverlay::setDelegate ( QAbstractItemDelegate * delegate )

inherited

References Digikam::ItemDelegateOverlay::delegate(), Digikam::ItemDelegateOverlay::m_delegate, and Digikam::ItemDelegateOverlay::visualChange().

Referenced by Digikam::ItemDelegateOverlayContainer::installOverlay(), Digikam::ItemDelegateOverlayContainer::removeAllOverlays(), and Digikam::ItemDelegateOverlayContainer::removeOverlay().

◆ setFocusOnWidget()

void Digikam::PersistentWidgetDelegateOverlay::setFocusOnWidget ( )

protectedvirtual

Reimplement to set the focus on the correct subwidget. Default implementation sets focus on widget()

Reimplemented in Digikam::AssignNameOverlay.

References Digikam::AbstractWidgetDelegateOverlay::m_widget.

Referenced by restoreFocus().

◆ setPersistent

void Digikam::PersistentWidgetDelegateOverlay::setPersistent ( bool persistent )

slot

Enters persistent mode. The overlay is moved because of mouse hover.

References hide(), showOnIndex(), and slotEntered().

Referenced by enterPersistentMode(), leavePersistentMode(), slotLayoutChanged(), slotReset(), slotRowsRemoved(), and viewportLeaveEvent().

◆ setView()

void Digikam::ItemDelegateOverlay::setView ( QAbstractItemView * view )

inherited

References Digikam::ItemDelegateOverlay::m_view, Digikam::ItemDelegateOverlay::update(), and Digikam::ItemDelegateOverlay::view().

Referenced by Digikam::VersionsTreeView::addOverlay(), Digikam::ImportCategorizedView::addOverlay(), Digikam::ItemCategorizedView::addOverlay(), ShowFoto::ShowfotoCategorizedView::addOverlay(), Digikam::ItemDelegateOverlayContainer::removeAllOverlays(), Digikam::ItemCategorizedView::removeOverlay(), Digikam::VersionsTreeView::removeOverlay(), ShowFoto::ShowfotoCategorizedView::removeOverlay(), Digikam::ImportCategorizedView::removeOverlay(), and Digikam::ItemDelegateOverlayContainer::setViewOnAllOverlays().

◆ showOnIndex()

void Digikam::PersistentWidgetDelegateOverlay::showOnIndex ( const QModelIndex & index )

protectedvirtual

see slotEntered()

Reimplemented in Digikam::AssignNameOverlay.

References index(), and restoreFocus().

Referenced by setPersistent(), Digikam::AssignNameOverlay::showOnIndex(), and slotEntered().

◆ slotEntered()

void Digikam::PersistentWidgetDelegateOverlay::slotEntered ( const QModelIndex & index )

overrideprotectedvirtual

Most overlays reimplement this slot to get the starting point for repositioning a widget etc. This class instead provides showOnIndex() which you shall use for this purpose.

Reimplemented from Digikam::AbstractWidgetDelegateOverlay.

References Digikam::AbstractWidgetDelegateOverlay::checkIndexOnEnter(), hide(), index(), Digikam::AbstractWidgetDelegateOverlay::m_widget, and showOnIndex().

Referenced by setPersistent().