• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • graphics API Reference
  • KDE Home
  • Contact Us
 

digikam

  • extragear
  • graphics
  • digikam
  • core
  • libs
  • metadataengine
  • containers
template.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of digiKam project
4  * https://www.digikam.org
5  *
6  * Date : 2009-06-20
7  * Description : Template information container.
8  *
9  * Copyright (C) 2009-2019 by Gilles Caulier <caulier dot gilles at gmail dot com>
10  *
11  * This program is free software; you can redistribute it
12  * and/or modify it under the terms of the GNU General
13  * Public License as published by the Free Software Foundation;
14  * either version 2, or (at your option)
15  * any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * ============================================================ */
23 
24 #ifndef DIGIKAM_TEMPLATE_H
25 #define DIGIKAM_TEMPLATE_H
26 
27 // Qt includes
28 
29 #include <QMetaType>
30 #include <QString>
31 #include <QStringList>
32 #include <QDebug>
33 
34 // Local includes
35 
36 #include "metadatainfo.h"
37 #include "digikam_export.h"
38 #include "metaengine.h"
39 
40 namespace Digikam
41 {
42 
43 class TemplatePrivate;
44 
45 class DIGIKAM_EXPORT Template
46 {
47 public:
48 
49  explicit Template();
50  ~Template();
51 
55  bool isNull() const;
56 
60  bool isEmpty() const;
61 
65  bool operator==(const Template& t) const;
66 
67  void setTemplateTitle(const QString& title);
68  QString templateTitle() const;
69 
70  void setAuthors(const QStringList& authors);
71  void setAuthorsPosition(const QString& authorPosition);
72  void setCredit(const QString& credit);
73  void setCopyright(const MetaEngine::AltLangMap& copyright);
74  void setRightUsageTerms(const MetaEngine::AltLangMap& rightUsageTerms);
75  void setSource(const QString& source);
76  void setInstructions(const QString& instructions);
77  void setLocationInfo(const IptcCoreLocationInfo& inf);
78  void setContactInfo(const IptcCoreContactInfo& inf);
79  void setIptcSubjects(const QStringList& subjects);
80 
81  QStringList authors() const;
82  QString authorsPosition() const;
83  QString credit() const;
84  MetaEngine::AltLangMap copyright() const;
85  MetaEngine::AltLangMap rightUsageTerms() const;
86  QString source() const;
87  QString instructions() const;
88  IptcCoreLocationInfo locationInfo() const;
89  IptcCoreContactInfo contactInfo() const;
90  QStringList IptcSubjects() const;
91 
92  static QString removeTemplateTitle()
93  {
94  return QLatin1String("_REMOVE_TEMPLATE_");
95  };
96 
97 protected:
98 
102  QString m_templateTitle;
103 
107  QStringList m_authors;
108 
112  QString m_authorsPosition;
113 
117  QString m_credit;
118 
122  MetaEngine::AltLangMap m_copyright;
123 
127  MetaEngine::AltLangMap m_rightUsageTerms;
128 
132  QString m_source;
133 
137  QString m_instructions;
138 
142  IptcCoreLocationInfo m_locationInfo;
143 
147  IptcCoreContactInfo m_contactInfo;
148 
152  QStringList m_subjects;
153 };
154 
156 DIGIKAM_EXPORT QDebug operator<<(QDebug dbg, const Template& t);
157 
158 } // namespace Digikam
159 
160 Q_DECLARE_METATYPE(Digikam::Template)
161 
162 #endif // DIGIKAM_TEMPLATE_H
Digikam::Template::m_source
QString m_source
Descriptions of contents source.
Definition: template.h:132
Digikam::Template::m_subjects
QStringList m_subjects
IPTC Subjects Information.
Definition: template.h:152
Digikam::Template::m_credit
QString m_credit
Credit description.
Definition: template.h:117
QMap
Digikam::operator<<
QDebug operator<<(QDebug dbg, const DbEngineParameters &p)
Definition: dbengineparameters.cpp:796
Digikam::Template::m_instructions
QString m_instructions
Special instructions to process with contents.
Definition: template.h:137
t
#define t
Digikam::Template
Definition: template.h:45
Digikam::Template::m_authors
QStringList m_authors
List of author names.
Definition: template.h:107
metaengine.h
Digikam::Template::removeTemplateTitle
static QString removeTemplateTitle()
Definition: template.h:92
Digikam::Template::m_rightUsageTerms
MetaEngine::AltLangMap m_rightUsageTerms
Language alternative right term usages.
Definition: template.h:127
Digikam::operator==
static bool operator==(const DImageHistory::Entry &e1, const DImageHistory::Entry &e2)
Definition: dimagehistory.cpp:138
Digikam::IptcCoreContactInfo
Definition: metadatainfo.h:60
QString
QStringList
Digikam::Template::m_contactInfo
IptcCoreContactInfo m_contactInfo
IPTC Contact Information.
Definition: template.h:147
QDebug
QLatin1String
Digikam::Template::m_locationInfo
IptcCoreLocationInfo m_locationInfo
IPTC Location Information.
Definition: template.h:142
Digikam::IptcCoreLocationInfo
Definition: metadatainfo.h:40
Digikam::Template::m_authorsPosition
QString m_authorsPosition
Description of authors position.
Definition: template.h:112
metadatainfo.h
digikam_export.h
Digikam::Template::m_copyright
MetaEngine::AltLangMap m_copyright
Language alternative copyright notices.
Definition: template.h:122
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Thu Dec 5 2019 04:37:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

digikam

Skip menu "digikam"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages
-->

graphics API Reference

Skip menu "graphics API Reference"
  • digikam
  • KDiagram
  •     KChart
  •     KGantt
  • KPhotoAlbum
  •   AndroidRemoteControl
  • Krita
  •   libs
  •     KritaBasicFlakes
  •     brush
  •     KritaUndo2
  •     KritaFlake
  •     image
  •     KritaPlugin
  •     Krita
  •     KritaOdf
  •     KritaPigment
  •     KritaStore
  •     ui
  •     KritaWidgets
  •     KritaWidgetUtils
  •   plugins
  •     Assitants
  •     Extensions
  •     Filters
  •         KritaText
  •         KritaTextLayout
  •     Generators
  •     Formats
  •             src
  •     PaintOps
  •       libpaintop
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal