plugify::PropertyRef Class Reference

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

#include <method.hpp>

Inheritance diagram for plugify::PropertyRef:

Collaboration diagram for plugify::PropertyRef:

Public Member Functions
ValueType	GetType () const noexcept
	< Inherit constructors from Ref<const Property>. More...
bool	IsReference () const noexcept
	Checks if the property is a reference. More...
std::optional< MethodRef >	GetPrototype () const noexcept
	Retrieves the prototype method for the property. More...
std::optional< EnumRef >	GetEnum () const noexcept
	Retrieves the enum information for the property. More...
Public Member Functions inherited from plugify::Ref< const Property >
	Ref (const Property &impl) noexcept
	Ref (Ref const &)=default
	Ref (Ref &&)=default
bool	operator== (const Ref &other) const noexcept
bool	operator== (const const Property *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 Property >
const Property *	_impl

Detailed Description

A reference class for the Property structure.

This class holds a reference to a Property object, allowing users to retrieve information such as its type, whether it's a reference, and its prototype method if applicable.

Definition at line 75 of file method.hpp.

Member Function Documentation

GetEnum()

std::optional<EnumRef> plugify::PropertyRef::GetEnum ( ) const

noexcept

Retrieves the enum information for the property.

Returns

An optional EnumRef representing the enum information. Returns an empty optional if no enum exists.

GetPrototype()

std::optional<MethodRef> plugify::PropertyRef::GetPrototype ( ) const

noexcept

Retrieves the prototype method for the property.

Returns

An optional MethodRef representing the prototype method. Returns an empty optional if no prototype exists.

GetType()

ValueType plugify::PropertyRef::GetType ( ) const

noexcept

< Inherit constructors from Ref<const Property>.

Retrieves the value type of the property.

Returns

The value type of the property.

IsReference()

bool plugify::PropertyRef::IsReference ( ) const

noexcept

Checks if the property is a reference.

Returns

true if the property is a reference, otherwise false.

---

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

• include/plugify/method.hpp