You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdebindings/kjsembed/xmlactionclient.h

233 lines
6.3 KiB

// -*- c++ -*-
/*
* Copyright (C) 2002-2003, Richard J. Moore <rich@kde.org>
*
* This library 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 library 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 library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef XMLACTIONCLIENT_H
#define XMLACTIONCLIENT_H
#include <tqobject.h>
#include <tqxml.h>
#include <tqmap.h>
class TDEActionCollection;
class TDEAction;
namespace KJSEmbed {
class XMLActionHandler;
class XMLActionRunner;
class XMLActionScript;
/**
* Loads actions from an XML file using SAX.
*
* @author Richard Moore, rich@kde.org
*/
class XMLActionClient : public TQObject
{
Q_OBJECT
public:
/**
* Represents a script.
*/
struct XMLActionScript
{
XMLActionScript() {}
XMLActionScript( const XMLActionScript &self )
: src(self.src), type(self.type), text(self.text) {}
~XMLActionScript() {}
/** Returns true iff this instance holds a valid script. */
bool isValid() const { return !type.isEmpty(); }
/**
* Clears this script object. After this method has been called,
* isValid() will return false.
*/
void clear() { src = type = text = TQString::null; }
TQString src;
TQString type;
TQString text;
};
/** Creates an XMLActionClient. */
XMLActionClient( TQObject *parent=0, const char *name=0 );
/**
* Cleans up. When the object is deleted, any actions it has created will
* also be deleted.
*/
virtual ~XMLActionClient();
/** Returns the TDEActionCollection that the actions will be added to. */
TDEActionCollection *actionCollection() const { return ac; }
/** Sets the TDEActionCollection that the actions will be added to. */
void setActionCollection( TDEActionCollection *acts ) { ac = acts; }
/** Returns the runner for this XMLActionClient. */
XMLActionRunner *runner() const { return actrun; }
/** Sets the runner for this XMLActionClient. */
void setRunner( XMLActionRunner *r ) { actrun = r; }
/** Loads actions from the named XML file. Returns true on success. */
bool load( const TQString &filename );
/** Loads actions from the named XML file. Returns true on success. */
bool load( XMLActionHandler *handler, const TQString &filename );
/** Runs the named script. */
bool run( const TQString &name );
/** Returns the named script. */
XMLActionScript script( const TQString &name ) const { return scripts[name]; }
/** Calls XMLActionRunner::run(). */
bool run( const XMLActionScript &script );
/** Binds a name to a script. */
virtual bool bind( const TQString &name, const XMLActionScript &script );
/** Binds an action to a script. */
virtual bool bind( TDEAction *act, const XMLActionScript &script );
protected slots:
/**
* Called when a bound action is activated to invoke the script with the
* sender's name.
*/
void action_activated();
private:
TDEActionCollection *ac;
XMLActionRunner *actrun;
TQMap<TQString, XMLActionScript> scripts;
class XMLActionClientPrivate *d;
};
/**
* Abstract class implemented by classes that can run scripts.
*
* @see XMLActionClient
* @author Richard Moore, rich@kde.org
*/
class XMLActionRunner
{
public:
/**
* This method should be reimplemented to execute the specified script.
*
* @return true if the script was executed successfully, false otherwise.
*/
virtual bool run( XMLActionClient *client, const XMLActionClient::XMLActionScript &script );
};
/**
* SAX handler for loading actions from XML.
*
* The following tags are supported:
* <pre>
* actionset ( header? action* )
* header ( name | label | icons | script )
* action ( (header | name | label | icons | shortcut | group |
* whatsthis | statustext | type | script | data)+ )
* type ( #CDATA )
* label ( #CDATA | text )
* icons ( #CDATA )
* shortcut ( #CDATA | text )
* whatsthis ( #CDATA | text )
* group ( #CDATA )
* exclusive defaults to false
* name ( #CDATA )
* text ( #CDATA )
* data ( item+ )
* item ( #CDATA | text )
* script ( #CDATA )
* type type of script
* src url of script file (optional)
* </pre>
*
* Unknown tags are ignored, so subclasses can define new ones if they
* want to store additional data.
*
* @author Richard Moore, rich@kde.org
*/
class XMLActionHandler : public TQXmlDefaultHandler
{
public:
XMLActionHandler( XMLActionClient *actclient );
virtual bool startElement( const TQString &ns, const TQString &ln, const TQString &qn,
const TQXmlAttributes &attrs );
virtual bool endElement( const TQString &ns, const TQString &ln, const TQString &qn );
virtual bool characters( const TQString &chars );
/** Called when an action tag is closed. */
void defineAction();
XMLActionClient *client() const { return actclient; }
/** Creates a TDEAction based on the values read from the XML. */
virtual TDEAction *createAction( TDEActionCollection *parent );
private:
/**
* Structure containing information gathered about an action.
*/
struct XMLActionData {
XMLActionData() { clear(); }
void clear() {
text = icons = keys = name = group = whatsthis = status = TQString::null;
exclusive = false;
script.clear();
}
TQString type;
TQString text;
TQString icons;
TQString keys;
TQString name;
TQString group;
bool exclusive;
TQString status;
TQString whatsthis;
XMLActionClient::XMLActionScript script;
TQStringList items;
};
XMLActionData *actionData() { return &ad; }
private:
XMLActionClient *actclient;
TQString cdata;
bool inAction;
XMLActionData ad;
class XMLActionHandlerPrivate *d;
};
} // namespace KJSEmbed
#endif // XMLACTIONCLIENT_H