summaryrefslogtreecommitdiffstats
path: root/libmultimc/include/instancetypeinterface.h
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2013-07-28 08:40:15 +0200
committerPetr Mrázek <peterix@gmail.com>2013-07-28 08:40:15 +0200
commit9d99b539bfaabe45a43948edf37e900401288f65 (patch)
treeb583a7649dfa59597f352a41ed641b373f130436 /libmultimc/include/instancetypeinterface.h
parenta7a84d4dbb58565f108cb0886da6cb786e34d10d (diff)
downloadMultiMC-9d99b539bfaabe45a43948edf37e900401288f65.tar
MultiMC-9d99b539bfaabe45a43948edf37e900401288f65.tar.gz
MultiMC-9d99b539bfaabe45a43948edf37e900401288f65.tar.lz
MultiMC-9d99b539bfaabe45a43948edf37e900401288f65.tar.xz
MultiMC-9d99b539bfaabe45a43948edf37e900401288f65.zip
Parsing the version files, part IV
Also, start of big refactors.
Diffstat (limited to 'libmultimc/include/instancetypeinterface.h')
-rw-r--r--libmultimc/include/instancetypeinterface.h94
1 files changed, 0 insertions, 94 deletions
diff --git a/libmultimc/include/instancetypeinterface.h b/libmultimc/include/instancetypeinterface.h
deleted file mode 100644
index 4fbc2593..00000000
--- a/libmultimc/include/instancetypeinterface.h
+++ /dev/null
@@ -1,94 +0,0 @@
-/* Copyright 2013 MultiMC Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef INSTANCETYPE_H
-#define INSTANCETYPE_H
-
-#include <QObject>
-
-#include "instanceloader.h"
-
-class InstVersionList;
-
-//! The InstanceTypeInterface's interface ID.
-#define InstanceTypeInterface_IID "net.forkk.MultiMC.InstanceTypeInterface/0.1"
-
-/*!
- * \brief The InstanceType class is an interface for all instance types.
- * InstanceTypes are usually provided by plugins.
- * It handles loading and creating instances of a certain type. There should be
- * one of these for each type of instance and they should be registered with the
- * InstanceLoader.
- * To create an instance, the InstanceLoader calls the type's createInstance()
- * function. Loading is done through the loadInstance() function.
- */
-class InstanceTypeInterface
-{
-public:
- friend class InstanceLoader;
-
- /*!
- * \brief Gets the ID for this instance type.
- * The type ID should be unique as it is used to identify the type
- * of instances when they are loaded.
- * Changing this value at runtime results in undefined behavior.
- * \return This instance type's ID string.
- */
- virtual QString typeID() const = 0;
-
- /*!
- * \brief Gets the name of this instance type as it is displayed to the user.
- * \return The instance type's display name.
- */
- virtual QString displayName() const = 0;
-
- /*!
- * \brief Gets a longer, more detailed description of this instance type.
- * \return The instance type's description.
- */
- virtual QString description() const = 0;
-
- /*!
- * \brief Gets the version list for this instance type.
- * \return A pointer to this instance type's version list.
- */
- virtual InstVersionList *versionList() const = 0;
-
-protected:
- /*!
- * \brief Creates an instance and stores it in inst.
- * \param inst Pointer to store the created instance in.
- * \param instDir The instance's directory.
- * \return An InstTypeError error code.
- * TypeNotRegistered if the given type is not registered with the InstanceLoader.
- * InstExists if the given instance directory is already an instance.
- */
- virtual InstanceLoader::InstLoaderError createInstance(Instance *&inst, const QString &instDir) const = 0;
-
- /*!
- * \brief Loads an instance from the given directory.
- * \param inst Pointer to store the loaded instance in.
- * \param instDir The instance's directory.
- * \return An InstTypeError error code.
- * TypeNotRegistered if the given type is not registered with the InstanceLoader.
- * NotAnInstance if the given instance directory isn't a valid instance.
- * WrongInstType if the given instance directory's type isn't an instance of this type.
- */
- virtual InstanceLoader::InstLoaderError loadInstance(Instance *&inst, const QString &instDir) const = 0;
-};
-
-Q_DECLARE_INTERFACE(InstanceTypeInterface, InstanceTypeInterface_IID)
-
-#endif // INSTANCETYPE_H