sneedmc/api/logic/InstanceList.h

106 lines
2.7 KiB
C
Raw Normal View History

2018-02-10 23:40:01 +00:00
/* Copyright 2013-2018 MultiMC Contributors
2013-01-14 23:42:38 +00:00
*
* 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
*
2013-01-14 23:42:38 +00:00
* 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.
*/
#pragma once
2013-01-14 23:42:38 +00:00
2013-02-15 04:40:00 +00:00
#include <QObject>
#include <QAbstractListModel>
#include <QSet>
2016-10-02 22:55:54 +00:00
#include <QList>
2013-02-15 04:40:00 +00:00
2015-02-09 00:51:14 +00:00
#include "BaseInstance.h"
2016-10-02 22:55:54 +00:00
#include "BaseInstanceProvider.h"
2013-02-15 04:40:00 +00:00
#include "multimc_logic_export.h"
2016-10-02 22:55:54 +00:00
#include "QObjectPtr.h"
class BaseInstance;
class MULTIMC_LOGIC_EXPORT InstanceList : public QAbstractListModel
2013-01-14 23:42:38 +00:00
{
2013-02-15 04:40:00 +00:00
Q_OBJECT
2013-01-14 23:42:38 +00:00
public:
explicit InstanceList(QObject *parent = 0);
virtual ~InstanceList();
public:
QModelIndex index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const;
int rowCount(const QModelIndex &parent = QModelIndex()) const;
QVariant data(const QModelIndex &index, int role) const;
Qt::ItemFlags flags(const QModelIndex &index) const;
enum AdditionalRoles
{
GroupRole = Qt::UserRole,
2014-03-30 18:11:05 +00:00
InstancePointerRole = 0x34B1CB48, ///< Return pointer to real instance
InstanceIDRole = 0x34B1CB49 ///< Return id if the instance
};
2013-02-19 18:15:22 +00:00
/*!
* \brief Error codes returned by functions in the InstanceList class.
* NoError Indicates that no error occurred.
* UnknownError indicates that an unspecified error occurred.
*/
enum InstListError
{
NoError = 0,
UnknownError
};
2013-03-18 22:00:46 +00:00
InstancePtr at(int i) const
{
return m_instances.at(i);
}
2013-03-18 22:00:46 +00:00
int count() const
{
return m_instances.count();
}
2016-10-02 22:55:54 +00:00
InstListError loadList(bool complete = false);
void saveNow();
2016-10-02 22:55:54 +00:00
/// Add an instance provider. Takes ownership of it. Should only be done before the first load.
void addInstanceProvider(BaseInstanceProvider * provider);
InstancePtr getInstanceById(QString id) const;
QModelIndex getInstanceIndexById(const QString &id) const;
QStringList getGroups();
2015-02-01 02:08:25 +00:00
void deleteGroup(const QString & name);
2013-03-18 22:00:46 +00:00
signals:
void dataIsInvalid();
private slots:
void propertiesChanged(BaseInstance *inst);
2016-10-02 22:55:54 +00:00
void groupsPublished(QSet<QString>);
void providerUpdated();
private:
int getInstIndex(BaseInstance *inst) const;
2016-10-02 22:55:54 +00:00
void suspendWatch();
void resumeWatch();
void add(const QList<InstancePtr> &list);
2013-02-19 18:15:22 +00:00
protected:
2016-10-02 22:55:54 +00:00
int m_watchLevel = 0;
QSet<BaseInstanceProvider *> m_updatedProviders;
QList<InstancePtr> m_instances;
QSet<QString> m_groups;
2016-10-02 22:55:54 +00:00
QVector<shared_qobject_ptr<BaseInstanceProvider>> m_providers;
2013-01-14 23:42:38 +00:00
};