kmail/snippetitem.h

/***************************************************************************
 *   snippet feature from kdevelop/plugins/snippet/                        *
 *                                                                         * 
 *   Copyright (C) 2007 by Robert Gruber                                   *
 *   rgruber@users.sourceforge.net                                         *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SNIPPETITEM_H
#define SNIPPETITEM_H

#include <qlistview.h>
#include <QTreeWidgetItem>
#include <klocale.h>

#include <qobject.h>

class QString;
class KAction;
class SnippetGroup;


/**
This class represents one CodeSnippet-Item in the listview.
It also holds the needed data for one snippet.
@author Robert Gruber
*/
class SnippetItem : public QObject, public QTreeWidgetItem {
friend class SnippetGroup;

    Q_OBJECT
public:
    SnippetItem(QTreeWidgetItem * parent, const QString &name, const QString &text);

    ~SnippetItem();
    QString getName() const;
    QString getText() const;
    using QTreeWidgetItem::parent;
    int getParent() const { return iParent; }
    void resetParent();
    void setText(const QString &text);
    void setName(const QString &name);
    static SnippetItem *findItemByName(const QString &name, const QList<SnippetItem * > &list);
    static SnippetGroup *findGroupById(int id, const QList<SnippetItem * > &list);
    void setAction( KAction* );
    KAction* getAction() const;

signals:
    void execute( QTreeWidgetItem * );
public slots:
    void slotExecute();

private:
  SnippetItem( QTreeWidget *parent, const QString &name, const QString &text );
  QString strName;
  QString strText;
  int iParent;
  KAction *action;
};

/**
This class represents one group in the listview.
It is derived from SnippetItem in order to allow storing 
it in the main QList<SnippetItem*>.
@author Robert Gruber
*/
class SnippetGroup : public SnippetItem {
public:
    SnippetGroup( QTreeWidget *parent, const QString &name, int id );
    ~SnippetGroup();

    int getId() { return iId; }
    static int getMaxId() { return iMaxId; }

    void setId(int id);

private:
    static int iMaxId;
    int iId;
};

#endif