Subversion Repositories Scribus

Rev

Rev 2986 | Rev 3207 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

/*! This is the Scribus Short Words plugin interface specification.

This code is based on the Scribus-Vlna plug in rewritten for
international use.

\author Petr Vanek <petr@yarpen.cz>

This program is free software - see LICENSE file in the distribution
or documentation
*/


#ifndef _SCRIBUS_SHORTWORDS_H_
#define _SCRIBUS_SHORTWORDS_H_

#include "scconfig.h"
#include "pluginapi.h"
#include "configuration.h"
#include "parse.h"
#include "vlnadialog.h"
#include "pluginmanager.h"
#include "scribus.h"

/** Calls the Plugin with the main Application window as parent
and the main Application Class as parameter. Loads translator too.
*/

extern "C" PLUGIN_API void run(QWidget *d, ScribusApp *plug);


/** Returns the Name of the Plugin.
 This name appears in the relevant Menue-Entrys
 */

extern "C" PLUGIN_API QString name();


/** Returns the Type of the Plugin.
  \retval 1 = the Plugin is a normal Plugin, which appears in the Extras Menue
  */

extern "C" PLUGIN_API PluginManager::PluginType type();

/** Returns the Id of the Plugin.
  \retval 11 = id from the plugin registry
 */

extern "C" PLUGIN_API int ID();

extern "C" PLUGIN_API QString actionName();
extern "C" PLUGIN_API QString actionKeySequence();
extern "C" PLUGIN_API QString actionMenu();
extern "C" PLUGIN_API QString actionMenuAfterName();
extern "C" PLUGIN_API bool actionEnabledOnStartup();

class Parse;

/** \brief This is Short Words plugin main class.
It contains main logic. */

class ShortWords : public QObject
{
        Q_OBJECT

public:
        /** inicialization - Raise dialog, handles parsing etc. */
        ShortWords();
        /** clear memaory, write cfg. */
        ~ShortWords();

        /** actual page when user calls this plug */
        uint originalPage;
        /** All available configuration object */
        Config *cfg;
        /** all available "engine" */
        Parse *parse;
};


#endif