Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CGUIMessage Class Referencefinal

#include <GUIMessage.h>

Public Member Functions

 CGUIMessage (int dwMsg, int senderID, int controlID, int param1=0, int param2=0)
 
 CGUIMessage (int msg, int senderID, int controlID, int param1, int param2, CFileItemList *item)
 
 CGUIMessage (int msg, int senderID, int controlID, int param1, int param2, const CGUIListItemPtr &item)
 
 CGUIMessage (const CGUIMessage &msg)
 
 ~CGUIMessage (void)
 
CGUIMessage & operator= (const CGUIMessage &msg)
 
int GetControlId () const
 
int GetMessage () const
 
void * GetPointer () const
 
CGUIListItemPtr GetItem () const
 
int GetParam1 () const
 
int GetParam2 () const
 
int GetSenderId () const
 
void SetParam1 (int param1)
 
void SetParam2 (int 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
 

Constructor & Destructor Documentation

◆ CGUIMessage() [1/4]

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

◆ CGUIMessage() [2/4]

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

◆ CGUIMessage() [3/4]

CGUIMessage::CGUIMessage ( int  msg,
int  senderID,
int  controlID,
int  param1,
int  param2,
const CGUIListItemPtr &  item 
)

◆ CGUIMessage() [4/4]

CGUIMessage::CGUIMessage ( const CGUIMessage &  msg)
default

◆ ~CGUIMessage()

CGUIMessage::~CGUIMessage ( void  )
default

Member Function Documentation

◆ GetControlId()

int CGUIMessage::GetControlId ( ) const

◆ GetItem()

CGUIListItemPtr 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

◆ GetParam2()

int CGUIMessage::GetParam2 ( ) 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

◆ SetLabel() [1/2]

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

◆ SetLabel() [2/2]

void CGUIMessage::SetLabel ( int  iString)

◆ SetParam1()

void CGUIMessage::SetParam1 ( int  param1)

◆ SetParam2()

void CGUIMessage::SetParam2 ( int  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: