Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
INFO::InfoBool Class Reference

Base class, wrapping boolean conditions and expressions. More...

#include <InfoBool.h>

Inheritance diagram for INFO::InfoBool:
INFO::InfoExpression INFO::InfoSingle

Public Member Functions

 InfoBool (const std::string &expression, int context, unsigned int &refreshCounter)
 
virtual ~InfoBool ()=default
 
virtual void Initialize (CGUIInfoManager *infoMgr)
 
bool Get (int contextWindow, const CGUIListItem *item=nullptr)
 Get the value of this info bool This is called to update (if dirty) and fetch the value of the info bool.
 
bool operator== (const InfoBool &right) const
 
bool operator< (const InfoBool &right) const
 
virtual void Update (int contextWindow, const CGUIListItem *item)
 Update the value of this info bool This is called if and only if the info bool is dirty, allowing it to update it's current value.
 
const std::string & GetExpression () const
 
bool ListItemDependent () const
 

Protected Attributes

bool m_value = false
 current value
 
int m_context
 contextual information to go with the condition
 
bool m_listItemDependent = false
 do not cache if a listitem pointer is given
 
std::string m_expression
 original expression
 
CGUIInfoManagerm_infoMgr
 

Detailed Description

Base class, wrapping boolean conditions and expressions.

Constructor & Destructor Documentation

◆ InfoBool()

INFO::InfoBool::InfoBool ( const std::string & expression,
int context,
unsigned int & refreshCounter )

◆ ~InfoBool()

virtual INFO::InfoBool::~InfoBool ( )
virtualdefault

Member Function Documentation

◆ Get()

bool INFO::InfoBool::Get ( int contextWindow,
const CGUIListItem * item = nullptr )
inline

Get the value of this info bool This is called to update (if dirty) and fetch the value of the info bool.

Parameters
contextWindowthe context (window id) where this condition is being evaluated
itemthe item used to evaluate the bool

◆ GetExpression()

const std::string & INFO::InfoBool::GetExpression ( ) const
inline

◆ Initialize()

virtual void INFO::InfoBool::Initialize ( CGUIInfoManager * infoMgr)
inlinevirtual

Reimplemented in INFO::InfoExpression, and INFO::InfoSingle.

◆ ListItemDependent()

bool INFO::InfoBool::ListItemDependent ( ) const
inline

◆ operator<()

bool INFO::InfoBool::operator< ( const InfoBool & right) const
inline

◆ operator==()

bool INFO::InfoBool::operator== ( const InfoBool & right) const
inline

◆ Update()

virtual void INFO::InfoBool::Update ( int contextWindow,
const CGUIListItem * item )
inlinevirtual

Update the value of this info bool This is called if and only if the info bool is dirty, allowing it to update it's current value.

Reimplemented in INFO::InfoExpression, and INFO::InfoSingle.

Member Data Documentation

◆ m_context

int INFO::InfoBool::m_context
protected

contextual information to go with the condition

◆ m_expression

std::string INFO::InfoBool::m_expression
protected

original expression

◆ m_infoMgr

CGUIInfoManager* INFO::InfoBool::m_infoMgr
protected

◆ m_listItemDependent

bool INFO::InfoBool::m_listItemDependent = false
protected

do not cache if a listitem pointer is given

◆ m_value

bool INFO::InfoBool::m_value = false
protected

current value


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