See scplugin.h and pluginmanager.{cpp,h} for detail on what these methods do. That documentatation is not duplicated here. Please don't implement the functionality of your plugin here; do that in mypluginimpl.h and mypluginimpl.cpp. More...

#include <hunspellplugin.h>

Inheritance diagram for HunspellPlugin:

[legend]

Collaboration diagram for HunspellPlugin:

[legend]

Public Member Functions
	HunspellPlugin ()
	Standard plugin implementation.

virtual bool	run (ScribusDoc *doc, QString target=QString::null)
	main method to run the plug

virtual bool	run (QWidget p, ScribusDoc doc, QString target=QString::null)
	Run the plug-in's main action. More...

virtual const QString	fullTrName () const
	Plug-in's human-readable, translated name. More...

virtual const AboutData *	getAboutData () const
	Return descriptive information about the plug-in. More...

virtual void	deleteAboutData (const AboutData *about) const

virtual void	languageChange ()
	Update all user-visible text to reflect current UI language. More...

virtual void	addToMainWindowMenu (ScribusMainWindow *)
	Allow plugins to add to a main menu.

Public Member Functions inherited from ScActionPlugin
	ScActionPlugin ()
	ctor More...

virtual	~ScActionPlugin ()=0
	Pure virtual dtor - abstract class.

const ActionInfo &	actionInfo () const

virtual bool	handleSelection (ScribusDoc *doc, int SelectedType=-1)
	handle the documents selection. More...

Public Member Functions inherited from ScPlugin
	ScPlugin ()
	ctor, returns a new ScPlugin instance More...

virtual	~ScPlugin ()=0
	Destroy the ScPlugin instance. More...

virtual bool	newPrefsPanelWidget (QWidget parent, PrefsPanel &panel, QString &caption, QPixmap &icon)
	Create and return a prefs UI panel for the plugin. More...

virtual bool	newPrefsPanelWidget (QWidget parent, Prefs_Pane &panel, QString &caption, QPixmap &icon)

const QString &	lastError () const
	Text summary of last error encountered. More...

bool	hasLastError () const
	Returns if lastError message is not empty.

void	clearLastError ()
	Clear last error message.

const QString	pluginTypeName () const
	Returns human readable plugin type from plug-in's pluginType.

virtual void	setDoc (ScribusDoc *doc)
	hooks that plugins can use to detect if the current document was closed etc..

virtual void	unsetDoc ()

virtual void	changedDoc (ScribusDoc *doc)

Public Attributes
QWidget *	m_parent

Additional Inherited Members
Public Slots inherited from ScActionPlugin
virtual bool	cleanupPlugin ()
	Deactivates the plugin for unloading / program quit. More...

virtual bool	run (ScribusDoc doc, QIODevice target)
	Run the plugin on a QIODevice. More...

virtual DeferredTask *	runAsync (QString target=QString::null)
	Run the plugin asynchronously. More...

virtual DeferredTask *	runAsync (QIODevice *target)
	Run the plugin asynchronously. More...

const QString &	runResult () const
	! Obsolete method - do not use this or rely on it in new code.

Protected Attributes inherited from ScActionPlugin
ActionInfo	m_actionInfo

QString	m_runResult

ScribusDoc *	m_Doc

Protected Attributes inherited from ScPlugin
QString	m_lastError
	Human readable, translated version of last error to occur.

Detailed Description

See scplugin.h and pluginmanager.{cpp,h} for detail on what these methods do. That documentatation is not duplicated here. Please don't implement the functionality of your plugin here; do that in mypluginimpl.h and mypluginimpl.cpp.

Member Function Documentation

const QString HunspellPlugin::fullTrName ( ) const

virtual

Plug-in's human-readable, translated name.

Please don't use this for anything except display to the user. The results of testing the value of this can not be guaranteed, as its value may change depending on locale and change at runtime.

Implements ScPlugin.

const ScActionPlugin::AboutData * HunspellPlugin::getAboutData ( ) const

virtual

Return descriptive information about the plug-in.

Returns a structure containing descriptive information about the plug-in. This information is used in places like the Help->About Plug-ins menu item. The stucture MUST be deleted using deleteAboutData(AboutData* about) when finished with.

Every plugin MUST reimplement getAboutData(...) and deleteAboutData(...).

See also: ScPlugin::deleteAboutData

Implements ScPlugin.

void HunspellPlugin::languageChange ( )

virtual

Update all user-visible text to reflect current UI language.

Updates the text on all widgets on the plug-in to reflect the new language. You should generally use this method to set all the widget text during construction. That ensures that text is not duplicated, and that when this method is called the text of all persistent widgets is correctly changed.

This method only needs to affect text in widgets that currently exists (displayed or otherwise).

Implements ScPlugin.

bool HunspellPlugin::run	(	QWidget *	parent,
		ScribusDoc *	doc,
		QString	target = `QString::null`
	)

virtual

Run the plug-in's main action.

This method behaves as the previous one. Except there is a parent widget reference. It's useful e.g. when you need to open a dialog on a specific parent one.

Reimplemented from ScActionPlugin.

The documentation for this class was generated from the following files:

/Users/ale/src/Scribus/scribus/plugins/tools/hunspellcheck/hunspellplugin.h
/Users/ale/src/Scribus/scribus/plugins/tools/hunspellcheck/hunspellplugin.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation