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

Wrapper for a text area script input. More...

#include <input_text_area.hpp>

Public Member Functions

 InputTextArea (const ffi::InputTextArea &data)
 Constructs from FFI data.
int64_t id () const
 Input ID.
std::string_view defaultValue () const
 Default text.
std::optional< std::string_view > title () const
 Optional title.
std::optional< std::string_view > tooltip () const
 Optional tooltip.
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 text area script input.

Definition at line 25 of file input_text_area.hpp.

Constructor & Destructor Documentation

◆ InputTextArea()

openpine::inputs::InputTextArea::InputTextArea ( const ffi::InputTextArea & data)
inlineexplicit

Constructs from FFI data.

Definition at line 28 of file input_text_area.hpp.

Member Function Documentation

◆ active()

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

Whether the input is active.

Definition at line 50 of file input_text_area.hpp.

◆ confirm()

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

Whether the input requires confirmation.

Definition at line 52 of file input_text_area.hpp.

◆ defaultValue()

std::string_view openpine::inputs::InputTextArea::defaultValue ( ) const
inline

Default text.

Definition at line 32 of file input_text_area.hpp.

References openpine::detail::refToView().

◆ display()

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

Display bitmask.

Definition at line 48 of file input_text_area.hpp.

◆ group()

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

Optional group name.

Definition at line 44 of file input_text_area.hpp.

References openpine::detail::optRefToView().

◆ id()

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

Input ID.

Definition at line 30 of file input_text_area.hpp.

◆ title()

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

Optional title.

Definition at line 36 of file input_text_area.hpp.

References openpine::detail::optRefToView().

◆ tooltip()

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

Optional tooltip.

Definition at line 40 of file input_text_area.hpp.

References openpine::detail::optRefToView().


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