ImportPlugin Class Reference

#include <ImportPlugin.h>

Inheritance diagram for ImportPlugin:

Public Member Functions
virtual	~ImportPlugin ()=default
virtual QString	getCompatibilityWarnings () const =0
virtual QString	getComponentName (QString const &componentDeclaration) const =0
virtual QStringList	getFileComponents (QString const &input) const =0
virtual QStringList	getSupportedFileTypes () const =0
virtual void	import (QString const &input, QString const &componentDeclaration, QSharedPointer< Component > targetComponent)=0
Public Member Functions inherited from IPlugin
virtual	~IPlugin ()
virtual QString	getDescription () const =0
virtual QString	getLicense () const =0
virtual QString	getLicenseHolder () const =0
virtual QString	getName () const =0
virtual QList< ExternalProgramRequirement >	getProgramRequirements ()=0
virtual PluginSettingsModel *	getSettingsModel ()=0
virtual QWidget *	getSettingsWidget ()=0
virtual QString	getVendor () const =0
virtual QString	getVersion () const =0

Detailed Description

Definition at line 24 of file ImportPlugin.h.

Constructor & Destructor Documentation

~ImportPlugin()

virtual ImportPlugin::~ImportPlugin ( )

virtualdefault

The destructor.

Member Function Documentation

getCompatibilityWarnings()

virtual QString ImportPlugin::getCompatibilityWarnings ( ) const

pure virtual

Returns a compatibility warning concerning the import plugin usage. Can be empty.

Returns

The warning text.

getComponentName()

virtual QString ImportPlugin::getComponentName ( QString const & componentDeclaration ) const

pure virtual

Get the name of the selected component declaration.

Parameters

[in]

componentDeclaration

The selected component declaration.

Returns

Name of the selected component declaration.

getFileComponents()

virtual QStringList ImportPlugin::getFileComponents ( QString const & input ) const

pure virtual

Get component declarations from the selected input file.

Parameters

[in]

input

The selected input file.

Returns

List of component declarations found in the selected input.

getSupportedFileTypes()

virtual QStringList ImportPlugin::getSupportedFileTypes ( ) const

pure virtual

Returns the file types supported by the plugin.

Returns

The file types the import plugin supports.

import()

virtual void ImportPlugin::import ( QString const & input, QString const & componentDeclaration, QSharedPointer< Component > targetComponent )

pure virtual

Runs the import by parsing the given input and applying the parsed elements to the given component.

Parameters

[in]	input	The input text to parse.
[in]	componentDeclaration	Declaration of the selected component.
[in]	targetComponent	The component to apply all imported changes to.

---

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

• kactus2dev/KactusAPI/include/ImportPlugin.h