|
Krita Source Code Documentation
|
A KoResourceBundle is a zip file that contains resources, some metadata about the creator of the bundle and a manifest file that lists the contained resources. More...
#include <KoResourceBundle.h>
Public Member Functions | |
| void | addResource (QString fileType, QString filePath, QVector< KisTagSP > fileTagList, const QString md5sum, const int resourceId=-1, const QString filenameInBundle="") |
| addFile : Add a file to the bundle | |
| QString | defaultFileExtension () const |
| defaultFileExtension | |
| bool | exportResource (const QString &resourceType, const QString &fileName, QIODevice *device) |
| QString | filename () const |
| QList< QString > | getTagsList () |
| QImage | image () const |
| KoResourceBundle (QString const &fileName) | |
| ResourceBundle : Ctor *. | |
| bool | load () |
| load : Load this resource. | |
| bool | loadFromDevice (QIODevice *dev) |
| bool | loadResource (KoResourceSP resource) |
| KoResourceBundleManifest & | manifest () |
| const QString | metaData (const QString &key, const QString &defaultValue=QString()) const |
| KoResourceSP | resource (const QString &resourceType, const QString &filepath) |
| int | resourceCount () const |
| QString | resourceMd5 (const QString &url) |
| QStringList | resourceTypes () const |
| bool | save () |
| save : Save this resource. | |
| void | saveManifest (QScopedPointer< KoStore > &store) |
| saveManifest: saves bundle manifest | |
| void | saveMetadata (QScopedPointer< KoStore > &store) |
| saveMetadata: saves bundle metadata | |
| bool | saveToDevice (QIODevice *dev) const |
| void | setMetaData (const QString &key, const QString &value) |
| addMeta : Add a Metadata to the resource | |
| void | setThumbnail (QImage) |
| virtual | ~KoResourceBundle () |
| ~ResourceBundle : Dtor | |
Private Member Functions | |
| bool | readMetaData (KoStore *resourceStore) |
| void | writeMeta (const QString &metaTag, KoXmlWriter *writer) |
| void | writeUserDefinedMeta (const QString &metaTag, KoXmlWriter *writer) |
Private Attributes | |
| QList< QByteArray > | m_brushesMd5Installed |
| QSet< QString > | m_bundletags |
| QString | m_bundleVersion |
| QString | m_filename |
| QList< QByteArray > | m_gradientsMd5Installed |
| KoResourceBundleManifest | m_manifest |
| QMap< QString, QString > | m_metadata |
| QList< QByteArray > | m_palettesMd5Installed |
| QList< QByteArray > | m_patternsMd5Installed |
| QList< QByteArray > | m_presetsMd5Installed |
| QImage | m_thumbnail |
| QList< QByteArray > | m_workspacesMd5Installed |
A KoResourceBundle is a zip file that contains resources, some metadata about the creator of the bundle and a manifest file that lists the contained resources.
Definition at line 31 of file KoResourceBundle.h.
| KoResourceBundle::KoResourceBundle | ( | QString const & | fileName | ) |
ResourceBundle : Ctor *.
| bundlePath | the path of the bundle |
Definition at line 40 of file KoResourceBundle.cpp.
References m_metadata, KisResourceStorage::s_meta_generator, and KritaVersionWrapper::versionString().
|
virtual |
| void KoResourceBundle::addResource | ( | QString | fileType, |
| QString | filePath, | ||
| QVector< KisTagSP > | fileTagList, | ||
| const QString | md5sum, | ||
| const int | resourceId = -1, | ||
| const QString | filenameInBundle = "" ) |
addFile : Add a file to the bundle
| fileType | type of the resource file |
| filePath | path of the resource file |
Definition at line 259 of file KoResourceBundle.cpp.
References KoResourceBundleManifest::addResource(), and m_manifest.
| QString KoResourceBundle::defaultFileExtension | ( | ) | const |
defaultFileExtension
Definition at line 51 of file KoResourceBundle.cpp.
| bool KoResourceBundle::exportResource | ( | const QString & | resourceType, |
| const QString & | fileName, | ||
| QIODevice * | device ) |
Definition at line 465 of file KoResourceBundle.cpp.
References KoStore::createStore(), m_filename, KoStore::Read, and KoStore::Zip.
| QString KoResourceBundle::filename | ( | ) | const |
Definition at line 560 of file KoResourceBundle.cpp.
References m_filename.
| QList< QString > KoResourceBundle::getTagsList | ( | ) |
| QImage KoResourceBundle::image | ( | ) | const |
| bool KoResourceBundle::load | ( | ) |
load : Load this resource.
Definition at line 56 of file KoResourceBundle.cpp.
References KoStore::createStore(), filename(), KoResourceBundleManifest::files(), KoResourceBundleManifest::load(), m_filename, m_manifest, m_metadata, m_thumbnail, KoStore::Read, readMetaData(), KoResourceBundleManifest::removeResource(), KoResourceBundleManifest::ResourceReference::resourcePath, KisResourceStorage::s_meta_version, and KoStore::Zip.
| bool KoResourceBundle::loadFromDevice | ( | QIODevice * | dev | ) |
Definition at line 115 of file KoResourceBundle.cpp.
| bool KoResourceBundle::loadResource | ( | KoResourceSP | resource | ) |
Definition at line 487 of file KoResourceBundle.cpp.
References KoStore::createStore(), KisGlobalResourcesInterface::instance(), m_filename, KoStore::Read, resource(), and KoStore::Zip.
| KoResourceBundleManifest & KoResourceBundle::manifest | ( | ) |
Definition at line 443 of file KoResourceBundle.cpp.
References m_manifest.
| const QString KoResourceBundle::metaData | ( | const QString & | key, |
| const QString & | defaultValue = QString() ) const |
Definition at line 249 of file KoResourceBundle.cpp.
References m_metadata.
|
private |
Definition at line 313 of file KoResourceBundle.cpp.
References KoStore::close(), KoStore::device(), m_bundletags, m_filename, m_metadata, KoStore::open(), and value().
| KoResourceSP KoResourceBundle::resource | ( | const QString & | resourceType, |
| const QString & | filepath ) |
Definition at line 448 of file KoResourceBundle.cpp.
References KisResourceLoaderBase::create(), KisResourceLoaderRegistry::instance(), KisResourceLoaderRegistry::loader(), loadResource(), KisMimeDatabase::mimeTypeForSuffix(), and resource().
| int KoResourceBundle::resourceCount | ( | ) | const |
Definition at line 438 of file KoResourceBundle.cpp.
References KoResourceBundleManifest::files(), and m_manifest.
| QString KoResourceBundle::resourceMd5 | ( | const QString & | url | ) |
Definition at line 532 of file KoResourceBundle.cpp.
References KoStore::createStore(), KoMD5Generator::generateHash(), m_filename, KoStore::Read, and KoStore::Zip.
| QStringList KoResourceBundle::resourceTypes | ( | ) | const |
Definition at line 273 of file KoResourceBundle.cpp.
References m_manifest, and KoResourceBundleManifest::types().
| bool KoResourceBundle::save | ( | ) |
save : Save this resource.
Definition at line 186 of file KoResourceBundle.cpp.
References KoStore::createStore(), KoResourceBundleManifest::ResourceReference::filenameInBundle, KoResourceBundleManifest::files(), m_filename, m_manifest, m_thumbnail, KoResourceBundleManifest::ResourceReference::md5sum, metaData(), KisResourceModel::resourceForId(), KoResourceBundleManifest::ResourceReference::resourceId, KoResourceBundleManifest::ResourceReference::resourcePath, KisResourceModel::resourcesForFilename(), KisResourceModel::resourcesForMD5(), KisResourceStorage::s_meta_creation_date, KisResourceStorage::s_meta_dc_date, KoResourcePaths::saveLocation(), saveManifest(), saveMetadata(), saveResourceToStore(), setMetaData(), KisResourceModel::setResourceFilter(), KisAbstractResourceFilterInterface::ShowAllResources, KoResourceBundleManifest::types(), KoStore::Write, and KoStore::Zip.
saveManifest: saves bundle manifest
| store | bundle where to save the manifest |
Definition at line 427 of file KoResourceBundle.cpp.
References m_manifest, and KoResourceBundleManifest::save().
saveMetadata: saves bundle metadata
| store | bundle where to save the metadata |
Definition at line 371 of file KoResourceBundle.cpp.
References KoXmlWriter::addAttribute(), KoXmlWriter::addTextNode(), KoXmlWriter::endDocument(), KoXmlWriter::endElement(), m_bundletags, m_bundleVersion, KisResourceStorage::s_meta_author, KisResourceStorage::s_meta_creation_date, KisResourceStorage::s_meta_creator, KisResourceStorage::s_meta_dc_date, KisResourceStorage::s_meta_description, KisResourceStorage::s_meta_email, KisResourceStorage::s_meta_generator, KisResourceStorage::s_meta_initial_creator, KisResourceStorage::s_meta_license, KisResourceStorage::s_meta_name, KisResourceStorage::s_meta_title, KisResourceStorage::s_meta_user_defined, KisResourceStorage::s_meta_value, KisResourceStorage::s_meta_version, KisResourceStorage::s_meta_website, KisResourceStorage::s_xmlns_dc, KisResourceStorage::s_xmlns_meta, KoXmlWriter::startDocument(), KoXmlWriter::startElement(), writeMeta(), and writeUserDefinedMeta().
| bool KoResourceBundle::saveToDevice | ( | QIODevice * | dev | ) | const |
Definition at line 239 of file KoResourceBundle.cpp.
| void KoResourceBundle::setMetaData | ( | const QString & | key, |
| const QString & | value ) |
addMeta : Add a Metadata to the resource
| type | type of the metadata |
| value | value of the metadata |
Definition at line 244 of file KoResourceBundle.cpp.
References m_metadata, and value().
| void KoResourceBundle::setThumbnail | ( | QImage | image | ) |
Definition at line 278 of file KoResourceBundle.cpp.
References image(), and m_thumbnail.
|
private |
Definition at line 292 of file KoResourceBundle.cpp.
References KoXmlWriter::addTextNode(), KoXmlWriter::endElement(), m_metadata, and KoXmlWriter::startElement().
|
private |
Definition at line 303 of file KoResourceBundle.cpp.
References KoXmlWriter::addAttribute(), KoXmlWriter::endElement(), m_metadata, and KoXmlWriter::startElement().
|
private |
Definition at line 124 of file KoResourceBundle.h.
|
private |
Definition at line 121 of file KoResourceBundle.h.
|
private |
Definition at line 129 of file KoResourceBundle.h.
|
private |
Definition at line 128 of file KoResourceBundle.h.
|
private |
Definition at line 122 of file KoResourceBundle.h.
|
private |
Definition at line 119 of file KoResourceBundle.h.
|
private |
Definition at line 120 of file KoResourceBundle.h.
|
private |
Definition at line 125 of file KoResourceBundle.h.
|
private |
Definition at line 123 of file KoResourceBundle.h.
|
private |
Definition at line 127 of file KoResourceBundle.h.
|
private |
Definition at line 118 of file KoResourceBundle.h.
|
private |
Definition at line 126 of file KoResourceBundle.h.