KisTag Class Reference

The KisTag loads a tag from a .tag file. A .tag file is a .desktop file. The following fields are important: More...

#include <KisTag.h>

Classes
class	Private

Public Member Functions
bool	active () const
KisTagSP	clone () const
QString	comment (bool translated=true) const
	The translated tooltips for the tag.
QMap< QString, QString >	comments () const
QStringList	defaultResources () const
QString	filename ()
int	id () const
	KisTag ()
	KisTag (const KisTag &rhs)
bool	load (QIODevice &io)
QString	name (bool translated=true) const
	The translated names of the tag.
QMap< QString, QString >	names () const
KisTag &	operator= (const KisTag &rhs)
QString	resourceType () const
bool	save (QIODevice &io)
void	setComment (const QString comment)
void	setComments (const QMap< QString, QString > &comments)
void	setDefaultResources (const QStringList &defaultResources)
void	setFilename (const QString &fileName)
void	setName (const QString &name)
void	setNames (const QMap< QString, QString > &names)
void	setResourceType (const QString &resourceType)
void	setUrl (const QString &url)
QString	url () const
	The unique identifier for the tag. Since tag urls are compared COLLATE NOCASE, tag urls must be ASCII only.
bool	valid () const
virtual	~KisTag ()

Static Public Member Functions
static QString	currentLocale ()

Private Member Functions
void	setActive (bool active)
void	setId (int id)
void	setValid (bool valid)

Private Attributes
QScopedPointer< Private >	d

Static Private Attributes
static const QString	s_comment {"Comment"}
static const QString	s_defaultResources {"Default Resources"}
static const QString	s_desktop {"[Desktop Entry]"}
static const QString	s_group {"Desktop Entry"}
static const QString	s_name {"Name"}
static const QString	s_resourceType {"ResourceType"}
static const QString	s_tag {"Tag"}
static const QString	s_type {"Type"}
static const QString	s_url {"URL"}

Friends
class	AbrTagIterator
class	BundleTagIterator
class	KisAllResourcesModel
class	KisAllTagResourceModel
class	KisAllTagsModel
class	KisResourceLocator
class	KisResourceModel
class	KisTagChooserWidget
class	KisTagModel
class	TestMemoryStorage
class	TestResourceLocator
class	TestStorageWrapper
class	TestTagModel

Detailed Description

The KisTag loads a tag from a .tag file. A .tag file is a .desktop file. The following fields are important:

name: the name of the tag, which can be translated comment: a tooltip for the tag, which can be translated url: the untranslated name of the tag

Definition at line 33 of file KisTag.h.

Constructor & Destructor Documentation

KisTag() [1/2]

KisTag::KisTag

(

)

Definition at line 47 of file KisTag.cpp.

    : d(new Private)
{
}

~KisTag()

KisTag::~KisTag ( )

virtual

Definition at line 52 of file KisTag.cpp.

{
}

KisTag() [2/2]

KisTag::KisTag

(

const KisTag &

rhs

)

Definition at line 56 of file KisTag.cpp.

    : d(new Private)
{
    *this = rhs;
}

Member Function Documentation

active()

bool KisTag::active

(

)

const

Definition at line 107 of file KisTag.cpp.

{
    return d->active;
}

References d.

clone()

KisTagSP KisTag::clone

(

)

const

Definition at line 79 of file KisTag.cpp.

{
    return KisTagSP(new KisTag(*this));
}

References KisTag().

comment()

QString KisTag::comment

(

bool

translated = true

)

const

The translated tooltips for the tag.

Definition at line 146 of file KisTag.cpp.

{
    if (translated && d->comments.contains(currentLocale())) {
        return d->comments[currentLocale()];
    }
    return d->comment;
}

References currentLocale(), and d.

comments()

QMap< QString, QString > KisTag::comments

(

)

const

Definition at line 170 of file KisTag.cpp.

{
    return d->comments;
}

References d.

currentLocale()

QString KisTag::currentLocale ( )

static

Definition at line 84 of file KisTag.cpp.

{
    const QStringList languages = KLocalizedString::languages();
    QString locale;
    if (languages.isEmpty()) {
        locale = QLocale().name();
    }
    else {
        locale = languages.first();
    }
    return locale;
}

defaultResources()

QStringList KisTag::defaultResources

(

)

const

Definition at line 190 of file KisTag.cpp.

{
    return d->defaultResources;
}

References d.

filename()

QString KisTag::filename

(

)

Definition at line 112 of file KisTag.cpp.

{
    return d->filename;
}

References d.

id()

int KisTag::id

(

)

const

Definition at line 102 of file KisTag.cpp.

{
    return d->id;
}

References d.

load()

bool KisTag::load

(

QIODevice &

io

)

Definition at line 200 of file KisTag.cpp.

