libs/resources/Mainpage.dox

0001 /**
0002   \mainpage Resources
0003
0004   The Resources library provides cached access to resources. Resources are things
0005   like brush presets, brush tips or gradients. The following components play an
0006   important role in the library:
0007
0008   - KisResourceModel: This model can be used to access resources without loading
0009     the actual resource until it is needed.
0010
0011   - KisTagResourceModel: this model represents the intersection between tags and resources and
0012     can be used to tag and untag resources.
0013
0014   - KisTagModel: this model represents tags. It can be used create tags and activate or deactivate
0015     tags.
0016
0017   These three models are accessed through KisResourceModelProvider. The models themselves are
0018   proxy models that allow filtering by active or inactive state or the resource, tag or storage.
0019
0020   - KisTagFilterResourceProxyModel. This model should be used in resource choosers. Under the
0021     hood it switches between KisResourceModel and KisTagResourceModel based on whether the
0022     widget is filtering by tag or not.
0023
0024   - KisResourceLocator: KisResourceLocator should not be used outside of the resources library.
0025     Its task is to load the resources from the resource storages: resource storages are the
0026     resource folder, bundles, ASL or ABR files that contain a collection of resources. Once a
0027     resource is loaded, it's cached. Loading resources is handled through the KisResourceLoader
0028     classes, while finding resources in the storages is handled through the KisStoragePlugin
0029     implementations.
0030
0031     All resources are captured in a QSharedPointer and should not be used naked.
0032
0033     KisResourceLocator is also responsible for initializing the cache database.
0034
0035   - KisResourceCacheDB: this class creates the sqlite database and handles synchronizing resources
0036     with the contents of storages.
0037
0038  */
0039
0040 // DOXYGEN_SET_PROJECT_NAME = KritaResources
0041 // DOXYGEN_SET_IGNORE_PREFIX = Kis Ko K