MMLComponentExtension Class Reference

This MML ComponentPlugin allows you to manipulate MML document. More...

#include <MMLComponentExtension.h>

Inherits camitk::ComponentExtension.

Public Member Functions
virtual QString	getDescription () const
	get the plugin description (can be html) More...
virtual QStringList	getFileExtensions () const
	get the list of managed extensions (each file with an extension in the list can be loaded by this Extension More...
virtual QString	getName () const
	get the plugin name More...
	MMLComponentExtension ()
	the constructor (do nothing really) More...
virtual camitk::Component *	open (const QString &)
	get a new instance from data stored in a file (this is the most important method to redefine in your subclass). More...
virtual bool	save (camitk::Component *component) const
	save (only work with mml component) More...
Public Member Functions inherited from camitk::ComponentExtension
	~ComponentExtension () override=default
	protected destructor, More...
virtual bool	hasDataDirectory () const
	return true if this component manages directory instead of individual files (e.g. Dicom series are stored in directories, not files) More...
QString	getLocation () const
	get the file path (location of the .dll/.so/.dylib) of this plugin More...
void	setLocation (const QString loc)
	set the file path (once loaded as a dynamic library) More...
void	initResources ()
	Load, for the selected langage (asked to the Application), the associated .qm file. More...

Protected Member Functions
virtual	~MMLComponentExtension ()=default
	the destructor More...
Protected Member Functions inherited from camitk::ComponentExtension
	ComponentExtension ()
	protected constructor, More...

Detailed Description

This MML ComponentPlugin allows you to manipulate MML document.

Constructor & Destructor Documentation

MMLComponentExtension()

MMLComponentExtension::MMLComponentExtension ( )

inline

the constructor (do nothing really)

References camitk::ComponentExtension::getDescription(), camitk::ComponentExtension::getFileExtensions(), camitk::ComponentExtension::getName(), camitk::ComponentExtension::open(), and camitk::ComponentExtension::save().

~MMLComponentExtension()

virtual MMLComponentExtension::~MMLComponentExtension ( )

protectedvirtualdefault

the destructor

Member Function Documentation

getDescription()

QString MMLComponentExtension::getDescription ( ) const

virtual

get the plugin description (can be html)

Implements camitk::ComponentExtension.

getFileExtensions()

QStringList MMLComponentExtension::getFileExtensions ( ) const

virtual

get the list of managed extensions (each file with an extension in the list can be loaded by this Extension

Implements camitk::ComponentExtension.

getName()

QString MMLComponentExtension::getName ( ) const

virtual

get the plugin name

Implements camitk::ComponentExtension.

open()

camitk::Component * MMLComponentExtension::open ( const QString &  fileName )

virtual

get a new instance from data stored in a file (this is the most important method to redefine in your subclass).

This method may throw an AbortException if a problem occurs.

Implements camitk::ComponentExtension.

save()

bool MMLComponentExtension::save ( camitk::Component *  component ) const

virtual

save (only work with mml component)

Reimplemented from camitk::ComponentExtension.

References camitk::ComponentExtension::save(), MMLComponent::saveMML(), and camitk::Component::setModified().

---

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

• MMLComponentExtension.h
• MMLComponentExtension.cpp