Example Class Reference

#include <example.hh>

Inheritance diagram for Example:

Collaboration diagram for Example:

Public Types
using	Ptr = std::shared_ptr< Example >
Public Types inherited from PluginInformationInterface
using	Ptr = std::shared_ptr< PluginInformationInterface >
Public Types inherited from NewPresentationInterface
using	Ptr = std::shared_ptr< NewPresentationInterface >

Public Member Functions
std::string	getPluginName () override
std::string	getPluginVersion () override
void	registerCapabilities (ScroomPluginInterface::Ptr host) override
PresentationInterface::Ptr	createNew () override
Public Member Functions inherited from PluginInformationInterface
	PluginInformationInterface ()=default
Public Member Functions inherited from Scroom::Utils::Base
	Base ()=default
	Base (const Base &)=delete
	Base (Base &&)=delete
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&)=delete
virtual	~Base ()=default
template<typename R >
std::shared_ptr< R >	shared_from_this ()
template<typename R >
std::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create ()

Private Member Functions
	Example ()=default

Additional Inherited Members
Public Attributes inherited from PluginInformationInterface
const int	pluginApiVersion {PLUGIN_API_VERSION}

Member Typedef Documentation

Ptr

using Example::Ptr = std::shared_ptr<Example>

Constructor & Destructor Documentation

Example()

Example::Example ( )

privatedefault

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

create()

Example::Ptr Example::create ( )

static

{ return Ptr(new Example()); }

Referenced by getPluginInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

createNew()

PresentationInterface::Ptr Example::createNew ( )

overridevirtual

Implements NewPresentationInterface.

{ return PresentationInterface::Ptr(new ExamplePresentation()); }

getPluginName()

std::string Example::getPluginName ( )

overridevirtual

Implements PluginInformationInterface.

{ return "Example"; }

getPluginVersion()

std::string Example::getPluginVersion ( )

overridevirtual

Implements PluginInformationInterface.

{ return PACKAGE_VERSION; }

registerCapabilities()

void Example::registerCapabilities ( ScroomPluginInterface::Ptr  host )

overridevirtual

Implements PluginInformationInterface.

{
  host->registerNewPresentationInterface("Example", shared_from_this<Example>());
}

---

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

• plugins/example/example.hh
• plugins/example/example.cc