actioncollection.h

Go to the documentation of this file.

/***************************************************************************
 * actioncollection.h
 * This file is part of the KDE project
 * copyright (C)2004-2007 by Sebastian Sauer (mail@dipe.org)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef KROSS_ACTIONCOLLECTION_H
#define KROSS_ACTIONCOLLECTION_H

#include "krossconfig.h"
#include "action.h"

#include <QtCore/QObject>
#include <QtCore/QDir>

class QDomElement;
class QIODevice;

namespace Kross {

    class KROSSCORE_EXPORT ActionCollection : public QObject
    {
            Q_OBJECT

        public:

            explicit ActionCollection(const QString& name, ActionCollection* parent = 0);

            virtual ~ActionCollection();

            QString name() const;

            QString text() const;

            void setText(const QString& text);

            QString description() const;

            void setDescription(const QString& description);

            QString iconName() const;

            void setIconName(const QString& iconname);

            QIcon icon() const;

            bool isEnabled() const;

            void setEnabled(bool enabled);

            ActionCollection* parentCollection() const;
            void setParentCollection( ActionCollection *parent );
            bool hasCollection(const QString& name) const;

            ActionCollection* collection(const QString& name) const;

            QStringList collections() const;

            QList<Action*> actions() const;

            Action* action(const QString& name) const;
            void addAction(Action* action);
            void addAction(const QString& name, Action* action);
            void removeAction(const QString& name);
            void removeAction(Action* action);

            bool readXml(const QDomElement& element, const QDir& directory = QDir());
            bool readXml(const QDomElement& element, const QStringList& searchPath/* = QStringList()*/);

            bool readXml(QIODevice* device, const QDir& directory = QDir());
            bool readXml(QIODevice* device, const QStringList& searchPath/* = QStringList()*/);

            bool readXmlFile(const QString& file);

            QDomElement writeXml();
            QDomElement writeXml(const QStringList& searchPath/* = QStringList()*/);


            bool writeXml(QIODevice* device, int indent = 2);
            bool writeXml(QIODevice* device, int indent/* = 2*/, const QStringList& searchPath/* = QStringList()*/);


        Q_SIGNALS:

            void updated();

            void dataChanged(Action*);
            void dataChanged(ActionCollection*);

            void collectionToBeInserted(ActionCollection* child, ActionCollection* parent);
            void collectionInserted(ActionCollection* child, ActionCollection* parent);
            void collectionToBeRemoved(ActionCollection* child, ActionCollection* parent);
            void collectionRemoved(ActionCollection* child, ActionCollection* parent);

            void actionToBeInserted(Action* child, ActionCollection* parent);
            void actionInserted(Action* child, ActionCollection* parent);
            void actionToBeRemoved(Action* child, ActionCollection* parent);
            void actionRemoved(Action* child, ActionCollection* parent);

        protected:
            void registerCollection(ActionCollection* collection);
            void unregisterCollection(const QString& name);
            void connectSignals(ActionCollection* collection, bool conn);
            void connectSignals(Action* collection, bool conn);

        private Q_SLOTS:
            void emitUpdated();

        private:
            class Private;
            Private* const d;
    };

}

#endif