digiKam
Classes | Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | List of all members
Digikam::AssignNameWidget Class Reference
+ Inheritance diagram for Digikam::AssignNameWidget:

Classes

class  Private
 

Public Types

enum  LayoutMode { InvalidLayout , FullLine , TwoLines , Compact }
 
enum  Mode {
  InvalidMode , UnconfirmedEditMode , ConfirmedMode , ConfirmedEditMode ,
  IgnoredMode
}
 
enum  TagEntryWidgetMode { InvalidTagEntryWidgetMode , AddTagsComboBoxMode , AddTagsLineEditMode }
 
enum  VisualStyle { InvalidVisualStyle , StyledFrame , TranslucentDarkRound , TranslucentThemedFrameless }
 

Public Slots

void setCurrentFace (const FaceTagsIface &face)
 
void setCurrentTag (int tagId)
 
void setCurrentTag (TAlbum *album)
 
void setParentTag (TAlbum *album)
 
void setUserData (const ItemInfo &info, const QVariant &faceIdentifier=QVariant())
 

Signals

void assigned (const TaggingAction &action, const ItemInfo &info, const QVariant &faceIdentifier)
 
void ignored (const ItemInfo &info, const QVariant &faceIdentifier)
 
void ignoredClicked (const ItemInfo &info, const QVariant &faceIdentifier)
 
void labelClicked (const ItemInfo &info, const QVariant &faceIdentifier)
 
void rejected (const ItemInfo &info, const QVariant &faceIdentifier)
 
void selected (const TaggingAction &action, const ItemInfo &info, const QVariant &faceIdentifier)
 

Public Member Functions

 AssignNameWidget (QWidget *const parent=nullptr)
 
AddTagsComboBox * comboBox () const
 The combo box or line edit in use, if any. More...
 
QVariant faceIdentifier () const
 
ItemInfo info () const
 
LayoutMode layoutMode () const
 
AddTagsLineEdit * lineEdit () const
 
Mode mode () const
 
void setAlbumModels (TagModel *const model, TagPropertiesFilterModel *const filteredModel, CheckableAlbumFilterModel *const filterModel)
 
void setDefaultModel ()
 
void setLayoutMode (LayoutMode mode)
 
void setMode (Mode mode)
 
void setTagEntryWidgetMode (TagEntryWidgetMode mode)
 
void setVisualStyle (VisualStyle style)
 
TagEntryWidgetMode tagEntryWidgetMode () const
 
VisualStyle visualStyle () const
 
 ~AssignNameWidget () override
 

Protected Slots

void slotActionActivated (const TaggingAction &action)
 
void slotActionSelected (const TaggingAction &action)
 
void slotConfirm ()
 
void slotIgnore ()
 
void slotIgnoredClicked ()
 
void slotLabelClicked ()
 
void slotReject ()
 

Protected Member Functions

void keyPressEvent (QKeyEvent *e) override
 
void showEvent (QShowEvent *e) override
 

Properties

LayoutMode layoutMode
 
Mode mode
 
TagEntryWidgetMode tagEntryWidgetMode
 
VisualStyle visualStyle
 

Member Enumeration Documentation

◆ LayoutMode

enum Digikam::AssignNameWidget::LayoutMode
Enumerator
InvalidLayout 
FullLine 
TwoLines 
Compact 

◆ Mode

enum Digikam::AssignNameWidget::Mode
Enumerator
InvalidMode 
UnconfirmedEditMode 
ConfirmedMode 
ConfirmedEditMode 
IgnoredMode 

◆ TagEntryWidgetMode

enum Digikam::AssignNameWidget::TagEntryWidgetMode
Enumerator
InvalidTagEntryWidgetMode 
AddTagsComboBoxMode 
AddTagsLineEditMode 

◆ VisualStyle

enum Digikam::AssignNameWidget::VisualStyle
Enumerator
InvalidVisualStyle 
StyledFrame 
TranslucentDarkRound 
TranslucentThemedFrameless 

Constructor & Destructor Documentation

◆ AssignNameWidget()

Digikam::AssignNameWidget::AssignNameWidget ( QWidget *const  parent = nullptr)
explicit

