score-api-docs/_document_templates_8hpp_source.html

#pragma once

#include <QString>


#include <score_lib_base_export.h>


#include <vector>


namespace score

{


struct SCORE_LIB_BASE_EXPORT DocumentTemplate

{

  QString name;

  QString path;

  QString source;

  QString

      category;

};


SCORE_LIB_BASE_EXPORT

QString libraryRootPath();


SCORE_LIB_BASE_EXPORT

QString defaultDocumentTemplate();


SCORE_LIB_BASE_EXPORT

QString firstRunDocumentTemplate();


SCORE_LIB_BASE_EXPORT

std::vector<DocumentTemplate> availableDocumentTemplates();


SCORE_LIB_BASE_EXPORT

std::vector<DocumentTemplate> availableExampleDocuments();

}

score
Base toolkit upon which the software is built.
Definition Application.cpp:116

score::libraryRootPath
QString libraryRootPath()
Root of the user library, from the settings.
Definition DocumentTemplates.cpp:22

score::defaultDocumentTemplate
QString defaultDocumentTemplate()
The template applied to new documents, or an empty string.
Definition DocumentTemplates.cpp:135

score::firstRunDocumentTemplate
QString firstRunDocumentTemplate()
The guided score for first-time users, or an empty string.
Definition DocumentTemplates.cpp:144

score::DocumentTemplate
A .score file that can be opened as a new, untitled document.
Definition DocumentTemplates.hpp:30

score::DocumentTemplate::name
QString name
File name without extension.
Definition DocumentTemplates.hpp:31

score::DocumentTemplate::path
QString path
Absolute path or resource path.
Definition DocumentTemplates.hpp:32

score::DocumentTemplate::category
QString category
Folder path relative to the search root, e.g.
Definition DocumentTemplates.hpp:35

score::DocumentTemplate::source
QString source
"bundled", "library" or the package name
Definition DocumentTemplates.hpp:33