{
    if (!io.isOpen()) {
        io.open(QIODevice::ReadOnly);
    }
    KIS_ASSERT(io.isOpen());
 
    setValid(false);
 
    QTextStream stream(&io);
    KisPortingUtils::setUtf8OnStream(stream);
    QStringList lines;
    QString line;
 
    while (stream.readLineInto(&line)) {
        lines << line;
    }
 
    if (lines.length() < 6 ) {
        qWarning()  << d->filename << ": Incomplete tag file" << lines.length();
        return false;
    }
    if (lines[0].toUpper() != s_desktop.toUpper()) {
        qWarning()  << d->filename << ":Invalid tag file" << lines[0];
        return false;
    }
 
    lines.removeFirst();
 
    Q_FOREACH(const QString line, lines) {
        if (line.isEmpty()) {
            continue;
        }
 
        if (!line.contains("=")) {
            qWarning() << "Found invalid line:" << line;
            continue;
        }
        int isPos = line.indexOf("=");
        QString key = line.left(isPos).trimmed();
        QString value = line.right(line.size() - (isPos + 1)).trimmed();
 
        if (key == s_url) {
            d->url = value;
        }
        else if (key == s_resourceType) {
            d->resourceType = value;
        }
        else if (key == s_defaultResources) {
            d->defaultResources = value.split(',', Qt::SkipEmptyParts);
        }
        else if (key == s_name) {
            d->name = value;
        }
        else if (key == s_comment) {
            d->comment = value;
        }
        else if (key.startsWith(s_name + "[")) {
            int start = key.indexOf('[') + 1;
            int len = key.size() - (s_name.size() + 2);
            QString language = key.mid(start, len);
            d->names[language] = value;
        }
        else if (key.startsWith(s_comment + "[")) {
            int start = key.indexOf('[') + 1;
            int len = key.size() - (s_comment.size() + 2);
            QString language = key.mid(start, len);
            d->comments[language] = value;
        }
    }
 
    setValid(true);
 
    return true;
}

References d, KIS_ASSERT, s_comment, s_defaultResources, s_desktop, s_name, s_resourceType, s_url, KisPortingUtils::setUtf8OnStream(), setValid(), and value().

name()

QString KisTag::name

(

bool

translated = true

)

const

The translated names of the tag.

Definition at line 122 of file KisTag.cpp.

{
    if (translated && d->names.contains(currentLocale())) {
        return d->names[currentLocale()];
    }
    Q_ASSERT(!d->name.isEmpty());
    return d->name;
}

References currentLocale(), and d.

names()

QMap< QString, QString > KisTag::names

(

)

const

Definition at line 136 of file KisTag.cpp.

{
    return d->names;
}

References d.

operator=()

KisTag & KisTag::operator=

(

const KisTag &

rhs

)

Definition at line 62 of file KisTag.cpp.

{
    if (this != &rhs) {
        d->valid = rhs.d->valid;
        d->url = rhs.d->url;
        d->name = rhs.d->name;
        d->comment = rhs.d->comment;
        d->names = rhs.d->names;
        d->comments = rhs.d->comments;
        d->defaultResources = rhs.d->defaultResources;        d->resourceType = rhs.d->resourceType;
        d->filename = rhs.d->filename;
        d->id = rhs.d->id;
        d->active = rhs.d->active;
    }
    return *this;
}

References d, and valid().

resourceType()

QString KisTag::resourceType

(

)

const

Definition at line 180 of file KisTag.cpp.

{
    return d->resourceType;
}

References d.

save()

bool KisTag::save

(

QIODevice &

io

)

Definition at line 276 of file KisTag.cpp.

{
    if (!io.isOpen()) {
        io.open(QIODevice::WriteOnly | QIODevice::Text);
    }
 
    QTextStream stream(&io);
    KisPortingUtils::setUtf8OnStream(stream);
    stream << s_desktop << '\n';
    stream << s_type << '=' << s_tag << '\n';
    stream << s_url << '=' << d->url << '\n';
    stream << s_resourceType << '=' << d->resourceType << '\n';
    stream << s_name << '=' << d->name << '\n';
    stream << s_comment << '=' << d->comment << '\n';
    stream << s_defaultResources << '=' << d->defaultResources.join(',') << '\n';
 
    Q_FOREACH(const QString &language, d->names) {
        stream << s_name << '[' << language << "]=" << d->names[language] << '\n';
    }
 
    Q_FOREACH(const QString &language, d->comments) {
        stream << s_comment << '[' << language << "]=" << d->comments[language] << '\n';
    }
 
    return true;
}

References d, s_comment, s_defaultResources, s_desktop, s_name, s_resourceType, s_tag, s_type, s_url, and KisPortingUtils::setUtf8OnStream().

setActive()

void KisTag::setActive ( bool active )

private

Definition at line 308 of file KisTag.cpp.

{
    d->active = active;
}

References active(), and d.

setComment()

void KisTag::setComment

(

const QString

comment

)

Definition at line 154 of file KisTag.cpp.

{
    d->comment = comment;
}

References comment(), and d.

setComments()

