File indexing completed on 2024-05-12 04:37:48

 /*
     SPDX-FileCopyrightText: 2007 Alexander Dymo <adymo@kdevelop.org>
     SPDX-FileCopyrightText: 2012 Miha Čančula <miha@noughmad.eu>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KDEVPLATFORM_TEMPLATESMODEL_H
 #define KDEVPLATFORM_TEMPLATESMODEL_H
 
 #include <QStandardItemModel>
 
 #include <language/languageexport.h>
 
 namespace KDevelop {
 class TemplatesModelPrivate;
 
 /**
  * @brief A convenience class for loading templates using .kdevtemplate files
  *
  * It loads template archives, extracts and stores their description files, and
  * displays them as a three-level tree structure.
  *
  * The locations for loading and storing files are determined by the typePrefix.
  * We use QStandardPaths with the GenericData type and create a filter string as such:
  * \li templates: typePrefix "/templates/"
  * \li descriptions: typePrefix "/template_descriptions/"
  *
  * Preview images are directly read from the archives on demand (or for legacy
  * template installations from typePrefix "/template_previews/").
  *
  * @sa ITemplateProvider::templatesModel()
  **/
 class KDEVPLATFORMLANGUAGE_EXPORT TemplatesModel
     : public QStandardItemModel
 {
     Q_OBJECT
 
 public:
 
     /**
      * Extra roles for template-specific properties
      * @sa Qt::ItemDataRole
      **/
     enum TemplateRole
     {
         DescriptionFileRole = Qt::UserRole + 1, ///< Template description file name
         PreviewIconRole = Qt::UserRole + 2, ///< Template preview icon, provides a TemplatePreviewIcon
         CommentRole = Qt::UserRole + 3, ///< Template comment
         ArchiveFileRole = Qt::UserRole + 4 ///< Template archive file name
     };
 
     /**
      * Creates a new templates model
      *
      * @param typePrefix the type prefix used to determine resource locations.
      * @param parent parent object, defaults to 0.
      **/
     explicit TemplatesModel(const QString& typePrefix, QObject* parent = nullptr);
 
     /**
      * Destructor
      *
      **/
     ~TemplatesModel() override;
 
     /**
      * Reloads all found templates
      **/
     virtual void refresh();
 
     /**
      * Loads template @p fileName and save it to the template storage directory.
      *
      * If the file is an archive, the whole archive will be copied.
      * If the file has a .desktop or .kdevtemplate suffix, the contents
      * of its containing directory will be archived and saved.
      **/
     QString loadTemplateFile(const QString& fileName);
 
     /**
      * Finds the model index of the template file @p fileName.
      *
      * For convenience, this function returns the found template index, as well as all of its ancestors.
      * The indexes are ordered from the top-level ancestor to the actual index of the template.
      * This is useful for managing selection when multiple views display different level of the model.
      *
      * @param fileName the template file name
      **/
     QModelIndexList templateIndexes(const QString& fileName) const;
 
     /**
      * Returns the type prefix used to find a template resource.
      **/
     QString typePrefix() const;
 
     /**
      * The model will include @p path during the search for template archives
      *
      * @param path Path to a directory that contains normal user data. The template model will search for a kdevappwizard/templates (or your model name prefix) directory
      * inside @p path and will use them. Please note that the path has to end with a '/'.
      */
     void addDataPath(const QString& path);
 
 private:
     const QScopedPointer<class TemplatesModelPrivate> d_ptr;
     Q_DECLARE_PRIVATE(TemplatesModel)
 };
 }
 
 #endif // KDEVPLATFORM_TEMPLATESMODEL_H