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

#include <MediaLibraryEvent.h>

Inheritance diagram for CMediaLibraryEvent:
CUniqueEvent CBaseEvent IEvent ISortable

Public Member Functions

 CMediaLibraryEvent (const MediaType &mediaType, const std::string &mediaPath, const CVariant &label, const CVariant &description, EventLevel level=EventLevel::Information)
 
 CMediaLibraryEvent (const MediaType &mediaType, const std::string &mediaPath, const CVariant &label, const CVariant &description, const std::string &icon, EventLevel level=EventLevel::Information)
 
 CMediaLibraryEvent (const MediaType &mediaType, const std::string &mediaPath, const CVariant &label, const CVariant &description, const std::string &icon, const CVariant &details, EventLevel level=EventLevel::Information)
 
 CMediaLibraryEvent (const MediaType &mediaType, const std::string &mediaPath, const CVariant &label, const CVariant &description, const std::string &icon, const CVariant &details, const CVariant &executionLabel, EventLevel level=EventLevel::Information)
 
 ~CMediaLibraryEvent () override=default
 
const char * GetType () const override
 
std::string GetExecutionLabel () const override
 
bool CanExecute () const override
 
bool Execute () const override
 
- Public Member Functions inherited from CUniqueEvent
 ~CUniqueEvent () override=default
 
- Public Member Functions inherited from CBaseEvent
 ~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
 
CDateTime GetDateTime () const override
 
void ToSortable (SortItem &sortable, Field field) const override
 
- Public Member Functions inherited from IEvent
virtual ~IEvent ()=default
 

Protected Attributes

MediaType m_mediaType
 
std::string m_mediaPath
 
- Protected Attributes inherited from CBaseEvent
EventLevel m_level
 
std::string m_identifier
 
std::string m_icon
 
CVariant m_label
 
CVariant m_description
 
CVariant m_details
 
CVariant m_executionLabel
 

Additional Inherited Members

- Protected Member Functions inherited from CUniqueEvent
 CUniqueEvent (const CVariant &label, const CVariant &description, EventLevel level=EventLevel::Information)
 
 CUniqueEvent (const CVariant &label, const CVariant &description, const std::string &icon, EventLevel level=EventLevel::Information)
 
 CUniqueEvent (const CVariant &label, const CVariant &description, const std::string &icon, const CVariant &details, EventLevel level=EventLevel::Information)
 
 CUniqueEvent (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 CBaseEvent
 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
 

Constructor & Destructor Documentation

◆ CMediaLibraryEvent() [1/4]

CMediaLibraryEvent::CMediaLibraryEvent ( const MediaType & mediaType,
const std::string & mediaPath,
const CVariant & label,
const CVariant & description,
EventLevel level = EventLevel::Information )

◆ CMediaLibraryEvent() [2/4]

CMediaLibraryEvent::CMediaLibraryEvent ( const MediaType & mediaType,
const std::string & mediaPath,
const CVariant & label,
const CVariant & description,
const std::string & icon,
EventLevel level = EventLevel::Information )

◆ CMediaLibraryEvent() [3/4]

CMediaLibraryEvent::CMediaLibraryEvent ( const MediaType & mediaType,
const std::string & mediaPath,
const CVariant & label,
const CVariant & description,
const std::string & icon,
const CVariant & details,
EventLevel level = EventLevel::Information )

◆ CMediaLibraryEvent() [4/4]

CMediaLibraryEvent::CMediaLibraryEvent ( const MediaType & mediaType,
const std::string & mediaPath,
const CVariant & label,
const CVariant & description,
const std::string & icon,
const CVariant & details,
const CVariant & executionLabel,
EventLevel level = EventLevel::Information )

◆ ~CMediaLibraryEvent()

CMediaLibraryEvent::~CMediaLibraryEvent ( )
overridedefault

Member Function Documentation

◆ CanExecute()

bool CMediaLibraryEvent::CanExecute ( ) const
inlineoverridevirtual

Reimplemented from CBaseEvent.

◆ Execute()

bool CMediaLibraryEvent::Execute ( ) const
overridevirtual
Todo
remove the filename for now as CGUIMediaWindow::GetDirectory() can't handle it
Todo
remove the filename for now as CGUIMediaWindow::GetDirectory() can't handle it

Implements IEvent.

◆ GetExecutionLabel()

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

Reimplemented from CBaseEvent.

◆ GetType()

const char * CMediaLibraryEvent::GetType ( ) const
inlineoverridevirtual

Implements IEvent.

Member Data Documentation

◆ m_mediaPath

std::string CMediaLibraryEvent::m_mediaPath
protected

◆ m_mediaType

MediaType CMediaLibraryEvent::m_mediaType
protected

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