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

#include <GUIMessage.h>

Public Member Functions

 CGUIMessage (int dwMsg, int senderID, int controlID, int64_t param1=0, int64_t param2=0)
 
 CGUIMessage (int msg, int senderID, int controlID, int64_t param1, int64_t param2, CFileItemList *item)
 
 CGUIMessage (int msg, int senderID, int controlID, int64_t param1, int64_t param2, const std::shared_ptr< CGUIListItem > &item)
 
 CGUIMessage (const CGUIMessage &msg)
 
 ~CGUIMessage (void)
 
CGUIMessageoperator= (const CGUIMessage &msg)
 
int GetControlId () const
 
int GetMessage () const
 
voidGetPointer () const
 
std::shared_ptr< CGUIListItemGetItem () const
 
int GetParam1 () const
 
int64_t GetParam1AsI64 () const
 
int GetParam2 () const
 
int64_t GetParam2AsI64 () const
 
int GetSenderId () const
 
void SetParam1 (int64_t param1)
 
void SetParam2 (int64_t param2)
 
void SetPointer (void *pointer)
 
void SetLabel (const std::string &strLabel)
 
void SetLabel (int iString)
 
const std::string & GetLabel () const
 
void SetStringParam (const std::string &strParam)
 
void SetStringParams (const std::vector< std::string > &params)
 
const std::string & GetStringParam (size_t param=0) const
 
size_t GetNumStringParams () const
 
void SetItem (std::shared_ptr< CGUIListItem > item)
 

Constructor & Destructor Documentation

◆ CGUIMessage() [1/4]

CGUIMessage::CGUIMessage ( int dwMsg,
int senderID,
int controlID,
int64_t param1 = 0,
int64_t param2 = 0 )

◆ CGUIMessage() [2/4]

CGUIMessage::CGUIMessage ( int msg,
int senderID,
int controlID,
int64_t param1,
int64_t param2,
CFileItemList * item )

◆ CGUIMessage() [3/4]

CGUIMessage::CGUIMessage ( int msg,
int senderID,
int controlID,
int64_t param1,
int64_t param2,
const std::shared_ptr< CGUIListItem > & item )

◆ CGUIMessage() [4/4]

CGUIMessage::CGUIMessage ( const CGUIMessage & msg)
default

◆ ~CGUIMessage()

CGUIMessage::~CGUIMessage ( void )
default

Member Function Documentation

◆ GetControlId()

int CGUIMessage::GetControlId ( ) const

◆ GetItem()

std::shared_ptr< CGUIListItem > CGUIMessage::GetItem ( ) const

◆ GetLabel()

const std::string & CGUIMessage::GetLabel ( ) const

◆ GetMessage()

int CGUIMessage::GetMessage ( ) const

◆ GetNumStringParams()

size_t CGUIMessage::GetNumStringParams ( ) const

◆ GetParam1()

int CGUIMessage::GetParam1 ( ) const

◆ GetParam1AsI64()

int64_t CGUIMessage::GetParam1AsI64 ( ) const

◆ GetParam2()

int CGUIMessage::GetParam2 ( ) const

◆ GetParam2AsI64()

int64_t CGUIMessage::GetParam2AsI64 ( ) const

◆ GetPointer()

void * CGUIMessage::GetPointer ( ) const

◆ GetSenderId()

int CGUIMessage::GetSenderId ( ) const

◆ GetStringParam()

const std::string & CGUIMessage::GetStringParam ( size_t param = 0) const

◆ operator=()

CGUIMessage & CGUIMessage::operator= ( const CGUIMessage & msg)
default

◆ SetItem()

void CGUIMessage::SetItem ( std::shared_ptr< CGUIListItem > item)

◆ SetLabel() [1/2]

void CGUIMessage::SetLabel ( const std::string & strLabel)

◆ SetLabel() [2/2]

void CGUIMessage::SetLabel ( int iString)

◆ SetParam1()

void CGUIMessage::SetParam1 ( int64_t param1)

◆ SetParam2()

void CGUIMessage::SetParam2 ( int64_t param2)

◆ SetPointer()

void CGUIMessage::SetPointer ( void * pointer)

◆ SetStringParam()

void CGUIMessage::SetStringParam ( const std::string & strParam)

◆ SetStringParams()

void CGUIMessage::SetStringParams ( const std::vector< std::string > & params)

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