iwePlugin Interface Reference

Basic interface for the plugins. More...

#include <weiPlugin.h>

Inheritance diagram for iwePlugin:

List of all members.

Public Member Functions
	iwePlugin (void *handle=NULL)
	Constructor.
virtual	~iwePlugin ()
	Finaliser.
virtual shared_ptr< iwePlugin > &	GetRef ()
	Adds reference.
virtual void *	GetInterface (const string &ifName)=0
	Gets an interface.
virtual const string	InterfaceName ()
	Gets the final Interface name.
virtual WeStringList	InterfaceList ()
	Gets the list of supported Interfaces.
virtual const string	GetDesc ()=0
	Gets the plugin description.
virtual const string	GetID ()=0
	Gets the identifier.
virtual char **	GetIcon ()=0
	Gets the icon.

---

Detailed Description

Basic interface for the plugins.

Plugin is the interface to the external dynamic library. The library provides method to create the contained plugin as the basic iwePlugin interface. Other interfaces may be requested from the plugin by calling the GetInterface function. Plugin object can't be copied, use the GetRef function instead to obtain pointer to the plugin. Program must avoid the explicit destruction of the plugin, because it may destroy the object, that can be used somewhere else. Use the shared_ptr to the plugin instead to keep references .

Author:

A. Abramov

Date:

19.06.2009

Definition at line 44 of file weiPlugin.h.

---

Constructor & Destructor Documentation

iwePlugin::iwePlugin

(

void *

handle = NULL

)

[inline]

Constructor.

Parameters:

handle

- The handle to the contained library.

Definition at line 55 of file weiPlugin.h.

iwePlugin::~iwePlugin

(

)

[inline, virtual]

Finaliser.

Definition at line 62 of file weiPlugin.h.

---

Member Function Documentation

const string & iwePlugin::GetDesc

(

)

[pure virtual]

Gets the plugin description.

Return values:

The

description.

Implemented in WeMemStorage.

char * iwePlugin::GetIcon

(

)

[pure virtual]

Gets the icon.

Returns pointer to the array of chars, that represents image in the XPM format. This image may be used to identify the plugin in GUI.

Return values:

null

if no icon, else the icon.

Implemented in iweStorage.

const string & iwePlugin::GetID

(

)

[pure virtual]

Gets the identifier.

Returns string, what identifies this plugin. It may be GUID, or other unique identifier

Return values:

The

identifier.

Implemented in WeMemStorage.

void * iwePlugin::GetInterface

(

const string &

ifName

)

[pure virtual]

Gets an interface.

Returns abstracted pointer to the requested interface, or NULL if the requested interface isn't provided by this object. The interface name depends on the plugin implementation.

Parameters:

ifName

- Name of the interface.

Return values:

null

if it fails, else the interface.

Implemented in iweStorage, and WeMemStorage.

Definition at line 71 of file weiPlugin.h.

shared_ptr< iwePlugin > iwePlugin::GetRef

(

)

[inline, virtual]

Adds reference.

Must be used instead the copying the object

Definition at line 71 of file weiPlugin.h.

WeStringList iwePlugin::InterfaceList

(

)

[virtual]

Gets the list of supported Interfaces.

Return values:

strings

list.

Implemented in iweStorage, and WeMemStorage.

Definition at line 32 of file weiPlugin.cpp.

const string iwePlugin::InterfaceName

(

)

[virtual]

Gets the final Interface name.

Return values:

string.

Implemented in iweStorage, and WeMemStorage.

Definition at line 27 of file weiPlugin.cpp.

---

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

• weiPlugin.h
• weiPlugin.cpp