Opie::Security::MultiauthPluginObject Class Reference

Base class for Opie multiauth plugins. More...

#include </home/clem/local/src/opie/libopie2/opiesecurity/multiauthplugininterface.h>

Inheritance diagram for Opie::Security::MultiauthPluginObject:

[legend]List of all members.

Public Types
enum	authResult { Success = 0, Failure = 1, Skip = 2 }
	Possible return codes for authenticate() function. More...
Public Member Functions
virtual	~MultiauthPluginObject ()
virtual QString	pluginName () const =0
	The name of the plugin.
virtual int	authenticate ()=0
	Ask the plugin to launch one authentication attempt.
virtual MultiauthConfigWidget *	configWidget (QWidget *parent)=0
	Pointer to the (optional) plugin configuration widget.
virtual QString	pixmapNameConfig () const =0
	(optional) plugin configuration tab icon
virtual QString	pixmapNameWidget () const =0
	Plugin icon, to be displayed in the plugin list configuration widget.

---

Detailed Description

Base class for Opie multiauth plugins.

A MultiauthPluginObject is the base for all Multiauth Plugins. A plugin author needs to inherit this class and implement the pure virtual methods.

Author:

Clement Seveillac (helped by Maximilian Reiß's Today framework)

Definition at line 63 of file multiauthplugininterface.h.

---

Member Enumeration Documentation

enum Opie::Security::MultiauthPluginObject::authResult

Possible return codes for authenticate() function. Enumeration values: Success  Failure  Skip  Definition at line 79 of file multiauthplugininterface.h.

---

Constructor & Destructor Documentation

virtual Opie::Security::MultiauthPluginObject::~MultiauthPluginObject (   )  [inline, virtual]

Definition at line 67 of file multiauthplugininterface.h.

---

Member Function Documentation

virtual int Opie::Security::MultiauthPluginObject::authenticate (   )  [pure virtual]

Ask the plugin to launch one authentication attempt. Implemented in BluepingPlugin, DummyPlugin, NoticePlugin, and PinPlugin.

virtual MultiauthConfigWidget* Opie::Security::MultiauthPluginObject::configWidget (  QWidget *  parent  )  [pure virtual]

Pointer to the (optional) plugin configuration widget. Implemented in BluepingPlugin, DummyPlugin, NoticePlugin, and PinPlugin. Referenced by MultiauthConfig::MultiauthConfig().

virtual QString Opie::Security::MultiauthPluginObject::pixmapNameConfig (   )  const [pure virtual]

(optional) plugin configuration tab icon Returns: path to the image file (without the extension) from $OPIEDIR/pics Implemented in BluepingPlugin, DummyPlugin, NoticePlugin, and PinPlugin. Referenced by MultiauthConfig::MultiauthConfig().

virtual QString Opie::Security::MultiauthPluginObject::pixmapNameWidget (   )  const [pure virtual]

Plugin icon, to be displayed in the plugin list configuration widget. Returns: path to the image file (without the extension) from $OPIEDIR/pics Implemented in BluepingPlugin, DummyPlugin, NoticePlugin, and PinPlugin. Referenced by MultiauthConfig::MultiauthConfig().

virtual QString Opie::Security::MultiauthPluginObject::pluginName (   )  const [pure virtual]

The name of the plugin. Implemented in BluepingPlugin, DummyPlugin, NoticePlugin, and PinPlugin. Referenced by MultiauthConfig::MultiauthConfig().

---

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

• libopie2/opiesecurity/multiauthplugininterface.h

---