kde-workspace/kinfocenter/kcmtreeitem.h
2014-11-13 19:30:51 +02:00

165 lines
3.1 KiB
C++

/*
* kcmtreeitem.h
*
* Copyright (C) 2010 David Hubner <hubnerd@ntlworld.com>
*
* 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 KCMTREEITEM
#define KCMTREEITEM
//KDE
#include <KCModuleInfo>
#include <KIcon>
//QT
#include <QList>
#include <QString>
class KcmTreeItem
{
public:
/**
* KCM Tree Item for InfoKcmModel. Holds information about a KCM
*
* @param module pointer to KCM module
* @param parent objects parent
*/
explicit KcmTreeItem(const KService::Ptr module, KcmTreeItem *parent=0);
/**
* KCM Tree Item for InfoKcmModel. Holds information about a KCM
*
* @note Used for root folder objects
*
*/
KcmTreeItem();
/**
* Enumeration of the possible tree item types
*
*/
enum itemType { KCM=0, CATEGORY };
/**
* Destory KcmTreeItem
*/
virtual ~KcmTreeItem();
/**
* Add child tree item to parent
*/
void addChild(KcmTreeItem *);
/**
* Get child tree item
*
* @param row row where child is located
*/
KcmTreeItem *child(const int row);
/**
* Get amount of children
*/
int childCount();
/**
* Get parent of current tree item
*/
KcmTreeItem *parent();
/**
* Get index of tree item
*/
int indexOf(KcmTreeItem *);
/**
* Get amount of columns that tree item contains.
* Hardcoded to 1
*/
int columnCount();
/**
* Get row of tree item
*/
int row();
/**
* Get data of tree item
*/
virtual QString data() const;
/**
* Get category of tree item.
* Set in X-KDE-KInfoCenter-Category
*/
virtual QString category() const;
/**
* Gets the item type.
*/
virtual itemType type() const;
/**
* Check if children of tree item contains a category.
* Used in search implementation
*/
KcmTreeItem *containsCategory(const QString&);
/**
* Get tree item KCMs Data
*/
virtual KCModuleInfo kcm() const;
/**
* Get tree items KCM's weight
*/
virtual int weight();
/**
* Get icon tied to KCM
*/
virtual KIcon icon() const;
/**
* Get whatsThis information from KCM
*/
virtual QString whatsThis() const;
/**
* Check if there are any children tree items keywords that
* have a certain regexp pattern
*/
bool childrenRegExp(const QRegExp& pattern);
/**
* Get KCM tree item keywords
*/
virtual QStringList keywords() const;
protected:
QList<KcmTreeItem *> m_children;
KcmTreeItem *m_parent;
const KService::Ptr m_module;
const KCModuleInfo *m_moduleInfo;
};
#endif // KCMTREEITEM