Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

AspellPlugin Class Reference

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 aspellpluginimpl.h and aspellpluginimpl.cpp. More...

#include <aspellplugin.h>

Inheritance diagram for AspellPlugin:

Inheritance graph
[legend]
Collaboration diagram for AspellPlugin:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 AspellPlugin ()
 Standard plugin implementation.
virtual ~AspellPlugin ()
virtual bool run (ScribusDoc *doc, QString target=QString::null)
 main method to run the plug
virtual const QString fullTrName () const
 Plug-in's human-readable, translated name.
virtual const AboutDatagetAboutData () const
 Return descriptive information about the plug-in.
virtual void deleteAboutData (const AboutData *about) const
virtual void languageChange ()
 Update all user-visible text to reflect current UI language.
virtual void addToMainWindowMenu (ScribusMainWindow *)
 Allow plugins to add to a main menu.


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 aspellpluginimpl.h and aspellpluginimpl.cpp.

Definition at line 17 of file aspellplugin.h.


Constructor & Destructor Documentation

AspellPlugin::AspellPlugin (  ) 

Standard plugin implementation.

Definition at line 15 of file aspellplugin.cpp.

References languageChange().

Referenced by aspellplugin_getPlugin().

AspellPlugin::~AspellPlugin (  )  [virtual]

Definition at line 22 of file aspellplugin.cpp.


Member Function Documentation

bool AspellPlugin::run ( ScribusDoc doc,
QString  target = QString::null 
) [virtual]

main method to run the plug

Implements ScActionPlugin.

Definition at line 81 of file aspellplugin.cpp.

const QString AspellPlugin::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.

Definition at line 53 of file aspellplugin.cpp.

References tr().

const ScActionPlugin::AboutData * AspellPlugin::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.

Definition at line 58 of file aspellplugin.cpp.

References ScPlugin::AboutData::authors, ScPlugin::AboutData::copyright, ScPlugin::AboutData::description, ScPlugin::AboutData::license, ScPlugin::AboutData::shortDescription, tr(), and ScPlugin::AboutData::version.

void AspellPlugin::deleteAboutData ( const AboutData about  )  const [virtual]

Implements ScPlugin.

Definition at line 75 of file aspellplugin.cpp.

void AspellPlugin::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.

Definition at line 24 of file aspellplugin.cpp.

References ScActionPlugin::ActionInfo::enabledOnStartup, ScActionPlugin::ActionInfo::forAppMode, PageItem::ImageFrame, ScActionPlugin::ActionInfo::keySequence, PageItem::LatexFrame, PageItem::Line, ScActionPlugin::m_actionInfo, ScActionPlugin::ActionInfo::menu, modeNormal, ScActionPlugin::ActionInfo::name, ScActionPlugin::ActionInfo::needsNumObjects, ScActionPlugin::ActionInfo::notSuitableFor, PageItem::Polygon, PageItem::PolyLine, ScActionPlugin::ActionInfo::text, and tr().

Referenced by AspellPlugin().

virtual void AspellPlugin::addToMainWindowMenu ( ScribusMainWindow  )  [inline, virtual]

Allow plugins to add to a main menu.

Implements ScPlugin.

Definition at line 31 of file aspellplugin.h.


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.