plugify::PluginDescriptorRef Class Reference

A reference class for the PluginDescriptor structure. More...

#include <plugin_descriptor.hpp>

Inheritance diagram for plugify::PluginDescriptorRef:

Collaboration diagram for plugify::PluginDescriptorRef:

Public Member Functions
int32_t	GetFileVersion () const noexcept
	< Inherit constructors from Ref<const PluginDescriptor>.
int32_t	GetVersion () const noexcept
	Retrieves the version of the plugin.
std::string_view	GetVersionName () const noexcept
	Retrieves the version name of the plugin.
std::string_view	GetFriendlyName () const noexcept
	Retrieves the friendly name of the plugin.
std::string_view	GetDescription () const noexcept
	Retrieves the description of the plugin.
std::string_view	GetCreatedBy () const noexcept
	Retrieves the name of the creator of the plugin.
std::string_view	GetCreatedByURL () const noexcept
	Retrieves the URL of the creator of the plugin.
std::string_view	GetDocsURL () const noexcept
	Retrieves the documentation URL for the plugin.
std::string_view	GetDownloadURL () const noexcept
	Retrieves the download URL for the plugin.
std::string_view	GetUpdateURL () const noexcept
	Retrieves the update URL for the plugin.
std::span< std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the plugin.
std::span< std::string_view >	GetResourceDirectories () const noexcept
	Retrieves the resource directories for the plugin.
std::string_view	GetEntryPoint () const noexcept
	Retrieves the entry point of the plugin.
std::string_view	GetLanguageModule () const noexcept
	Retrieves the language module used by the plugin.
std::span< const PluginReferenceDescriptorRef >	GetDependencies () const noexcept
	Retrieves the dependencies of the plugin.
std::span< const MethodRef >	GetExportedMethods () const noexcept
	Retrieves the methods exported by the plugin.
Public Member Functions inherited from plugify::Ref< const PluginDescriptor >
	Ref (const PluginDescriptor &impl) noexcept
	Ref (Ref const &)=default
	Ref (Ref &&)=default
bool	operator== (const Ref &other) const noexcept
bool	operator== (const const PluginDescriptor *impl) const noexcept
Ref &	operator= (const Ref &) &=default
Ref &	operator= (const Ref &) &&=delete
Ref &	operator= (Ref &&) &=default
Ref &	operator= (Ref &&) &&=delete
	operator bool () const noexcept
const void *const	GetPtr () const noexcept

Additional Inherited Members
Protected Attributes inherited from plugify::Ref< const PluginDescriptor >
const PluginDescriptor *	_impl

Detailed Description

A reference class for the PluginDescriptor structure.

This class holds a reference to a PluginDescriptor object, allowing users to retrieve metadata about a plugin, such as version information, description, creator information, URLs, supported platforms, dependencies, and exported methods.

Definition at line 22 of file plugin_descriptor.hpp.

Member Function Documentation

GetCreatedBy()

std::string_view plugify::PluginDescriptorRef::GetCreatedBy ( ) const

noexcept

Retrieves the name of the creator of the plugin.

Returns

A string view representing the name of the creator.

GetCreatedByURL()

std::string_view plugify::PluginDescriptorRef::GetCreatedByURL ( ) const

noexcept

Retrieves the URL of the creator of the plugin.

Returns

A string view representing the creator's URL.

GetDependencies()

std::span< const PluginReferenceDescriptorRef > plugify::PluginDescriptorRef::GetDependencies ( ) const

noexcept

Retrieves the dependencies of the plugin.

Returns

A span of PluginReferenceDescriptorRef objects representing the plugin's dependencies.

GetDescription()

std::string_view plugify::PluginDescriptorRef::GetDescription ( ) const

noexcept

Retrieves the description of the plugin.

Returns

A string view representing the plugin description.

GetDocsURL()

std::string_view plugify::PluginDescriptorRef::GetDocsURL ( ) const

noexcept

Retrieves the documentation URL for the plugin.

Returns

A string view representing the documentation URL.

GetDownloadURL()

std::string_view plugify::PluginDescriptorRef::GetDownloadURL ( ) const

noexcept

Retrieves the download URL for the plugin.

Returns

A string view representing the download URL.

GetEntryPoint()

std::string_view plugify::PluginDescriptorRef::GetEntryPoint ( ) const

noexcept

Retrieves the entry point of the plugin.

Returns

A string view representing the plugin's entry point.

GetExportedMethods()

std::span< const MethodRef > plugify::PluginDescriptorRef::GetExportedMethods ( ) const

noexcept

Retrieves the methods exported by the plugin.

Returns

A span of MethodRef objects representing the exported methods.

GetFileVersion()

int32_t plugify::PluginDescriptorRef::GetFileVersion ( ) const

noexcept

< Inherit constructors from Ref<const PluginDescriptor>.

Retrieves the file version of the plugin.

Returns

An integer representing the file version.

GetFriendlyName()

std::string_view plugify::PluginDescriptorRef::GetFriendlyName ( ) const

noexcept

Retrieves the friendly name of the plugin.

Returns

A string view representing the friendly name.

GetLanguageModule()

std::string_view plugify::PluginDescriptorRef::GetLanguageModule ( ) const

noexcept

Retrieves the language module used by the plugin.

Returns

A string view representing the language module.

GetResourceDirectories()

std::span< std::string_view > plugify::PluginDescriptorRef::GetResourceDirectories ( ) const

noexcept

Retrieves the resource directories for the plugin.

Returns

A span of string views representing the resource directories.

GetSupportedPlatforms()

std::span< std::string_view > plugify::PluginDescriptorRef::GetSupportedPlatforms ( ) const

noexcept

Retrieves the supported platforms for the plugin.

Returns

A span of string views representing the supported platforms.

GetUpdateURL()

std::string_view plugify::PluginDescriptorRef::GetUpdateURL ( ) const

noexcept

Retrieves the update URL for the plugin.

Returns

A string view representing the update URL.

GetVersion()

int32_t plugify::PluginDescriptorRef::GetVersion ( ) const

noexcept

Retrieves the version of the plugin.

Returns

An integer representing the plugin version.

GetVersionName()

std::string_view plugify::PluginDescriptorRef::GetVersionName ( ) const

noexcept

Retrieves the version name of the plugin.

Returns

A string view representing the version name.

---

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

• include/plugify/plugin_descriptor.hpp