mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-25 03:12:49 +00:00
248 lines
9.5 KiB
C++
248 lines
9.5 KiB
C++
/***************************************************************************
|
|
* 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 {
|
|
|
|
/**
|
|
* The ActionCollection class manages collections of \a Action instances.
|
|
* An ActionCollection can have both actions and other collections as children.
|
|
* Child actions can be accessed using actions() which returns a list of Action pointers.
|
|
* Child collections can be accessed using collections() which returns a list of collection names.
|
|
* The collection can then be accessed with collection(name).
|
|
* To add a child action, call addAction(), and to remove an action: removeAction().
|
|
* To add a child collection, call setParentCollection(parent) in the collection you want to add to parent.
|
|
* To remove a collection call setParentCollection(0).
|
|
* NOTE: Do not use setParent().
|
|
*/
|
|
class KROSSCORE_EXPORT ActionCollection : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* \param name The objectName the ActionCollection has.
|
|
* \param parent The parent ActionCollection this
|
|
* ActionCollection will be child of. If parent is not
|
|
* NULL, this \a ActionCollection instance will register
|
|
* itself as child of the parent \p parent by using the
|
|
* \a setParentCollection method.
|
|
*/
|
|
explicit ActionCollection(const QString& name, ActionCollection* parent = 0);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~ActionCollection();
|
|
|
|
/**
|
|
* \return the objectName for this ActionCollection.
|
|
*/
|
|
QString name() const;
|
|
|
|
/**
|
|
* \return the display text
|
|
*/
|
|
QString text() const;
|
|
|
|
/**
|
|
* Set the display text to \p text .
|
|
*/
|
|
void setText(const QString& text);
|
|
|
|
/**
|
|
* \return the optional description for this ActionCollection.
|
|
*/
|
|
QString description() const;
|
|
|
|
/**
|
|
* Set the optional description for this ActionCollection.
|
|
*/
|
|
void setDescription(const QString& description);
|
|
|
|
/**
|
|
* \return the name of the icon.
|
|
*/
|
|
QString iconName() const;
|
|
|
|
/**
|
|
* Set the name of the icon to \p iconname .
|
|
*/
|
|
void setIconName(const QString& iconname);
|
|
|
|
/**
|
|
* \return the icon defined with \p setIconName() .
|
|
*/
|
|
QIcon icon() const;
|
|
|
|
/**
|
|
* Return the enable this ActionCollection has.
|
|
*/
|
|
bool isEnabled() const;
|
|
|
|
/**
|
|
* Enable or disable this ActionCollection.
|
|
*/
|
|
void setEnabled(bool enabled);
|
|
|
|
/**
|
|
* \return the parent \a ActionCollection instance this
|
|
* \collection is child of or NULL if this collection
|
|
* does not have a parent.
|
|
*/
|
|
ActionCollection* parentCollection() const;
|
|
/// Set the parent to @p parent. NOTE: Do not use setParent().
|
|
void setParentCollection( ActionCollection *parent );
|
|
/**
|
|
* \return true if this collection has a child \a ActionCollection
|
|
* instance which objectName is \p name .
|
|
*/
|
|
bool hasCollection(const QString& name) const;
|
|
|
|
/**
|
|
* \return the \a ActionCollection instance which objectName is
|
|
* \p name or NULL if there exists no such \a ActionCollection .
|
|
*/
|
|
ActionCollection* collection(const QString& name) const;
|
|
|
|
/**
|
|
* \return a list of names of child \a ActionCollection instances
|
|
* this collection has
|
|
*/
|
|
QStringList collections() const;
|
|
|
|
QList<Action*> actions() const;
|
|
|
|
/**
|
|
* \return action with given name or 0 if it wasn't found
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
* Load child \a Action and \a ActionCollection instances this
|
|
* collection has from the \p element .
|
|
*
|
|
* \param element The QDomElement that contains the XML.
|
|
* \param directory The current directory used for relative paths
|
|
* defined within a script-tag for the file-attribute. If the
|
|
* directory is QDir() relative paths are not resolved.
|
|
* \return true on success else false.
|
|
*/
|
|
bool readXml(const QDomElement& element, const QDir& directory = QDir());
|
|
bool readXml(const QDomElement& element, const QStringList& searchPath/* = QStringList()*/);
|
|
|
|
/**
|
|
* Read XML from the QIODevice \p device .
|
|
*/
|
|
bool readXml(QIODevice* device, const QDir& directory = QDir());
|
|
bool readXml(QIODevice* device, const QStringList& searchPath/* = QStringList()*/);
|
|
|
|
/**
|
|
* Read the XML from the file \p file .
|
|
*
|
|
* \param file The existing XML file that should be read.
|
|
* \return true if reading was successful else false.
|
|
*/
|
|
bool readXmlFile(const QString& file);
|
|
|
|
/**
|
|
* \return a QDomElement that represents the child \a Action
|
|
* and \a ActionCollection instances this collection has.
|
|
*/
|
|
QDomElement writeXml();
|
|
QDomElement writeXml(const QStringList& searchPath/* = QStringList()*/);
|
|
|
|
|
|
/**
|
|
* Write XML to the QIODevice \p device and use a space-idention
|
|
* of \p indent for the XML.
|
|
*/
|
|
bool writeXml(QIODevice* device, int indent = 2);
|
|
bool writeXml(QIODevice* device, int indent/* = 2*/, const QStringList& searchPath/* = QStringList()*/);
|
|
|
|
|
|
Q_SIGNALS:
|
|
|
|
/**
|
|
* This signal is emitted if the content of the ActionCollection
|
|
* was changed.
|
|
*/
|
|
void updated();
|
|
|
|
/// This signal is emitted when the data of a child action is changed
|
|
void dataChanged(Action*);
|
|
/// This signal is emitted when the data of the ActionCollection is changed
|
|
void dataChanged(ActionCollection*);
|
|
|
|
/// This signal is emitted just before @p child is added to @p parent
|
|
void collectionToBeInserted(ActionCollection* child, ActionCollection* parent);
|
|
/// This signal is emitted after @p child has been added to @p parent
|
|
void collectionInserted(ActionCollection* child, ActionCollection* parent);
|
|
/// This signal is emitted before @p child is removed from @p parent
|
|
void collectionToBeRemoved(ActionCollection* child, ActionCollection* parent);
|
|
/// This signal is emitted after @p child has been removed from @p parent
|
|
void collectionRemoved(ActionCollection* child, ActionCollection* parent);
|
|
|
|
/// This signal is emitted just before @p child is added to @p parent
|
|
void actionToBeInserted(Action* child, ActionCollection* parent);
|
|
/// This signal is emitted after @p child has been added to @p parent
|
|
void actionInserted(Action* child, ActionCollection* parent);
|
|
/// This signal is emitted before @p child is removed from @p parent
|
|
void actionToBeRemoved(Action* child, ActionCollection* parent);
|
|
/// This signal is emitted after @p child has been removed from @p 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:
|
|
/// \internal d-pointer class.
|
|
class Private;
|
|
/// \internal d-pointer instance.
|
|
Private* const d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|