blob: b6a088425c9b9681bd759b66a38c50bf1a0ea370 (
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/* $Id$ */
/** @file
* VBox Qt GUI - UIChooserNode class declaration.
*/
/*
* Copyright (C) 2012-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef FEQT_INCLUDED_SRC_manager_chooser_UIChooserNode_h
#define FEQT_INCLUDED_SRC_manager_chooser_UIChooserNode_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/* Qt includes: */
#include <QObject>
#include <QPointer>
#include <QString>
/* GUI includes: */
#include "QIWithRetranslateUI.h"
#include "UIChooserDefs.h"
#include "UIChooserItem.h"
/* Forward declaration: */
class UIChooserAbstractModel;
class UIChooserNodeGroup;
class UIChooserNodeGlobal;
class UIChooserNodeMachine;
/** QObject subclass used as interface for invisible tree-view nodes.
* These nodes can be of three types (group, global and machine node).
* They can be used to compose a tree of nodes loaded from VBox setting. */
class UIChooserNode : public QIWithRetranslateUI3<QObject>
{
Q_OBJECT;
public:
/** Constructs chooser node passing @a pParent to the base-class.
* @param fFavorite Brings whether the node is favorite. */
UIChooserNode(UIChooserNode *pParent = 0, bool fFavorite = false);
/** Destructs chooser node. */
virtual ~UIChooserNode() RT_OVERRIDE;
/** Returns RTTI node type. */
virtual UIChooserNodeType type() const = 0;
/** Casts node to group one. */
UIChooserNodeGroup *toGroupNode();
/** Casts node to global one. */
UIChooserNodeGlobal *toGlobalNode();
/** Casts node to machine one. */
UIChooserNodeMachine *toMachineNode();
/** Returns parent node reference. */
UIChooserNode *parentNode() const { return m_pParent; }
/** Returns whether node is of root kind. */
bool isRoot() const { return !m_pParent; }
/** Returns root node reference. */
UIChooserNode *rootNode() const;
/** Returns whether the node is favorite. */
bool isFavorite() const { return m_fFavorite; }
/** Defines whether the node is @a fFavorite. */
void setFavorite(bool fFavorite) { m_fFavorite = fFavorite; }
/** Defines the @a pModel reference. */
void setModel(UIChooserAbstractModel *pModel) { m_pModel = pModel; }
/** Returns the model reference. */
UIChooserAbstractModel *model() const;
/** Returns node name. */
virtual QString name() const = 0;
/** Returns full node name. */
virtual QString fullName() const = 0;
/** Returns item description. */
virtual QString description() const = 0;
/** Returns item definition.
* @param fFull Brings whether full definition is required
* which is used while saving group definitions,
* otherwise short definition will be returned,
* which is used while saving last chosen node. */
virtual QString definition(bool fFull = false) const = 0;
/** Returns whether there are children of certain @a enmType. */
virtual bool hasNodes(UIChooserNodeType enmType = UIChooserNodeType_Any) const = 0;
/** Returns a list of nodes of certain @a enmType. */
virtual QList<UIChooserNode*> nodes(UIChooserNodeType enmType = UIChooserNodeType_Any) const = 0;
/** Adds passed @a pNode to specified @a iPosition. */
virtual void addNode(UIChooserNode *pNode, int iPosition) = 0;
/** Removes passed @a pNode. */
virtual void removeNode(UIChooserNode *pNode) = 0;
/** Removes all children with specified @a uId recursively. */
virtual void removeAllNodes(const QUuid &uId) = 0;
/** Updates all children with specified @a uId recursively. */
virtual void updateAllNodes(const QUuid &uId) = 0;
/** Returns node position. */
int position();
/** Returns position of specified node inside this one. */
virtual int positionOf(UIChooserNode *pNode) = 0;
/** Defines linked @a pItem. */
void setItem(UIChooserItem *pItem) { m_pItem = pItem; }
/** Returns linked item. */
UIChooserItem *item() const { return m_pItem.data(); }
/** Performs search wrt. @a strSearchTerm and @a iSearchFlags and updates @a matchedItems. For an empty
* @a strSearchTerm all items are added wrt. node type from @a iSearchFlags. */
virtual void searchForNodes(const QString &strSearchTerm, int iSearchFlags, QList<UIChooserNode*> &matchedItems) = 0;
/** Performs sorting of children nodes. */
virtual void sortNodes() = 0;
/** Returns if node is disabled. */
bool isDisabled() const;
/** Sets the disabled flag. */
void setDisabled(bool fDisabled);
protected:
/** Holds the parent node reference. */
UIChooserNode *m_pParent;
/** Holds whether the node is favorite. */
bool m_fFavorite;
/** Holds the model reference. */
UIChooserAbstractModel *m_pModel;
/** Holds the linked item reference. */
QPointer<UIChooserItem> m_pItem;
/** Holds item description. */
QString m_strDescription;
/** Holds the flag to indicate whether the node is disabled or not. */
bool m_fDisabled;
};
#endif /* !FEQT_INCLUDED_SRC_manager_chooser_UIChooserNode_h */
|
