summaryrefslogtreecommitdiffstats
path: root/logic/lists/MojangAccountList.h
blob: ce16d70d612d9a20417abdd5506f7d4e4ae938b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/* 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.
 */

#pragma once

#include <QObject>
#include <QVariant>
#include <QAbstractListModel>
#include <QSharedPointer>

#include "logic/auth/MojangAccount.h"


/*!
 * \brief List of available Mojang accounts.
 * This should be loaded in the background by MultiMC on startup.
 *
 * This class also inherits from QAbstractListModel. Methods from that
 * class determine how this list shows up in a list view. Said methods
 * all have a default implementation, but they can be overridden by subclasses to
 * change the behavior of the list.
 */
class MojangAccountList : public QAbstractListModel
{
	Q_OBJECT
public:
	enum ModelRoles
	{
		PointerRole = 0x34B1CB48
	};

	enum VListColumns
	{
		// TODO: Add icon column.
		// First column - Name
		NameColumn = 0,
	};

	explicit MojangAccountList(QObject *parent = 0);

	//! Gets the account at the given index.
	virtual const MojangAccountPtr at(int i) const;

	//! Returns the number of accounts in the list.
	virtual int count() const;

	//////// List Model Functions ////////
	virtual QVariant data(const QModelIndex &index, int role) const;
	virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const;
	virtual int rowCount(const QModelIndex &parent) const;
	virtual int columnCount(const QModelIndex &parent) const;

	/*!
	 * Adds a the given Mojang account to the account list.
	 */
	virtual void addAccount(const MojangAccountPtr account);

	/*!
	 * Removes the mojang account with the given username from the account list.
	 */
	virtual void removeAccount(const QString& username);

	/*!
	 * \brief Finds an account by its username.
	 * \param The username of the account to find.
	 * \return A const pointer to the account with the given username. NULL if
	 * one doesn't exist.
	 */
	virtual MojangAccountPtr findAccount(const QString &username);

signals:
	/*!
	 * Signal emitted to indicate that the account list has changed.
	 * This will also fire if the value of an element in the list changes (will be implemented later).
	 */
	void listChanged();

protected:
	QList<MojangAccountPtr> m_accounts;

protected
slots:
	/*!
	 * Updates this list with the given list of accounts.
	 * This is done by copying each account in the given list and inserting it
	 * into this one.
	 * We need to do this so that we can set the parents of the accounts are set to this
	 * account list. This can't be done in the load task, because the accounts the load
	 * task creates are on the load task's thread and Qt won't allow their parents
	 * to be set to something created on another thread.
	 * To get around that problem, we invoke this method on the GUI thread, which
	 * then copies the accounts and sets their parents correctly.
	 * \param accounts List of accounts whose parents should be set.
	 */
	virtual void updateListData(QList<MojangAccountPtr> versions);
};