Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CBaseEvent Class Reference

#include <BaseEvent.h>

Inheritance diagram for CBaseEvent:
IEvent ISortable CUniqueEvent CAddonEvent CMediaLibraryEvent CNotificationEvent CAddonManagementEvent

Public Member Functions

 ~CBaseEvent () override=default
 
std::string GetIdentifier () const override
 
EventLevel GetLevel () const override
 
std::string GetLabel () const override
 
std::string GetIcon () const override
 
std::string GetDescription () const override
 
std::string GetDetails () const override
 
std::string GetExecutionLabel () const override
 
CDateTime GetDateTime () const override
 
bool CanExecute () const override
 
void ToSortable (SortItem &sortable, Field field) const override
 
- Public Member Functions inherited from IEvent
virtual ~IEvent ()=default
 
virtual const char * GetType () const =0
 
virtual bool Execute () const =0
 

Protected Member Functions

 CBaseEvent (const std::string &identifier, const CVariant &label, const CVariant &description, EventLevel level=EventLevel::Information)
 
 CBaseEvent (const std::string &identifier, const CVariant &label, const CVariant &description, const std::string &icon, EventLevel level=EventLevel::Information)
 
 CBaseEvent (const std::string &identifier, const CVariant &label, const CVariant &description, const std::string &icon, const CVariant &details, EventLevel level=EventLevel::Information)
 
 CBaseEvent (const std::string &identifier, const CVariant &label, const CVariant &description, const std::string &icon, const CVariant &details, const CVariant &executionLabel, EventLevel level=EventLevel::Information)
 
- Protected Member Functions inherited from ISortable
 ~ISortable ()=default
 

Protected Attributes

EventLevel m_level
 
std::string m_identifier
 
std::string m_icon
 
CVariant m_label
 
CVariant m_description
 
CVariant m_details
 
CVariant m_executionLabel
 

Constructor & Destructor Documentation

§ ~CBaseEvent()

CBaseEvent::~CBaseEvent ( )
overridedefault

§ CBaseEvent() [1/4]

CBaseEvent::CBaseEvent ( const std::string &  identifier,
const CVariant &  label,
const CVariant &  description,
EventLevel  level = EventLevel::Information 
)
protected

§ CBaseEvent() [2/4]

CBaseEvent::CBaseEvent ( const std::string &  identifier,
const CVariant &  label,
const CVariant &  description,
const std::string &  icon,
EventLevel  level = EventLevel::Information 
)
protected

§ CBaseEvent() [3/4]

CBaseEvent::CBaseEvent ( const std::string &  identifier,
const CVariant &  label,
const CVariant &  description,
const std::string &  icon,
const CVariant &  details,
EventLevel  level = EventLevel::Information 
)
protected

§ CBaseEvent() [4/4]

CBaseEvent::CBaseEvent ( const std::string &  identifier,
const CVariant &  label,
const CVariant &  description,
const std::string &  icon,
const CVariant &  details,
const CVariant &  executionLabel,
EventLevel  level = EventLevel::Information 
)
protected

Member Function Documentation

§ CanExecute()

bool CBaseEvent::CanExecute ( ) const
inlineoverridevirtual

Implements IEvent.

Reimplemented in CNotificationEvent, and CMediaLibraryEvent.

§ GetDateTime()

CDateTime CBaseEvent::GetDateTime ( ) const
inlineoverridevirtual

Implements IEvent.

§ GetDescription()

std::string CBaseEvent::GetDescription ( ) const
overridevirtual

Implements IEvent.

§ GetDetails()

std::string CBaseEvent::GetDetails ( ) const
overridevirtual

Implements IEvent.

§ GetExecutionLabel()

std::string CBaseEvent::GetExecutionLabel ( ) const
overridevirtual

Implements IEvent.

Reimplemented in CMediaLibraryEvent.

§ GetIcon()

std::string CBaseEvent::GetIcon ( ) const
inlineoverridevirtual

Implements IEvent.

§ GetIdentifier()

std::string CBaseEvent::GetIdentifier ( ) const
inlineoverridevirtual

Implements IEvent.

§ GetLabel()

std::string CBaseEvent::GetLabel ( ) const
overridevirtual

Implements IEvent.

§ GetLevel()

EventLevel CBaseEvent::GetLevel ( ) const
inlineoverridevirtual

Implements IEvent.

§ ToSortable()

void CBaseEvent::ToSortable ( SortItem &  sortable,
Field  field 
) const
overridevirtual

Implements IEvent.

Member Data Documentation

§ m_description

CVariant CBaseEvent::m_description
protected

§ m_details

CVariant CBaseEvent::m_details
protected

§ m_executionLabel

CVariant CBaseEvent::m_executionLabel
protected

§ m_icon

std::string CBaseEvent::m_icon
protected

§ m_identifier

std::string CBaseEvent::m_identifier
protected

§ m_label

CVariant CBaseEvent::m_label
protected

§ m_level

EventLevel CBaseEvent::m_level
protected
The documentation for this class was generated from the following files: