openpine::inputs::InputSession Class Reference

Wrapper for a session script input. More...

#include <input_session.hpp>

Public Member Functions
	InputSession (const ffi::InputSession &data, const ffi::Input *input=nullptr)
	Constructs from FFI data and optional handle for optionAt().
int64_t	id () const
	Input ID.
std::string_view	defaultValue () const
	Default session string.
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< std::string_view >	optionAt (uintptr_t index) const
	Option session string at the given index.

Friends
class	openpine::ScriptInput

Detailed Description

Wrapper for a session script input.

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

Definition at line 27 of file input_session.hpp.

Constructor & Destructor Documentation

InputSession()

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

inline

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

Definition at line 30 of file input_session.hpp.

Member Function Documentation

active()

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

inline

Whether the input is active.

Definition at line 57 of file input_session.hpp.

confirm()

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

inline

Whether the input requires confirmation.

Definition at line 61 of file input_session.hpp.

defaultValue()

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

inline

Default session string.

Definition at line 35 of file input_session.hpp.

References openpine::detail::refToView().

display()

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

inline

Display bitmask.

Definition at line 55 of file input_session.hpp.

group()

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

inline

Optional group name.

Definition at line 51 of file input_session.hpp.

References openpine::detail::optRefToView().

id()

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

inline

Input ID.

Definition at line 33 of file input_session.hpp.

inlineGroup()

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

inline

Optional inline group name.

Definition at line 47 of file input_session.hpp.

References openpine::detail::optRefToView().

optionAt()

std::optional< std::string_view > openpine::inputs::InputSession::optionAt ( uintptr_t index ) const

inline

Option session string at the given index.

Parameters

index

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

Returns

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

Definition at line 68 of file input_session.hpp.

References openpine::detail::optRefToView().

optionsLength()

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

inline

Number of options (for optionAt()).

Definition at line 59 of file input_session.hpp.

title()

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

inline

Optional title.

Definition at line 39 of file input_session.hpp.

References openpine::detail::optRefToView().

tooltip()

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

inline

Optional tooltip.

Definition at line 43 of file input_session.hpp.

References openpine::detail::optRefToView().

Friends And Related Symbol Documentation

openpine::ScriptInput

friend class openpine::ScriptInput

friend

Definition at line 78 of file input_session.hpp.

---

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

• cpp/include/inputs/input_session.hpp