Mercurial > hg > svcore
view base/ResourceFinder.h @ 810:b18f8c5fb4f5
Debug tidy
author | Chris Cannam |
---|---|
date | Thu, 16 May 2013 14:04:37 +0100 |
parents | b4a8d8221eaf |
children | 48e9f538e6e9 |
line wrap: on
line source
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ /* Sonic Visualiser An audio file viewer and annotation editor. Centre for Digital Music, Queen Mary, University of London. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. See the file COPYING included with this distribution for more information. */ /* This is a modified version of a source file from the Rosegarden MIDI and audio sequencer and notation editor. This file copyright 2005-2011 Chris Cannam and the Rosegarden development team. */ #ifndef _RESOURCE_FINDER_H_ #define _RESOURCE_FINDER_H_ #include <QString> #include "Debug.h" class ResourceFinder { public: ResourceFinder() { } virtual ~ResourceFinder() { } /** * Return the location (as a true file path, or a Qt4 ":"-prefixed * resource path) of the file best matching the given resource * filename in the given resource category. * * Category should be a relative directory path without leading or * trailing slashes, for example "chords". The fileName is the * remainder of the file name without any path content, for * example "user_chords.xml". * * Returns an empty string if no matching resource is found. * * Use this when you know that a particular resource is required * and just need to locate it. */ QString getResourcePath(QString resourceCat, QString fileName); /** * Return a list of full file paths for files with the given file * extension, found in the given resource category. * * Category should be a relative directory path without leading or * trailing slashes, for example "chords". File extension should * be the extension without the dot, for example "xml". Returned * list may mix true file paths in both installed and user * locations with Qt4 ":"-prefixed resource paths. * * Use this when you need to enumerate the options available for * use directly in the program (rather than e.g. offering the user * a file-open dialog). */ QStringList getResourceFiles(QString resourceCat, QString fileExt); /** * Return the true file path for installed resource files in the * given resource category. Category should be a relative * directory path without leading or trailing slashes, for example * "chords". Note that resources may also exist in the Qt4 * resource bundle; this method only returns the external * (installed) resource location. Use getResourceFiles instead to * return an authoritative list of available resources of a given * type. * * Use this when you need a file path, e.g. for use in a file * finder dialog. */ QString getResourceDir(QString resourceCat); /** * Return the true file path for the location in which the named * resource file in the given resource category should be saved. * ResourceFinder will make a best effort to ensure this directory * actually exists, before returning. */ QString getResourceSavePath(QString resourceCat, QString fileName); /** * Return the true file path for the location in which resource * files in the given resource category should be saved. */ QString getResourceSaveDir(QString resourceCat); /** * If the named resource file in the given resource category is * available only as a bundled resource, copy it out into the user * location returned by getResourceSavePath so that it can be read * by non-Qt code. Any subsequent call to getResourcePath for * this resource should return a true file path (if the resource * exists) in either user or system location, or an empty string * (if the resource does not exist), but never a ":"-prefixed * resource path. This function does not overwrite any existing * unbundled copy of the resource. * * Return false if a system error occurs during unbundling * (e.g. disk full). */ bool unbundleResource(QString resourceCat, QString fileName); /** * Return the root path for user-specific resource installation * for this application (i.e. resources beneath the user's home * directory). */ QString getUserResourcePrefix(); /** * Return the root paths for systemwide resource installations for * this application. */ QStringList getSystemResourcePrefixList(); /** * Return all root paths for resource installations for this * application, in the order in which they will be searched. This * list consists of the user-specific path * (getUserResourcePrefix()) followed by the systemwide paths * (getSystemResourcePrefixList()). */ QStringList getResourcePrefixList(); }; #endif