HostServices Class Reference

Interface for a document. More...

#include <host_services.h>

Inheritance diagram for HostServices:

Public Member Functions
	HostServices (std::shared_ptr< IDocument > document, maki::IPipeline *pipeline, maki::ISettings *settings, const QString &root, QObject *parent=nullptr)
	Constructs a new HostServices object.
void	setPluginTab (maki::IUI *tab)
	Sets the plugin tab.
void	setLogger (maki::ILogging *logger)
	Sets the logger.
IDocument *	document () const override
	Returns the document.
maki::ISettings *	settings () const override
	Returns the settings.
maki::IPipeline *	pipeline () const override
	Returns the pipeline.
QString	projectRoot () const override
	Returns the project root directory.
maki::IUI *	ui () const override
	Returns the plugin tab.
maki::ILogging *	logger () const override
	Returns the logger.

Private Attributes
maki::IPipeline *	mPipeline
	Shared pointer to the document.
maki::ISettings *	mSettings
	Pointer to the pipeline.
maki::IUI *	mPluginTab
	Pointer to the settings.
maki::ILogging *	mLogger
	Pointer to the plugin tab.
QString	mRoot
	Pointer to the logger.

Detailed Description

Interface for a document.

HostServices class provides services to the host application.

Constructor & Destructor Documentation

HostServices()

HostServices::HostServices	(	std::shared_ptr< IDocument >	document,
		maki::IPipeline *	pipeline,
		maki::ISettings *	settings,
		const QString &	root,
		QObject *	parent = nullptr )

Constructs a new HostServices object.

Parameters

document	Shared pointer to the IDocument instance.
pipeline	Pointer to the IPipeline instance.
settings	Pointer to the ISettings instance.
root	Project root directory as a QString.
parent	Parent QObject, defaults to nullptr.

Member Function Documentation

document()

IDocument * HostServices::document ( ) const

override

Returns the document.

Returns

IDocument* Pointer to the document.

logger()

maki::ILogging * HostServices::logger ( ) const

override

Returns the logger.

Returns

maki::ILogging* Pointer to the logger.

pipeline()

maki::IPipeline * HostServices::pipeline ( ) const

override

Returns the pipeline.

Returns

maki::IPipeline* Pointer to the pipeline.

projectRoot()

QString HostServices::projectRoot ( ) const

override

Returns the project root directory.

Returns

QString Project root directory.

setLogger()

void HostServices::setLogger

(

maki::ILogging *

logger

)

Sets the logger.

Parameters

logger

Pointer to the ILogging instance.

setPluginTab()

void HostServices::setPluginTab

(

maki::IUI *

tab

)

Sets the plugin tab.

Parameters

tab	Pointer to the IUI instance.

settings()

maki::ISettings * HostServices::settings ( ) const

override

Returns the settings.

Returns

maki::ISettings* Pointer to the settings.

ui()

maki::IUI * HostServices::ui ( ) const

override

Returns the plugin tab.

Returns

maki::IUI* Pointer to the plugin tab.

---

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

• /__w/maki/maki/app/system/host_services.h
• /__w/maki/maki/app/system/host_services.cpp