digiKam
Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
Digikam::SearchField Class Referenceabstract
+ Inheritance diagram for Digikam::SearchField:

Public Types

enum  WidgetRectType { LabelAndValueWidgetRects , ValueWidgetRectsOnly }
 

Public Member Functions

bool isVisible () override
 
virtual void read (SearchXmlCachingReader &reader)=0
 
virtual void reset ()=0
 
 SearchField (QObject *const parent)
 
void setCategoryLabelVisible (bool visible)
 
void setCategoryLabelVisibleFromPreviousField (SearchField *const previousField)
 
void setFieldName (const QString &fieldName)
 
virtual void setText (const QString &label, const QString &detailLabel)
 
void setup (QGridLayout *const layout, int row=-1)
 
void setVisible (bool visible) override
 
virtual bool supportsField (const QString &fieldName)
 
QList< QRect > widgetRects (WidgetRectType=ValueWidgetRectsOnly) const
 
virtual void write (SearchXmlWriter &writer)=0
 

Static Public Member Functions

static SearchField * createField (const QString &fieldName, SearchFieldGroup *const parent)
 

Protected Slots

void clearButtonClicked ()
 

Protected Member Functions

virtual void setupLabels (QGridLayout *layout, int line)
 
virtual void setupValueWidgets (QGridLayout *layout, int row, int column)=0
 
void setValidValueState (bool valueIsValid)
 
virtual void setValueWidgetsVisible (bool visible)=0
 
virtual QList< QRect > valueWidgetRects () const =0
 

Protected Attributes

bool m_categoryLabelVisible
 
AnimatedClearButton * m_clearButton
 
QLabel * m_detailLabel
 
QLabel * m_label
 
QString m_name
 
bool m_valueIsValid
 

Member Enumeration Documentation

◆ WidgetRectType

enum Digikam::SearchField::WidgetRectType
Enumerator
LabelAndValueWidgetRects 
ValueWidgetRectsOnly 

Constructor & Destructor Documentation

◆ SearchField()

Digikam::SearchField::SearchField ( QObject *const  parent)
explicit

References m_categoryLabelVisible, m_clearButton, m_detailLabel, m_label, and m_valueIsValid.

Member Function Documentation

◆ clearButtonClicked

void Digikam::SearchField::clearButtonClicked ( )
protectedslot

References reset().

Referenced by setup().

◆ createField()

SearchField * Digikam::SearchField::createField ( const QString &  fieldName,
SearchFieldGroup *const  parent 
)
static

References Digikam::DatabaseItem::Audio, Digikam::DImg::CIELAB, Digikam::DImg::CMYK, Digikam::DImg::COLORMODELRAW, Digikam::DImg::colorModelToString(), Digikam::DImg::COLORMODELUNKNOWN, Digikam::SearchFieldRangeDate::DateTime, Digikam::CoreDbAccess::db(), Digikam::SearchFieldRangeInt::enableFractionMagic(), Digikam::MetadataInfo::ExposureMode, Digikam::MetadataInfo::ExposureProgram, Digikam::MetadataInfo::FlashMode, Digikam::ApplicationSettings::getAlbumCategoryNames(), Digikam::CoreDB::getListFromImageMetadata(), Digikam::DImg::GRAYSCALE, Digikam::DatabaseItem::Image, Digikam::DImg::INDEXED, Digikam::ApplicationSettings::instance(), Digikam::DatabaseFields::Lens, Digikam::DatabaseFields::Make, Digikam::MetadataInfo::MeteringMode, Digikam::DatabaseFields::Model, Digikam::DImg::MONOCHROME, Digikam::MetadataInfo::Orientation, Digikam::DMetadata::possibleValuesForEnumField(), Digikam::DImg::RGB, Digikam::SearchFieldRangeDate::setBetweenText(), Digikam::SearchFieldRangeInt::setBetweenText(), Digikam::SearchFieldRangeDouble::setBetweenText(), Digikam::SearchFieldRating::setBetweenText(), Digikam::SearchFieldRangeDouble::setBoundary(), Digikam::SearchFieldRangeInt::setBoundary(), Digikam::SearchFieldChoice::setChoice(), Digikam::SearchFieldRangeDouble::setFactor(), setFieldName(), Digikam::SearchFieldCheckBox::setLabel(), Digikam::SearchFieldRangeDouble::setNoValueText(), Digikam::SearchFieldRangeInt::setNumberPrefixAndSuffix(), Digikam::SearchFieldRangeDouble::setNumberPrefixAndSuffix(), Digikam::SearchFieldRangeDouble::setSingleSteps(), Digikam::SearchFieldRangeInt::setSingleSteps(), Digikam::SearchFieldRangeDouble::setSuggestedInitialValue(), Digikam::SearchFieldRangeInt::setSuggestedInitialValue(), Digikam::SearchFieldRangeDouble::setSuggestedValues(), Digikam::SearchFieldRangeInt::setSuggestedValues(), setText(), Digikam::ItemPropertiesTab::shortenedMakeInfo(), Digikam::ItemPropertiesTab::shortenedModelInfo(), Digikam::MetadataInfo::SubjectDistanceCategory, Digikam::SearchFieldAlbum::TypeAlbum, Digikam::SearchFieldAlbum::TypeTag, Digikam::DatabaseItem::Video, Digikam::DMetadata::VIDEOCOLORMODEL_BT601, Digikam::DMetadata::VIDEOCOLORMODEL_BT709, Digikam::DMetadata::VIDEOCOLORMODEL_OTHER, Digikam::DMetadata::VIDEOCOLORMODEL_SRGB, Digikam::DMetadata::videoColorModelToString(), Digikam::MetadataInfo::WhiteBalance, and Digikam::DImg::YCBCR.

