Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

ColorWheelPlugin Class Reference

This is a simple "Color Theory" plugin for Scribus 1.3 and later. Harmonious colors are colors that work well together, that produce a color scheme that looks attractive; the color wheel can be used as a valuable tool for determining harmonious colors. More on: http://en.wikipedia.org/wiki/Color_wheel. More...

#include <colorwheel.h>

Inheritance diagram for ColorWheelPlugin:

Inheritance graph
[legend]
Collaboration diagram for ColorWheelPlugin:

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

This is a simple "Color Theory" plugin for Scribus 1.3 and later. Harmonious colors are colors that work well together, that produce a color scheme that looks attractive; the color wheel can be used as a valuable tool for determining harmonious colors. More on: http://en.wikipedia.org/wiki/Color_wheel.

Author:
Petr Vanek <petr@scribus.info>
Date:
April 2005

Definition at line 22 of file colorwheel.h.


Constructor & Destructor Documentation

ColorWheelPlugin::ColorWheelPlugin (  ) 

Definition at line 31 of file colorwheel.cpp.

References languageChange().

ColorWheelPlugin::~ColorWheelPlugin (  )  [virtual]

Definition at line 38 of file colorwheel.cpp.


Member Function Documentation

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

Create dialog. Everything else is handled in separated classes.

Implements ScActionPlugin.

Definition at line 80 of file colorwheel.cpp.

References ScribusMainWindow::doc, ScribusCore::primaryMainWindow(), and ScCore.

const QString ColorWheelPlugin::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 54 of file colorwheel.cpp.

References tr().

const ScActionPlugin::AboutData * ColorWheelPlugin::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 59 of file colorwheel.cpp.

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

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

Implements ScPlugin.

Definition at line 73 of file colorwheel.cpp.

void ColorWheelPlugin::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 40 of file colorwheel.cpp.

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

Referenced by ColorWheelPlugin().

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

Allow plugins to add to a main menu.

Implements ScPlugin.

Definition at line 35 of file colorwheel.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.