andrius
/
kpmcore
1
0
Fork 0
Code Pull Requests Releases Activity

Docs: Add documentation about FileSystem::name()

This commit is contained in:
Adriaan de Groot 2017-09-30 17:19:36 +02:00
parent f1dee86084
commit e67b6b6a2b
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/fs/filesystem.h
View File

@ -189,11 +189,24 @@ public:
virtual SupportTool supportToolName() const;
virtual bool supportToolFound() const;
/**
* Returns the (possibly translated) name of the type of this filesystem.
* @see nameForType()
*/
virtual QString name(const QStringList& languages = {}) const;
virtual FileSystem::Type type() const {
return m_Type; /**< @return the FileSystem's type */
}
/**
* Returns the name of the given filesystem type. If @p languages
* is an empty list, uses the translated name of the filesystem,
* in the default locale. If languages is {"C"}, an untranslated
* string is returned. Passing other lists of language identifiers
* may yield unpredicatable results -- see the documentation of
* KLocalizedString() for details on the way toString() is used.
* Returns a single QString with the name.
*/
static QString nameForType(FileSystem::Type t, const QStringList& languages = {});
static QList<FileSystem::Type> types();
static FileSystem::Type typeForName(const QString& s, const QStringList& languages = {});