Please take care: you must set all four modes before usage!

References setVisualStyle(), and StyledFrame.

◆ ~AssignNameWidget()

Digikam::AssignNameWidget::~AssignNameWidget ( )
override

Member Function Documentation

◆ assigned

void Digikam::AssignNameWidget::assigned ( const TaggingAction &  action,
const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

A name has been assigned to the associated face. This can be an existing tag, or a new tag, as described by TaggingAction. For convenience, info() and faceIdentifier() are provided.

Referenced by slotActionActivated(), and slotConfirm().

◆ comboBox()

AddTagsComboBox * Digikam::AssignNameWidget::comboBox ( ) const

The combo box or line edit in use, if any.

References Digikam::AssignNameWidget::Private::comboBox.

Referenced by Digikam::FaceGroup::focusRandomFace(), and Digikam::AssignNameWidget::Private::updateContents().

◆ faceIdentifier()

QVariant Digikam::AssignNameWidget::faceIdentifier ( ) const

References Digikam::AssignNameWidget::Private::faceIdentifier.

Referenced by setUserData(), Digikam::AssignNameWidget::Private::updateIgnoreButton(), and Digikam::AssignNameWidget::Private::updateRejectButtonTooltip().

◆ ignored

void Digikam::AssignNameWidget::ignored ( const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

Referenced by slotIgnore().

◆ ignoredClicked

void Digikam::AssignNameWidget::ignoredClicked ( const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

In IgnoredMode, this signal is emitted when the user clicked on the label

Referenced by slotIgnoredClicked().

◆ info()

ItemInfo Digikam::AssignNameWidget::info ( ) const

References Digikam::AssignNameWidget::Private::info.

Referenced by setUserData().

◆ keyPressEvent()

void Digikam::AssignNameWidget::keyPressEvent ( QKeyEvent *  e)
overrideprotected

References slotReject().

◆ labelClicked

void Digikam::AssignNameWidget::labelClicked ( const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

In ConfirmedMode, this signal is emitted when the user clicked on the label

Referenced by slotLabelClicked().

◆ layoutMode()

AssignNameWidget::LayoutMode Digikam::AssignNameWidget::layoutMode ( ) const

References Digikam::AssignNameWidget::Private::layoutMode.

◆ lineEdit()

AddTagsLineEdit * Digikam::AssignNameWidget::lineEdit ( ) const

References Digikam::AssignNameWidget::Private::lineEdit.

Referenced by Digikam::AssignNameOverlay::setFocusOnWidget(), and Digikam::AssignNameWidget::Private::updateContents().

◆ mode()

AssignNameWidget::Mode Digikam::AssignNameWidget::mode ( ) const

References Digikam::AssignNameWidget::Private::mode.

◆ rejected

void Digikam::AssignNameWidget::rejected ( const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

The suggestion has been rejected and the face will be moved to Unknown. For convenience, info() and faceIdentifier() are provided.

Referenced by slotReject().

◆ selected

void Digikam::AssignNameWidget::selected ( const TaggingAction &  action,
const ItemInfo &  info,
const QVariant &  faceIdentifier 
)
signal

An action has been selected. This purely signals user interaction, no fixed decision - mouse hover may be enough to emit this signal. The action may be invalid (user switched back to empty selection).

Referenced by slotActionSelected().

◆ setAlbumModels()

void Digikam::AssignNameWidget::setAlbumModels ( TagModel *const  model,
TagPropertiesFilterModel *const  filteredModel,
CheckableAlbumFilterModel *const  filterModel 
)

Set the tag model to use for completion.

References Digikam::AssignNameWidget::Private::comboBox, Digikam::ApplicationSettings::instance(), Digikam::AssignNameWidget::Private::lineEdit, Digikam::TagPropertiesFilterModel::listOnlyTagsWithProperty(), Digikam::AssignNameWidget::Private::modelsGiven, Digikam::TagPropertyName::person(), Digikam::AddTagsLineEdit::setAlbumModels(), Digikam::AddTagsComboBox::setAlbumModels(), Digikam::ApplicationSettings::showOnlyPersonTagsInPeopleSidebar(), Digikam::AssignNameWidget::Private::tagFilteredModel, Digikam::AssignNameWidget::Private::tagFilterModel, and Digikam::AssignNameWidget::Private::tagModel.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget(), and setDefaultModel().

◆ setCurrentFace

void Digikam::AssignNameWidget::setCurrentFace ( const FaceTagsIface &  face)
slot

References Digikam::AlbumManager::findTAlbum(), Digikam::AlbumManager::instance(), Digikam::FaceTagsIface::isIgnoredName(), Digikam::FaceTagsIface::isNull(), Digikam::FaceTagsIface::isUnknownName(), setCurrentTag(), and Digikam::FaceTagsIface::tagId().

Referenced by Digikam::FaceItem::updateCurrentTag(), and Digikam::AssignNameOverlay::updateFace().

◆ setCurrentTag [1/2]

void Digikam::AssignNameWidget::setCurrentTag ( int  tagId)
slot

Sets the suggested (UnconfirmedEditMode) or assigned (ConfirmedMode) tag to be displayed.

References Digikam::AlbumManager::instance().

Referenced by setCurrentFace().

◆ setCurrentTag [2/2]

void Digikam::AssignNameWidget::setCurrentTag ( TAlbum *  album)
slot

References Digikam::AssignNameWidget::Private::clickLabel, Digikam::AssignNameWidget::Private::currentTag, IgnoredMode, Digikam::AssignNameWidget::Private::mode, and Digikam::AssignNameWidget::Private::updateContents().

◆ setDefaultModel()

void Digikam::AssignNameWidget::setDefaultModel ( )

References setAlbumModels().

◆ setLayoutMode()

void Digikam::AssignNameWidget::setLayoutMode ( LayoutMode  mode)

References Digikam::AssignNameWidget::Private::layoutMode, mode, Digikam::AssignNameWidget::Private::updateContents(), and Digikam::AssignNameWidget::Private::updateModes().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

◆ setMode()

void Digikam::AssignNameWidget::setMode ( Mode  mode)

Reject tooltip should be updated even if the same mode is passed, because Unconfirmed and Unknown Faces have the same mode but different Tooltips.

References Compact, Digikam::AssignNameWidget::Private::layoutMode, mode, Digikam::AssignNameWidget::Private::mode, UnconfirmedEditMode, Digikam::AssignNameWidget::Private::updateContents(), Digikam::AssignNameWidget::Private::updateModes(), and Digikam::AssignNameWidget::Private::updateRejectButtonTooltip().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget(), and setUserData().

◆ setParentTag

void Digikam::AssignNameWidget::setParentTag ( TAlbum *  album)
slot

Set a parent tag for suggesting a parent tag for a new tag, and a default action.

References Digikam::AssignNameWidget::Private::comboBox, Digikam::AssignNameWidget::Private::lineEdit, Digikam::AssignNameWidget::Private::parentTag, Digikam::AddTagsLineEdit::setParentTag(), and Digikam::AddTagsComboBox::setParentTag().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

◆ setTagEntryWidgetMode()

void Digikam::AssignNameWidget::setTagEntryWidgetMode ( TagEntryWidgetMode  mode)

References mode, Digikam::AssignNameWidget::Private::updateContents(), Digikam::AssignNameWidget::Private::updateModes(), and Digikam::AssignNameWidget::Private::widgetMode.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

◆ setUserData

void Digikam::AssignNameWidget::setUserData ( const ItemInfo &  info,
const QVariant &  faceIdentifier = QVariant() 
)
slot

The identifying information emitted with the signals

Ignored faces are drawn over with a different overlay, as Reject button should be disabled.

References ConfirmedMode, Digikam::FaceTagsIface::ConfirmedName, faceIdentifier(), Digikam::AssignNameWidget::Private::faceIdentifier, Digikam::FaceTagsIface::fromVariant(), IgnoredMode, Digikam::FaceTagsIface::IgnoredName, info(), Digikam::AssignNameWidget::Private::info, setMode(), Digikam::FaceTagsIface::type(), and UnconfirmedEditMode.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget(), and Digikam::AssignNameOverlay::updateFace().

◆ setVisualStyle()

void Digikam::AssignNameWidget::setVisualStyle ( VisualStyle  style)

References Digikam::AssignNameWidget::Private::updateModes(), and Digikam::AssignNameWidget::Private::visualStyle.

Referenced by AssignNameWidget(), and Digikam::FaceGroup::Private::createAssignNameWidget().

◆ showEvent()

void Digikam::AssignNameWidget::showEvent ( QShowEvent *  e)
overrideprotected

References Digikam::AssignNameWidget::Private::comboBox, ConfirmedEditMode, Digikam::AddTagsComboBox::lineEdit(), Digikam::AssignNameWidget::Private::lineEdit, Digikam::AssignNameWidget::Private::mode, and UnconfirmedEditMode.

◆ slotActionActivated

void Digikam::AssignNameWidget::slotActionActivated ( const TaggingAction &  action)
protectedslot

References assigned(), Digikam::AssignNameWidget::Private::faceIdentifier, and Digikam::AssignNameWidget::Private::info.

◆ slotActionSelected

void Digikam::AssignNameWidget::slotActionSelected ( const TaggingAction &  action)
protectedslot

References Digikam::AssignNameWidget::Private::confirmButton, Digikam::AssignNameWidget::Private::faceIdentifier, Digikam::AssignNameWidget::Private::info, Digikam::TaggingAction::isValid(), and selected().

◆ slotConfirm

void Digikam::AssignNameWidget::slotConfirm ( )
protectedslot

References assigned(), Digikam::AssignNameWidget::Private::comboBox, Digikam::AddTagsComboBox::currentTaggingAction(), Digikam::AddTagsLineEdit::currentTaggingAction(), Digikam::AssignNameWidget::Private::faceIdentifier, Digikam::AssignNameWidget::Private::info, and Digikam::AssignNameWidget::Private::lineEdit.

◆ slotIgnore

void Digikam::AssignNameWidget::slotIgnore ( )
protectedslot

References Digikam::AssignNameWidget::Private::faceIdentifier, ignored(), and Digikam::AssignNameWidget::Private::info.

Referenced by Digikam::AssignNameWidget::Private::updateIgnoreButton().

◆ slotIgnoredClicked

void Digikam::AssignNameWidget::slotIgnoredClicked ( )
protectedslot

References Digikam::AssignNameWidget::Private::faceIdentifier, ignoredClicked(), and Digikam::AssignNameWidget::Private::info.

◆ slotLabelClicked

void Digikam::AssignNameWidget::slotLabelClicked ( )
protectedslot

References Digikam::AssignNameWidget::Private::faceIdentifier, Digikam::AssignNameWidget::Private::info, and labelClicked().

◆ slotReject

void Digikam::AssignNameWidget::slotReject ( )
protectedslot

References Digikam::AssignNameWidget::Private::faceIdentifier, Digikam::AssignNameWidget::Private::info, and rejected().

Referenced by keyPressEvent().

◆ tagEntryWidgetMode()

AssignNameWidget::TagEntryWidgetMode Digikam::AssignNameWidget::tagEntryWidgetMode ( ) const

References Digikam::AssignNameWidget::Private::widgetMode.

◆ visualStyle()

AssignNameWidget::VisualStyle Digikam::AssignNameWidget::visualStyle ( ) const

References Digikam::AssignNameWidget::Private::visualStyle.

Property Documentation

◆ layoutMode

LayoutMode Digikam::AssignNameWidget::layoutMode
readwrite

Referenced by Digikam::AssignNameWidget::Private::isValid().

◆ mode

Mode Digikam::AssignNameWidget::mode
readwrite

Referenced by Digikam::AssignNameWidget::Private::isValid(), setLayoutMode(), setMode(), setTagEntryWidgetMode(), Digikam::AssignNameWidgetStates::slotStateChanged(), Digikam::FaceItem::switchMode(), and Digikam::AssignNameWidget::Private::updateContents().

◆ tagEntryWidgetMode

TagEntryWidgetMode Digikam::AssignNameWidget::tagEntryWidgetMode
readwrite

◆ visualStyle

VisualStyle Digikam::AssignNameWidget::visualStyle
readwrite

Referenced by Digikam::AssignNameWidget::Private::isValid().

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