Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

Barcode Class Reference

Scribus interface to the Barcode Generator. More...

#include <barcode.h>

Inheritance diagram for Barcode:

Inheritance graph
[legend]
Collaboration diagram for Barcode:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Barcode ()
virtual ~Barcode ()
virtual bool run (ScribusDoc *doc, QString target=QString::null)
 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

Scribus interface to the Barcode Generator.

Author:
Petr Vanek <petr@yarpen.cz>

Definition at line 18 of file barcode.h.


Constructor & Destructor Documentation

Barcode::Barcode (  ) 

Definition at line 13 of file barcode.cpp.

References languageChange().

Referenced by barcodegenerator_getPlugin().

Barcode::~Barcode (  )  [virtual]

Definition at line 18 of file barcode.cpp.


Member Function Documentation

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

run the plug

Parameters:
target none usage here

Implements ScActionPlugin.

Definition at line 55 of file barcode.cpp.

const QString Barcode::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 30 of file barcode.cpp.

References tr().

const ScActionPlugin::AboutData * Barcode::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 35 of file barcode.cpp.

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

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

Implements ScPlugin.

Definition at line 49 of file barcode.cpp.

void Barcode::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 20 of file barcode.cpp.

References ScActionPlugin::ActionInfo::enabledOnStartup, ScActionPlugin::ActionInfo::forAppMode, ScActionPlugin::m_actionInfo, ScActionPlugin::ActionInfo::menu, modeNormal, ScActionPlugin::ActionInfo::name, ScActionPlugin::ActionInfo::needsNumObjects, ScActionPlugin::ActionInfo::text, and tr().

Referenced by Barcode().

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

Allow plugins to add to a main menu.

Implements ScPlugin.

Definition at line 32 of file barcode.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.