OpenPine C++ API
C++ wrapper for the OpenPine Pine Script VM
Loading...
Searching...
No Matches
openpine::inputs::InputTimeFrame Class Reference

Wrapper for a timeframe script input. More...

#include <input_time_frame.hpp>

Public Member Functions

 InputTimeFrame (const ffi::InputTimeFrame &data, const ffi::Input *input=nullptr)
 Constructs from FFI data and optional handle for optionAt().
int64_t id () const
 Input ID.
bool isChartDefault () const
 Whether the default is "use chart timeframe".
std::optional< TimeFrame > defaultValue () const
 Default timeframe (quantity + unit).
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 timeframe string at the given index.

Friends

class openpine::ScriptInput

Detailed Description

Wrapper for a timeframe script input.

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

Definition at line 27 of file input_time_frame.hpp.

Constructor & Destructor Documentation

◆ InputTimeFrame()

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

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

Definition at line 30 of file input_time_frame.hpp.

Member Function Documentation

◆ active()

bool openpine::inputs::InputTimeFrame::active ( ) const
inline

Whether the input is active.

Definition at line 64 of file input_time_frame.hpp.

◆ confirm()

bool openpine::inputs::InputTimeFrame::confirm ( ) const
inline

Whether the input requires confirmation.

Definition at line 68 of file input_time_frame.hpp.

◆ defaultValue()

std::optional< TimeFrame > openpine::inputs::InputTimeFrame::defaultValue ( ) const
inline

Default timeframe (quantity + unit).

Returns
The concrete timeframe, or std::nullopt when isChartDefault().

Definition at line 41 of file input_time_frame.hpp.

◆ display()

uint64_t openpine::inputs::InputTimeFrame::display ( ) const
inline

Display bitmask.

Definition at line 62 of file input_time_frame.hpp.

◆ group()

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

Optional group name.

Definition at line 58 of file input_time_frame.hpp.

References openpine::detail::optRefToView().

◆ id()

int64_t openpine::inputs::InputTimeFrame::id ( ) const
inline

Input ID.

Definition at line 34 of file input_time_frame.hpp.

◆ inlineGroup()

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

Optional inline group name.

Definition at line 54 of file input_time_frame.hpp.

References openpine::detail::optRefToView().

◆ isChartDefault()

bool openpine::inputs::InputTimeFrame::isChartDefault ( ) const
inline

Whether the default is "use chart timeframe".

Definition at line 36 of file input_time_frame.hpp.

◆ optionAt()

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

Option timeframe string at the given index.

Parameters
indexZero-based option index (must be < optionsLength()).
Returns
The option string view, or std::nullopt if out of range or not available.

Definition at line 75 of file input_time_frame.hpp.

References openpine::detail::optRefToView().

◆ optionsLength()

uintptr_t openpine::inputs::InputTimeFrame::optionsLength ( ) const
inline

Number of options (for optionAt()).

Definition at line 66 of file input_time_frame.hpp.

◆ title()

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

Optional title.

Definition at line 46 of file input_time_frame.hpp.

References openpine::detail::optRefToView().

◆ tooltip()

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

Optional tooltip.

Definition at line 50 of file input_time_frame.hpp.

References openpine::detail::optRefToView().

◆ openpine::ScriptInput

friend class openpine::ScriptInput
friend

Definition at line 85 of file input_time_frame.hpp.

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