The Legacy Library support for the KLFLib framework. More...
#include <klfliblegacyengine.h>
Public Slots | |
virtual bool | createSubResource (const QString &subResource, const QString &subResourceTitle) |
virtual bool | renameSubResource (const QString &subResource, const QString &subResourceName) |
virtual bool | deleteSubResource (const QString &subResource) |
virtual bool | save () |
virtual void | setAutoSaveInterval (int intervalms) |
virtual QList< entryId > | insertEntries (const QString &subResource, const KLFLibEntryList &entries) |
virtual bool | changeEntries (const QString &subResource, const QList< entryId > &idlist, const QList< int > &properties, const QList< QVariant > &values) |
virtual bool | deleteEntries (const QString &subResource, const QList< entryId > &idlist) |
virtual bool | saveTo (const QUrl &newPath) |
Public Member Functions | |
virtual | ~KLFLibLegacyEngine () |
virtual uint | compareUrlTo (const QUrl &other, uint interestFlags=0xfffffff) const |
virtual bool | canModifyData (const QString &subRes, ModifyType modifytype) const |
virtual bool | canModifyProp (int propid) const |
virtual bool | canRegisterProperty (const QString &propName) const |
virtual KLFLibEntry | entry (const QString &resource, entryId id) |
virtual QList< KLFLibEntryWithId > | allEntries (const QString &resource, const QList< int > &wantedEntryProperties=QList< int >()) |
virtual QStringList | subResourceList () const |
virtual bool | canCreateSubResource () const |
virtual bool | canRenameSubResource (const QString &subResource) const |
virtual bool | canDeleteSubResource (const QString &subResource) const |
Static Public Member Functions | |
static KLFLibLegacyEngine * | openUrl (const QUrl &url, QObject *parent=NULL) |
static KLFLibLegacyEngine * | createDotKLF (const QString &fileName, QString legacyResourceName, QObject *parent=NULL) |
Protected Slots | |
void | updateResourceProperty (int propId) |
Protected Member Functions | |
virtual bool | saveResourceProperty (int propId, const QVariant &value) |
The Legacy Library support for the KLFLib framework.
Implements a KLFLibResourceEngine resource engine for accessing (KLF<=3.1)-created libraries (*.klf, default library files)
Different legacy resources (in the *.klf file) are mapped to sub-resources (in KLFLibResourceEngine).
Definition at line 135 of file klfliblegacyengine.h.
KLFLibLegacyEngine::~KLFLibLegacyEngine | ( | ) | [virtual] |
Definition at line 493 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::deref(), KLFLibLegacyFileDataPrivate::haschanges, KLF_ASSERT_NOT_NULL, KLF_DEBUG_BLOCK, KLF_FUNC_NAME, klfDbg, KLFLibLegacyFileDataPrivate::library, KLFLibLegacyFileDataPrivate::resources, and KLFLibLegacyFileDataPrivate::save().
QList< KLFLibResourceEngine::KLFLibEntryWithId > KLFLibLegacyEngine::allEntries | ( | const QString & | resource, |
const QList< int > & | wantedEntryProperties = QList<int>() |
||
) | [virtual] |
Implements KLFLibResourceEngine.
Definition at line 575 of file klfliblegacyengine.cpp.
References KLFLibResourceEngine::KLFLibEntryWithId::entry, KLFLibLegacyFileDataPrivate::findResourceName(), KLFLibResourceEngine::KLFLibEntryWithId::id, KLF_ASSERT_NOT_NULL, KLFLibLegacyFileDataPrivate::library, KLFLibLegacyFileDataPrivate::resources, QList::size(), and KLFLibLegacyFileDataPrivate::toLibEntry().
bool KLFLibLegacyEngine::canCreateSubResource | ( | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 607 of file klfliblegacyengine.cpp.
References canModifyData(), and KLFLibResourceEngine::ChangeData.
bool KLFLibLegacyEngine::canDeleteSubResource | ( | const QString & | subResource | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 616 of file klfliblegacyengine.cpp.
References canModifyData(), KLFLibResourceEngine::DeleteData, KLFLibResourceEngine::hasSubResource(), QString::length(), and subResourceList().
Referenced by deleteSubResource().
bool KLFLibLegacyEngine::canModifyData | ( | const QString & | subRes, |
ModifyType | modifytype | ||
) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 518 of file klfliblegacyengine.cpp.
References KLFLibResourceEngine::canModifyData(), QFile::exists(), KLFLibLegacyFileDataPrivate::fileName(), KLF_ASSERT_NOT_NULL, and klfDbg.
Referenced by canCreateSubResource(), canDeleteSubResource(), canRenameSubResource(), changeEntries(), deleteEntries(), and insertEntries().
bool KLFLibLegacyEngine::canModifyProp | ( | int | propid | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 540 of file klfliblegacyengine.cpp.
Referenced by canRegisterProperty().
bool KLFLibLegacyEngine::canRegisterProperty | ( | const QString & | propName | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 546 of file klfliblegacyengine.cpp.
References canModifyProp().
bool KLFLibLegacyEngine::canRenameSubResource | ( | const QString & | subResource | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 612 of file klfliblegacyengine.cpp.
References canModifyData(), and KLFLibResourceEngine::ChangeData.
bool KLFLibLegacyEngine::changeEntries | ( | const QString & | subResource, |
const QList< entryId > & | idlist, | ||
const QList< int > & | properties, | ||
const QList< QVariant > & | values | ||
) | [virtual, slot] |
Implements KLFLibResourceEngine.
Definition at line 767 of file klfliblegacyengine.cpp.
References canModifyData(), KLFLibEntry::Category, KLFLibResourceEngine::ChangeData, KLFLibResourceEngine::dataChanged(), KLFLibEntry::DateTime, KLFLibLegacyFileDataPrivate::findResourceName(), QPixmap::fromImage(), KLFLibLegacyFileDataPrivate::haschanges, KLF_ASSERT_NOT_NULL, KLF_FUNC_NAME, klfDbg, KLFLibEntry::Latex, KLFLibEntry::latexAddCategoryTagsComment(), KLFLibLegacyFileDataPrivate::library, KLFLibEntry::Preview, KLFPropertizedObject::propertyNameForId(), KLFLibLegacyFileDataPrivate::resources, QList::size(), KLFLibEntry::stripCategoryTagsFromLatex(), KLFLibEntry::Style, KLFLibEntry::Tags, KLFLibLegacyFileDataPrivate::toLegacyStyle(), and KLFPropertizedObject::toString().
uint KLFLibLegacyEngine::compareUrlTo | ( | const QUrl & | other, |
uint | interestFlags = 0xfffffff |
||
) | const [virtual] |
Implements KLFLibResourceEngine.
Definition at line 509 of file klfliblegacyengine.cpp.
References klfUrlCompare(), KlfUrlCompareBaseEqual, and KLFLibResourceEngine::url().
KLFLibLegacyEngine * KLFLibLegacyEngine::createDotKLF | ( | const QString & | fileName, |
QString | legacyResourceName, | ||
QObject * | parent = NULL |
||
) | [static] |
Use this function as a constructor. Creates a KLFLibLegacyEngine object, with QObject parent parent
, creating a fresh, empty .klf file.
Returns NULL if creating the file failed.
legacyResourceName
is the name of an empty (legacy) resource (ie. sub-resource) to create in the newly created file.
A non-NULL returned object is linked to a file that was successfully created.
Definition at line 425 of file klfliblegacyengine.cpp.
References QUrl::addQueryItem(), KLFLibLegacyFileDataPrivate::canonicalFilePath(), QFile::exists(), QUrl::fromLocalFile(), QString::isEmpty(), KLF_FUNC_NAME, klfDbgSt, QUrl::setScheme(), QObject::tr(), and KLFLibResourceEngine::url().
Referenced by KLFLibLegacyEngineFactory::createResource().
bool KLFLibLegacyEngine::createSubResource | ( | const QString & | subResource, |
const QString & | subResourceTitle | ||
) | [virtual, slot] |
Reimplemented from KLFLibResourceEngine.
Definition at line 622 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::getReservedResourceId(), KLFLibLegacyFileDataPrivate::haschanges, KLFLegacyData::KLFLibraryResource::id, KLF_ASSERT_NOT_NULL, KLF_FUNC_NAME, KLFLibLegacyFileDataPrivate::library, KLFLegacyData::LibResourceUSERMAX, KLFLegacyData::LibResourceUSERMIN, KLFLegacyData::KLFLibraryResource::name, QList::push_back(), KLFLibLegacyFileDataPrivate::resources, QList::size(), and KLFLibResourceEngine::subResourceCreated().
bool KLFLibLegacyEngine::deleteEntries | ( | const QString & | subResource, |
const QList< entryId > & | idlist | ||
) | [virtual, slot] |
Implements KLFLibResourceEngine.
Definition at line 864 of file klfliblegacyengine.cpp.
References canModifyData(), KLFLibResourceEngine::dataChanged(), KLFLibResourceEngine::DeleteData, KLFLibLegacyFileDataPrivate::findResourceName(), KLFLibLegacyFileDataPrivate::haschanges, QList::isEmpty(), KLF_ASSERT_NOT_NULL, KLFLibLegacyFileDataPrivate::library, QList::removeAt(), KLFLibLegacyFileDataPrivate::resources, and QList::size().
bool KLFLibLegacyEngine::deleteSubResource | ( | const QString & | subResource | ) | [virtual, slot] |
Reimplemented from KLFLibResourceEngine.
Definition at line 681 of file klfliblegacyengine.cpp.
References canDeleteSubResource(), KLFLibLegacyFileDataPrivate::findResourceName(), KLF_ASSERT_NOT_NULL, KLF_DEBUG_BLOCK, KLF_FUNC_NAME, klfDbg, KLFLibLegacyFileDataPrivate::library, QMap::remove(), KLFLibLegacyFileDataPrivate::resources, KLFLibResourceEngine::subResourceDeleted(), and QList::takeAt().
KLFLibEntry KLFLibLegacyEngine::entry | ( | const QString & | resource, |
entryId | id | ||
) | [virtual] |
Implements KLFLibResourceEngine.
Definition at line 552 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::findResourceName(), KLF_ASSERT_NOT_NULL, KLFLibLegacyFileDataPrivate::library, KLFLibLegacyFileDataPrivate::resources, QList::size(), and KLFLibLegacyFileDataPrivate::toLibEntry().
QList< KLFLibResourceEngine::entryId > KLFLibLegacyEngine::insertEntries | ( | const QString & | subResource, |
const KLFLibEntryList & | entries | ||
) | [virtual, slot] |
Implements KLFLibResourceEngine.
Definition at line 729 of file klfliblegacyengine.cpp.
References canModifyData(), KLFLibResourceEngine::dataChanged(), KLFLibLegacyFileDataPrivate::findResourceName(), KLFLibLegacyFileDataPrivate::haschanges, KLFLegacyData::KLFLibraryItem::id, KLFLibResourceEngine::InsertData, KLF_ASSERT_NOT_NULL, klfDbg, KLFLibLegacyFileDataPrivate::library, KLFLibLegacyFileDataPrivate::resources, QList::size(), and KLFLibLegacyFileDataPrivate::toLegacyLibItem().
KLFLibLegacyEngine * KLFLibLegacyEngine::openUrl | ( | const QUrl & | url, |
QObject * | parent = NULL |
||
) | [static] |
Use this function as a constructor for a KLFLibLegacyEngine object.
Opens the URL referenced by url and returns a pointer to a freshly instantiated KLFLibLegacyEngine object, the parent of which is set to parent
. Returns NULL in case of an error.
Definition at line 398 of file klfliblegacyengine.cpp.
References QUrl::hasQueryItem(), QString::isEmpty(), KLF_DEBUG_BLOCK, KLF_FUNC_NAME, klfDbgSt, klfUrlLocalFilePath(), QUrl::queryItemValue(), and QUrl::scheme().
Referenced by KLFLibLegacyEngineFactory::openResource().
bool KLFLibLegacyEngine::renameSubResource | ( | const QString & | subResource, |
const QString & | subResourceName | ||
) | [virtual, slot] |
Reimplemented from KLFLibResourceEngine.
Definition at line 654 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::findResourceName(), KLFLibLegacyFileDataPrivate::getReservedResourceId(), KLFLegacyData::KLFLibraryResource::id, KLF_ASSERT_NOT_NULL, KLF_FUNC_NAME, KLFLibLegacyFileDataPrivate::library, KLFLegacyData::KLFLibraryResource::name, KLFLibLegacyFileDataPrivate::resources, KLFLibResourceEngine::subResourceRenamed(), and QMap::take().
bool KLFLibLegacyEngine::save | ( | ) | [virtual, slot] |
Definition at line 708 of file klfliblegacyengine.cpp.
References KLFLibResourceEngine::isReadOnly(), KLF_ASSERT_NOT_NULL, klfDbg, KLFLibLegacyFileDataPrivate::save(), and KLFLibResourceEngine::url().
bool KLFLibLegacyEngine::saveResourceProperty | ( | int | propId, |
const QVariant & | value | ||
) | [protected, virtual] |
Implements KLFLibResourceEngine.
Definition at line 913 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::emitResourcePropertyChanged(), KLFLibLegacyFileDataPrivate::haschanges, QString::isEmpty(), KLF_DEBUG_BLOCK, KLF_FUNC_NAME, KLFLibLegacyFileDataPrivate::metadata, and KLFPropertizedObject::propertyNameForId().
bool KLFLibLegacyEngine::saveTo | ( | const QUrl & | newPath | ) | [virtual, slot] |
Reimplemented from KLFLibResourceEngine.
Definition at line 903 of file klfliblegacyengine.cpp.
References KLF_ASSERT_NOT_NULL, klfUrlLocalFilePath(), KLFLibLegacyFileDataPrivate::save(), and QUrl::scheme().
void KLFLibLegacyEngine::setAutoSaveInterval | ( | int | intervalms | ) | [virtual, slot] |
Definition at line 720 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::autoSaveTimer, QTimer::start(), and QTimer::stop().
QStringList KLFLibLegacyEngine::subResourceList | ( | ) | const [virtual] |
Reimplemented from KLFLibResourceEngine.
Definition at line 596 of file klfliblegacyengine.cpp.
References KLF_ASSERT_NOT_NULL, KLFLibLegacyFileDataPrivate::resources, and QList::size().
Referenced by canDeleteSubResource().
void KLFLibLegacyEngine::updateResourceProperty | ( | int | propId | ) | [protected, slot] |
Definition at line 936 of file klfliblegacyengine.cpp.
References KLFLibLegacyFileDataPrivate::fileName(), QVariant::fromValue(), KLF_DEBUG_BLOCK, KLF_FUNC_NAME, klfDbg, KLFLibLegacyFileDataPrivate::metadata, KLFLibResourceEngine::PropAccessShared, KLFPropertizedObject::property(), KLFPropertizedObject::propertyNameForId(), KLFLibResourceEngine::PropLocked, KLFLibResourceEngine::PropTitle, KLFLibResourceEngine::resourcePropertyChanged(), KLFPropertizedObject::setAllProperties(), and QObject::setProperty().