treeitem.h

Go to the documentation of this file.

/*
 * This file is part of KDevelop
 *
 * Copyright 2008 Vladimir Prus <[email protected]>
 *
 * 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; either version 2 of the
 * License, or (at your option) any later version.
 *
 * 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, write to the
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#ifndef KDEVPLATFORM_TREEITEM_H
#define KDEVPLATFORM_TREEITEM_H
 
#include <QVariant>
#include <QVector>
#include <QIcon>
 
#include <iostream>
 
#include <debugger/debuggerexport.h>
 
namespace KDevelop {
 
class TreeModel;
 
class KDEVPLATFORMDEBUGGER_EXPORT TreeItem: public QObject
{
    Q_OBJECT
public:
    ~TreeItem() override;
 
// FIXME: should be protected
public: // Methods that the derived classes should implement
 
    virtual void fetchMoreChildren()=0;
 
    virtual void setColumn(int index, const QVariant& data) { Q_UNUSED(index); Q_UNUSED(data); }
    void emitAllChildrenFetched();
 
protected: // Interface for derived classes
 
    explicit TreeItem(TreeModel* model, TreeItem *parent = nullptr);
 
    void setData(const QVector<QVariant> &data);
 
    void appendChild(TreeItem *child, bool initial = false);
 
    void insertChild(int position, TreeItem *child, bool initial = false);
 
    void removeChild(int index);
 
    void removeSelf();
 
    void deleteChildren();
 
    void reportChange();
    void reportChange(int column);
 
    void clear();
 
    void setHasMore(bool more);
 
    void setHasMoreInitial(bool more);
 
    TreeModel* model() { return model_; }
 
    bool isExpanded() const { return expanded_; }
 
Q_SIGNALS:
    void expanded();
    void collapsed();
    void allChildrenFetched();
 
protected: // Backend implementation of Model/View
    friend class TreeModel;
 
    TreeItem *child(int row);
    int childCount() const;
    int columnCount() const;
    virtual QVariant data(int column, int role) const;
    int row() const;
    TreeItem *parent();
    bool hasMore() const { return more_; }
    void setExpanded(bool b);
 
    virtual void clicked() {}
    virtual QVariant icon(int column) const;
 
protected:
    QVector<TreeItem*> childItems;
    QVector<QVariant> itemData;
    TreeItem *parentItem;
    TreeModel *model_;
    bool more_;
    TreeItem *ellipsis_;
    bool expanded_;
};
 
}
 
#endif