Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
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 ()
 
bool Get (const CGUIListItem *item=NULL)
 Get the value of this info bool This is called to update (if dirty) and fetch the value of the info bool. More...
 
bool operator== (const InfoBool &right) const
 
bool operator< (const InfoBool &right) const
 
virtual void Update (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. More...
 
const std::string & GetExpression () const
 
bool ListItemDependent () const
 

Protected Attributes

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

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 ( const CGUIListItem item = NULL)
inline

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

Parameters
itemthe item used to evaluate the bool

◆ GetExpression()

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

◆ Initialize()

virtual void INFO::InfoBool::Initialize ( void  )
inlinevirtual

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

◆ 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 ( 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::InfoSingle, and INFO::InfoExpression.

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_listItemDependent

bool INFO::InfoBool::m_listItemDependent
protected

do not cache if a listitem pointer is given

◆ m_value

bool INFO::InfoBool::m_value
protected

current value


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