void KisTag::setComments

(

const QMap< QString, QString > &

comments

)

Definition at line 175 of file KisTag.cpp.

{
    d->comments = comments;
}

References comments(), and d.

setDefaultResources()

void KisTag::setDefaultResources

(

const QStringList &

defaultResources

)

Definition at line 195 of file KisTag.cpp.

{
    d->defaultResources = defaultResources;
}

References d, and defaultResources().

setFilename()

void KisTag::setFilename

(

const QString &

fileName

)

Definition at line 117 of file KisTag.cpp.

{
    d->filename = filename;
}

References d, and filename().

setId()

void KisTag::setId ( int id )

private

Definition at line 303 of file KisTag.cpp.

{
    d->id = id;
}

References d, and id().

setName()

void KisTag::setName

(

const QString &

name

)

Definition at line 131 of file KisTag.cpp.

{
    d->name = name;
}

References d, and name().

setNames()

void KisTag::setNames

(

const QMap< QString, QString > &

names

)

Definition at line 141 of file KisTag.cpp.

{
    d->names = names;
}

References d, and names().

setResourceType()

void KisTag::setResourceType

(

const QString &

resourceType

)

Definition at line 185 of file KisTag.cpp.

{
    d->resourceType = resourceType;
}

References d, and resourceType().

setUrl()

void KisTag::setUrl

(

const QString &

url

)

Definition at line 164 of file KisTag.cpp.

{
    d->url = url;
}

References d, and url().

setValid()

void KisTag::setValid ( bool valid )

private

Definition at line 313 of file KisTag.cpp.

{
    d->valid = valid;
}

References d, and valid().

url()

QString KisTag::url

(

)

const

The unique identifier for the tag. Since tag urls are compared COLLATE NOCASE, tag urls must be ASCII only.

Definition at line 159 of file KisTag.cpp.

{
    return d->url;
}

References d.

valid()

bool KisTag::valid

(

)

const

Definition at line 97 of file KisTag.cpp.

{
    return d->valid;
}

References d.

Friends And Related Symbol Documentation

AbrTagIterator

friend class AbrTagIterator

friend

Definition at line 88 of file KisTag.h.

BundleTagIterator

friend class BundleTagIterator

friend

Definition at line 87 of file KisTag.h.

KisAllResourcesModel

friend class KisAllResourcesModel

friend

Definition at line 82 of file KisTag.h.

KisAllTagResourceModel

friend class KisAllTagResourceModel

friend

Definition at line 81 of file KisTag.h.

KisAllTagsModel

friend class KisAllTagsModel

friend

Definition at line 80 of file KisTag.h.

KisResourceLocator

friend class KisResourceLocator

friend

Definition at line 86 of file KisTag.h.

KisResourceModel

friend class KisResourceModel

friend

Definition at line 83 of file KisTag.h.

KisTagChooserWidget

friend class KisTagChooserWidget

friend

Definition at line 84 of file KisTag.h.

KisTagModel

friend class KisTagModel

friend

Definition at line 79 of file KisTag.h.

TestMemoryStorage

friend class TestMemoryStorage

friend

Definition at line 89 of file KisTag.h.

TestResourceLocator

friend class TestResourceLocator

friend

Definition at line 90 of file KisTag.h.

TestStorageWrapper

friend class TestStorageWrapper

friend

Definition at line 91 of file KisTag.h.

TestTagModel

friend class TestTagModel

friend

Definition at line 85 of file KisTag.h.

Member Data Documentation

d

QScopedPointer<Private> KisTag::d

private

Definition at line 108 of file KisTag.h.

s_comment

const QString KisTag::s_comment {"Comment"}

staticprivate

Definition at line 28 of file KisTag.h.

: the name of the tag, which can be translated

s_defaultResources

const QString KisTag::s_defaultResources {"Default Resources"}

staticprivate

Definition at line 29 of file KisTag.h.

: a tooltip for the tag, which can be translated

s_desktop

const QString KisTag::s_desktop {"[Desktop Entry]"}

staticprivate

Definition at line 30 of file KisTag.h.

: the untranslated name of the tag

s_group

const QString KisTag::s_group {"Desktop Entry"}

staticprivate

Definition at line 22 of file KisTag.h.

s_name

const QString KisTag::s_name {"Name"}

staticprivate

Definition at line 25 of file KisTag.h.

s_resourceType

const QString KisTag::s_resourceType {"ResourceType"}

staticprivate

Definition at line 26 of file KisTag.h.

:
 

s_tag

const QString KisTag::s_tag {"Tag"}

staticprivate

Definition at line 24 of file KisTag.h.

s_type

const QString KisTag::s_type {"Type"}

staticprivate

Definition at line 23 of file KisTag.h.

s_url

const QString KisTag::s_url {"URL"}

staticprivate

Definition at line 27 of file KisTag.h.

---

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

• libs/resources/KisTag.h
• libs/resources/KisTag.cpp