Referenced by Digikam::SearchGroup::setup().

◆ isVisible()

bool Digikam::SearchField::isVisible ( )
overridevirtual

Implements Digikam::VisibilityObject.

References m_detailLabel.

Referenced by Digikam::SearchFieldGroup::areaOfMarkedFields().

◆ read()

virtual void Digikam::SearchField::read ( SearchXmlCachingReader &  reader)
pure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldPageOrientation, Digikam::SearchFieldColorDepth, Digikam::SearchFieldCheckBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, Digikam::SearchFieldKeyword, and Digikam::SearchFieldText.

Referenced by Digikam::SearchGroup::read().

◆ reset()

virtual void Digikam::SearchField::reset ( )
pure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldCheckBox, Digikam::SearchFieldComboBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, and Digikam::SearchFieldText.

Referenced by clearButtonClicked(), and Digikam::SearchFieldGroup::reset().

◆ setCategoryLabelVisible()

void Digikam::SearchField::setCategoryLabelVisible ( bool  visible)

References m_categoryLabelVisible, m_detailLabel, and m_label.

Referenced by setCategoryLabelVisibleFromPreviousField().

◆ setCategoryLabelVisibleFromPreviousField()

void Digikam::SearchField::setCategoryLabelVisibleFromPreviousField ( SearchField *const  previousField)

References m_label, and setCategoryLabelVisible().

Referenced by Digikam::SearchFieldGroup::addField().

◆ setFieldName()

void Digikam::SearchField::setFieldName ( const QString &  fieldName)

References m_name.

Referenced by createField().

◆ setText()

void Digikam::SearchField::setText ( const QString &  label,
const QString &  detailLabel 
)
virtual

References m_detailLabel, and m_label.

Referenced by createField().

◆ setup()

void Digikam::SearchField::setup ( QGridLayout *const  layout,
int  row = -1 
)

References clearButtonClicked(), m_clearButton, Digikam::AnimatedClearButton::setPixmap(), setupLabels(), setupValueWidgets(), and Digikam::AnimatedClearButton::stayVisibleWhenAnimatedOut().

Referenced by Digikam::SearchFieldGroup::addField().

◆ setupLabels()

void Digikam::SearchField::setupLabels ( QGridLayout *  layout,
int  line 
)
protectedvirtual

References m_detailLabel, and m_label.

Referenced by setup().

◆ setupValueWidgets()

virtual void Digikam::SearchField::setupValueWidgets ( QGridLayout *  layout,
int  row,
int  column 
)
protectedpure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldPageOrientation, Digikam::SearchFieldColorDepth, Digikam::SearchFieldCheckBox, Digikam::SearchFieldComboBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, and Digikam::SearchFieldText.

Referenced by setup().

◆ setValidValueState()

void Digikam::SearchField::setValidValueState ( bool  valueIsValid)
protected

References Digikam::AnimatedClearButton::animateVisible(), m_clearButton, and m_valueIsValid.

Referenced by Digikam::SearchFieldRating::firstValueChanged(), Digikam::SearchFieldComboBox::indexChanged(), Digikam::SearchFieldRating::secondValueChanged(), Digikam::SearchFieldMonthDay::slotIndexChanged(), Digikam::SearchFieldCheckBox::slotToggled(), Digikam::SearchFieldChoice::updateComboText(), Digikam::SearchFieldAlbum::updateState(), Digikam::SearchFieldLabels::updateState(), Digikam::SearchFieldRangeInt::valueChanged(), Digikam::SearchFieldRangeDouble::valueChanged(), Digikam::SearchFieldRangeDate::valueChanged(), and Digikam::SearchFieldText::valueChanged().

◆ setValueWidgetsVisible()

virtual void Digikam::SearchField::setValueWidgetsVisible ( bool  visible)
protectedpure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldCheckBox, Digikam::SearchFieldComboBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, and Digikam::SearchFieldText.

Referenced by setVisible().

◆ setVisible()

void Digikam::SearchField::setVisible ( bool  visible)
overridevirtual

Implements Digikam::VisibilityObject.

References m_categoryLabelVisible, m_clearButton, m_detailLabel, m_label, Digikam::AnimatedClearButton::setShallBeShown(), and setValueWidgetsVisible().

◆ supportsField()

bool Digikam::SearchField::supportsField ( const QString &  fieldName)
virtual

References m_name.

Referenced by Digikam::SearchFieldGroup::fieldForName().

◆ valueWidgetRects()

virtual QList<QRect> Digikam::SearchField::valueWidgetRects ( ) const
protectedpure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldCheckBox, Digikam::SearchFieldComboBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, and Digikam::SearchFieldText.

Referenced by widgetRects().

◆ widgetRects()

QList< QRect > Digikam::SearchField::widgetRects ( WidgetRectType  type = ValueWidgetRectsOnly) const

References LabelAndValueWidgetRects, m_detailLabel, m_label, and valueWidgetRects().

Referenced by Digikam::SearchFieldGroup::areaOfMarkedFields().

◆ write()

virtual void Digikam::SearchField::write ( SearchXmlWriter &  writer)
pure virtual

Implemented in Digikam::SearchFieldMonthDay, Digikam::SearchFieldLabels, Digikam::SearchFieldCheckBox, Digikam::SearchFieldComboBox, Digikam::SearchFieldRating, Digikam::SearchFieldAlbum, Digikam::SearchFieldChoice, Digikam::SearchFieldRangeDate, Digikam::SearchFieldRangeDouble, Digikam::SearchFieldRangeInt, Digikam::SearchFieldKeyword, and Digikam::SearchFieldText.

Referenced by Digikam::SearchFieldGroup::write().

Member Data Documentation

◆ m_categoryLabelVisible

bool Digikam::SearchField::m_categoryLabelVisible
protected

Referenced by SearchField(), setCategoryLabelVisible(), and setVisible().

◆ m_clearButton

AnimatedClearButton* Digikam::SearchField::m_clearButton
protected

Referenced by SearchField(), setup(), setValidValueState(), and setVisible().

◆ m_detailLabel

QLabel* Digikam::SearchField::m_detailLabel
protected

Referenced by isVisible(), SearchField(), setCategoryLabelVisible(), setText(), setupLabels(), setVisible(), and widgetRects().

◆ m_label

QLabel* Digikam::SearchField::m_label
protected

Referenced by SearchField(), setCategoryLabelVisible(), setCategoryLabelVisibleFromPreviousField(), setText(), setupLabels(), setVisible(), and widgetRects().

◆ m_name

QString Digikam::SearchField::m_name
protected

Referenced by setFieldName(), supportsField(), Digikam::SearchFieldText::write(), Digikam::SearchFieldKeyword::write(), Digikam::SearchFieldRangeInt::write(), Digikam::SearchFieldRangeDouble::write(), Digikam::SearchFieldRangeDate::write(), Digikam::SearchFieldChoice::write(), Digikam::SearchFieldAlbum::write(), Digikam::SearchFieldRating::write(), Digikam::SearchFieldComboBox::write(), Digikam::SearchFieldCheckBox::write(), Digikam::SearchFieldLabels::write(), and Digikam::SearchFieldMonthDay::write().

◆ m_valueIsValid

bool Digikam::SearchField::m_valueIsValid
protected

Referenced by SearchField(), and setValidValueState().

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