openpine::inputs::InputEnum Class Reference

Wrapper for an enum script input. More...

#include <input_enum.hpp>

Public Member Functions
	InputEnum (const ffi::InputEnum &data, const ffi::Input *input=nullptr)
	Constructs from FFI data and optional handle for optionAt().
int64_t	id () const
	Input ID.
uintptr_t	enumTypeId () const
	Enum type identifier.
int64_t	defaultValue () const
	Default value (option index).
std::optional< std::string_view >	title () const
	Optional title.
std::optional< std::string_view >	tooltip () const
	Optional tooltip.
std::optional< std::string_view >	inlineGroup () const
	Optional inline group name.
std::optional< std::string_view >	group () const
	Optional group name.
uint64_t	display () const
	Display bitmask.
bool	active () const
	Whether the input is active.
uintptr_t	optionsLength () const
	Number of options (for optionAt()).
bool	confirm () const
	Whether the input requires confirmation.
std::optional< InputEnumOptionView >	optionAt (uintptr_t index) const
	Option at the given index (value + title).

Friends
class	openpine::ScriptInput

Detailed Description

Wrapper for an enum script input.

String views are valid only while the ScriptInfo/Instance is alive.

Definition at line 33 of file input_enum.hpp.

Constructor & Destructor Documentation

InputEnum()

openpine::inputs::InputEnum::InputEnum ( const ffi::InputEnum & data, const ffi::Input * input = nullptr )

inline

Constructs from FFI data and optional handle for optionAt().

Definition at line 36 of file input_enum.hpp.

Member Function Documentation

active()

bool openpine::inputs::InputEnum::active ( ) const

inline

Whether the input is active.

Definition at line 63 of file input_enum.hpp.

confirm()

bool openpine::inputs::InputEnum::confirm ( ) const

inline

Whether the input requires confirmation.

Definition at line 67 of file input_enum.hpp.

defaultValue()

int64_t openpine::inputs::InputEnum::defaultValue ( ) const

inline

Default value (option index).

Definition at line 43 of file input_enum.hpp.

display()

uint64_t openpine::inputs::InputEnum::display ( ) const

inline

Display bitmask.

Definition at line 61 of file input_enum.hpp.

enumTypeId()

uintptr_t openpine::inputs::InputEnum::enumTypeId ( ) const

inline

Enum type identifier.

Definition at line 41 of file input_enum.hpp.

group()

std::optional< std::string_view > openpine::inputs::InputEnum::group ( ) const

inline

Optional group name.

Definition at line 57 of file input_enum.hpp.

References openpine::detail::optRefToView().

id()

int64_t openpine::inputs::InputEnum::id ( ) const

inline

Input ID.

Definition at line 39 of file input_enum.hpp.

inlineGroup()

std::optional< std::string_view > openpine::inputs::InputEnum::inlineGroup ( ) const

inline

Optional inline group name.

Definition at line 53 of file input_enum.hpp.

References openpine::detail::optRefToView().

optionAt()

std::optional< InputEnumOptionView > openpine::inputs::InputEnum::optionAt ( uintptr_t index ) const

inline

Option at the given index (value + title).

Parameters

index

Zero-based option index (must be < optionsLength()).

Returns

The option view, or std::nullopt if out of range or not available.

Definition at line 74 of file input_enum.hpp.

References openpine::detail::refToView().

optionsLength()

uintptr_t openpine::inputs::InputEnum::optionsLength ( ) const

inline

Number of options (for optionAt()).

Definition at line 65 of file input_enum.hpp.

title()

std::optional< std::string_view > openpine::inputs::InputEnum::title ( ) const

inline

Optional title.

Definition at line 45 of file input_enum.hpp.

References openpine::detail::optRefToView().

tooltip()

std::optional< std::string_view > openpine::inputs::InputEnum::tooltip ( ) const

inline

Optional tooltip.

Definition at line 49 of file input_enum.hpp.

References openpine::detail::optRefToView().

Friends And Related Symbol Documentation

openpine::ScriptInput

friend class openpine::ScriptInput

friend

Definition at line 84 of file input_enum.hpp.

---

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

• cpp/include/inputs/input_enum.hpp