ESPHome  2024.11.0
Public Member Functions | Protected Attributes
esphome::select::SelectCall Class Reference

#include <select_call.h>

Public Member Functions

 SelectCall (Select *parent)
 
void perform ()
 
SelectCallset_option (const std::string &option)
 
SelectCallset_index (size_t index)
 
SelectCallselect_next (bool cycle)
 
SelectCallselect_previous (bool cycle)
 
SelectCallselect_first ()
 
SelectCallselect_last ()
 
SelectCallwith_operation (SelectOperation operation)
 
SelectCallwith_cycle (bool cycle)
 
SelectCallwith_option (const std::string &option)
 
SelectCallwith_index (size_t index)
 

Protected Attributes

Select *const parent_
 
optional< std::string > option_
 
optional< size_t > index_
 
SelectOperation operation_ {SELECT_OP_NONE}
 
bool cycle_
 

Detailed Description

Definition at line 20 of file select_call.h.

Constructor & Destructor Documentation

◆ SelectCall()

esphome::select::SelectCall::SelectCall ( Select parent)
inlineexplicit

Definition at line 22 of file select_call.h.

Member Function Documentation

◆ perform()

void esphome::select::SelectCall::perform ( )

Definition at line 44 of file select_call.cpp.

◆ select_first()

SelectCall & esphome::select::SelectCall::select_first ( )

Definition at line 20 of file select_call.cpp.

◆ select_last()

SelectCall & esphome::select::SelectCall::select_last ( )

Definition at line 22 of file select_call.cpp.

◆ select_next()

SelectCall & esphome::select::SelectCall::select_next ( bool  cycle)

Definition at line 16 of file select_call.cpp.

◆ select_previous()

SelectCall & esphome::select::SelectCall::select_previous ( bool  cycle)

Definition at line 18 of file select_call.cpp.

◆ set_index()

SelectCall & esphome::select::SelectCall::set_index ( size_t  index)

Definition at line 14 of file select_call.cpp.

◆ set_option()

SelectCall & esphome::select::SelectCall::set_option ( const std::string &  option)

Definition at line 10 of file select_call.cpp.

◆ with_cycle()

SelectCall & esphome::select::SelectCall::with_cycle ( bool  cycle)

Definition at line 29 of file select_call.cpp.

◆ with_index()

SelectCall & esphome::select::SelectCall::with_index ( size_t  index)

Definition at line 39 of file select_call.cpp.

◆ with_operation()

SelectCall & esphome::select::SelectCall::with_operation ( SelectOperation  operation)

Definition at line 24 of file select_call.cpp.

◆ with_option()

SelectCall & esphome::select::SelectCall::with_option ( const std::string &  option)

Definition at line 34 of file select_call.cpp.

Field Documentation

◆ cycle_

bool esphome::select::SelectCall::cycle_
protected

Definition at line 43 of file select_call.h.

◆ index_

optional<size_t> esphome::select::SelectCall::index_
protected

Definition at line 41 of file select_call.h.

◆ operation_

SelectOperation esphome::select::SelectCall::operation_ {SELECT_OP_NONE}
protected

Definition at line 42 of file select_call.h.

◆ option_

optional<std::string> esphome::select::SelectCall::option_
protected

Definition at line 40 of file select_call.h.

◆ parent_

Select* const esphome::select::SelectCall::parent_
protected

Definition at line 39 of file select_call.h.


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