plugify::LanguageModuleDescriptorRef Class Reference

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

#include <language_module_descriptor.hpp>

Inheritance diagram for plugify::LanguageModuleDescriptorRef:

Collaboration diagram for plugify::LanguageModuleDescriptorRef:

Public Member Functions
int32_t	GetFileVersion () const noexcept
	< Inherit constructors from Ref<const LanguageModuleDescriptor>. More...
int32_t	GetVersion () const noexcept
	Retrieves the version of the language module. More...
std::string_view	GetVersionName () const noexcept
	Retrieves the version name of the language module. More...
std::string_view	GetFriendlyName () const noexcept
	Retrieves the friendly name of the language module. More...
std::string_view	GetDescription () const noexcept
	Retrieves the description of the language module. More...
std::string_view	GetCreatedBy () const noexcept
	Retrieves the name of the creator of the language module. More...
std::string_view	GetCreatedByURL () const noexcept
	Retrieves the URL of the creator of the language module. More...
std::string_view	GetDocsURL () const noexcept
	Retrieves the documentation URL for the language module. More...
std::string_view	GetDownloadURL () const noexcept
	Retrieves the download URL for the language module. More...
std::string_view	GetUpdateURL () const noexcept
	Retrieves the update URL for the language module. More...
std::span< std::string_view >	GetSupportedPlatforms () const noexcept
	Retrieves the supported platforms for the language module. More...
std::span< std::string_view >	GetResourceDirectories () const noexcept
	Retrieves the resource directories for the language module. More...
std::span< std::string_view >	GetLibraryDirectories () const noexcept
	Retrieves the library directories for the language module. More...
std::string_view	GetLanguage () const noexcept
	Retrieves the programming language of the language module. More...
bool	IsForceLoad () const noexcept
	Checks if the language module is forced to load. More...
Public Member Functions inherited from plugify::Ref< const LanguageModuleDescriptor >
	Ref (const LanguageModuleDescriptor &impl) noexcept
	Ref (Ref const &)=default
	Ref (Ref &&)=default
bool	operator== (const Ref &other) const noexcept
bool	operator== (const const LanguageModuleDescriptor *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

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

Detailed Description

A reference class for the LanguageModuleDescriptor structure.

This class holds a reference to a LanguageModuleDescriptor object, allowing users to retrieve detailed information about a language module, such as version, name, description, URLs, supported platforms, resource directories, and other metadata.

Definition at line 20 of file language_module_descriptor.hpp.

Member Function Documentation

GetCreatedBy()

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

noexcept

Retrieves the name of the creator of the language module.

Returns

A string view representing the name of the creator.

GetCreatedByURL()

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

noexcept

Retrieves the URL of the creator of the language module.

Returns

A string view representing the creator's URL.

GetDescription()

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

noexcept

Retrieves the description of the language module.

Returns

A string view representing the description.

GetDocsURL()

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

noexcept

Retrieves the documentation URL for the language module.

Returns

A string view representing the documentation URL.

GetDownloadURL()

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

noexcept

Retrieves the download URL for the language module.

Returns

A string view representing the download URL.

GetFileVersion()

int32_t plugify::LanguageModuleDescriptorRef::GetFileVersion ( ) const

noexcept

< Inherit constructors from Ref<const LanguageModuleDescriptor>.

Retrieves the file version of the language module.

Returns

An integer representing the file version.

GetFriendlyName()

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

noexcept

Retrieves the friendly name of the language module.

Returns

A string view representing the friendly name.

GetLanguage()

std::string_view plugify::LanguageModuleDescriptorRef::GetLanguage ( ) const

noexcept

Retrieves the programming language of the language module.

Returns

A string view representing the language used by the module.

GetLibraryDirectories()

std::span<std::string_view> plugify::LanguageModuleDescriptorRef::GetLibraryDirectories ( ) const

noexcept

Retrieves the library directories for the language module.

Returns

A span of string views representing the library directories.

GetResourceDirectories()

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

noexcept

Retrieves the resource directories for the language module.

Returns

A span of string views representing the resource directories.

GetSupportedPlatforms()

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

noexcept

Retrieves the supported platforms for the language module.

Returns

A span of string views representing the supported platforms.

GetUpdateURL()

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

noexcept

Retrieves the update URL for the language module.

Returns

A string view representing the update URL.

GetVersion()

int32_t plugify::LanguageModuleDescriptorRef::GetVersion ( ) const

noexcept

Retrieves the version of the language module.

Returns

An integer representing the version.

GetVersionName()

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

noexcept

Retrieves the version name of the language module.

Returns

A string view representing the version name.

IsForceLoad()

bool plugify::LanguageModuleDescriptorRef::IsForceLoad ( ) const

noexcept

Checks if the language module is forced to load.

Returns

true if the module is forced to load, otherwise false.

---

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

• include/plugify/language_module_descriptor.hpp