openpine::inputs::InputSymbol Class Reference

Wrapper for a symbol script input. More...

#include <input_symbol.hpp>

Public Member Functions
	InputSymbol (const ffi::InputSymbol &data)
	Constructs from FFI data.
int64_t	id () const
	Input ID.
std::string_view	defaultValue () const
	Default value.
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.
bool	confirm () const
	Whether the input requires confirmation.

Detailed Description

Wrapper for a symbol script input.

Definition at line 25 of file input_symbol.hpp.

Constructor & Destructor Documentation

InputSymbol()

openpine::inputs::InputSymbol::InputSymbol ( const ffi::InputSymbol & data )

inlineexplicit

Constructs from FFI data.

Definition at line 28 of file input_symbol.hpp.

Member Function Documentation

active()

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

inline

Whether the input is active.

Definition at line 54 of file input_symbol.hpp.

confirm()

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

inline

Whether the input requires confirmation.

Definition at line 56 of file input_symbol.hpp.

defaultValue()

std::string_view openpine::inputs::InputSymbol::defaultValue ( ) const

inline

Default value.

Definition at line 32 of file input_symbol.hpp.

References openpine::detail::refToView().

display()

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

inline

Display bitmask.

Definition at line 52 of file input_symbol.hpp.

group()

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

inline

Optional group name.

Definition at line 48 of file input_symbol.hpp.

References openpine::detail::optRefToView().

id()

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

inline

Input ID.

Definition at line 30 of file input_symbol.hpp.

inlineGroup()

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

inline

Optional inline group name.

Definition at line 44 of file input_symbol.hpp.

References openpine::detail::optRefToView().

title()

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

inline

Optional title.

Definition at line 36 of file input_symbol.hpp.

References openpine::detail::optRefToView().

tooltip()

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

inline

Optional tooltip.

Definition at line 40 of file input_symbol.hpp.

References openpine::detail::optRefToView().

---

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

• cpp/include/inputs/input_symbol.hpp