LC::Monocle::IRedirectorPlugin Class Reference

#include "iredirectorplugin.h"

Public Member Functions
virtual bool	CanRedirectDocument (const QString &filename) const =0
virtual QString	GetRedirectionMime (const QString &filename) const =0
virtual Util::Task< std::optional< RedirectionResult > >	GetRedirection (const QString &filename)=0
	Returns the redirection proxy for the given document. More...

Static Public Attributes
static QByteArray	PluginClass = "org.LeechCraft.Monocle.IRedirectorPlugin"

Protected Member Functions
virtual	~IRedirectorPlugin ()=default

Detailed Description

Definition at line 22 of file iredirectorplugin.h.

Constructor & Destructor Documentation

~IRedirectorPlugin()

virtual LC::Monocle::IRedirectorPlugin::~IRedirectorPlugin ( )

protectedvirtualdefault

Member Function Documentation

CanRedirectDocument()

virtual bool LC::Monocle::IRedirectorPlugin::CanRedirectDocument ( const QString &  filename ) const

pure virtual

GetRedirection()

virtual Util::Task<std::optional<RedirectionResult> > LC::Monocle::IRedirectorPlugin::GetRedirection ( const QString &  filename )

pure virtual

Returns the redirection proxy for the given document.

This function should return a redirect proxy for the document at filename, or a null pointer if the document cannot be redirected (for example, if it is invalid or can be handled directly by this module). However, a null pointer can be returned only if CanLoadDocument() returned LoadCheckResult::Can or LoadCheckResult::Cannot for the same document.

The default implementation simply does nothing and returns a null pointer.

Parameters

[in]

filename

The document to redirect.

Returns

The redirect proxy for filename, or null pointer.

See also

LoadDocument()

GetRedirectionMime()

virtual QString LC::Monocle::IRedirectorPlugin::GetRedirectionMime ( const QString &  filename ) const

pure virtual

Member Data Documentation

PluginClass

QByteArray LC::Monocle::IRedirectorPlugin::PluginClass = "org.LeechCraft.Monocle.IRedirectorPlugin"

inlinestatic

Definition at line 25 of file iredirectorplugin.h.

---

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

• /home/abuild/rpmbuild/BUILD/leechcraft-0.6.70-18450-gabe19ee3b0/src/plugins/monocle/interfaces/monocle/iredirectorplugin.h