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

#include <UPnPSettings.h>

Inheritance diagram for CUPnPSettings:
ISettingsHandler

Public Member Functions

void OnSettingsUnloaded () override
 Setting values have been unloaded.
 
bool Load (const std::string &file)
 
bool Save (const std::string &file) const
 
void Clear ()
 
const std::string & GetServerUUID () const
 
int GetServerPort () const
 
int GetMaximumReturnedItems () const
 
const std::string & GetRendererUUID () const
 
int GetRendererPort () const
 
void SetServerUUID (const std::string &uuid)
 
void SetServerPort (int port)
 
void SetMaximumReturnedItems (int maximumReturnedItems)
 
void SetRendererUUID (const std::string &uuid)
 
void SetRendererPort (int port)
 
- Public Member Functions inherited from ISettingsHandler
virtual ~ISettingsHandler ()=default
 
virtual bool OnSettingsLoading ()
 Settings loading has been initiated.
 
virtual void OnSettingsLoaded ()
 Settings have been loaded.
 
virtual bool OnSettingsSaving () const
 Settings saving has been initiated.
 
virtual void OnSettingsSaved () const
 Settings have been saved.
 
virtual void OnSettingsCleared ()
 Settings have been cleared.
 

Static Public Member Functions

static CUPnPSettingsGetInstance ()
 

Protected Member Functions

 CUPnPSettings ()
 
 CUPnPSettings (const CUPnPSettings &)=delete
 
CUPnPSettingsoperator= (CUPnPSettings const &)=delete
 
 ~CUPnPSettings () override
 

Constructor & Destructor Documentation

◆ CUPnPSettings() [1/2]

CUPnPSettings::CUPnPSettings ( )
protected

◆ CUPnPSettings() [2/2]

CUPnPSettings::CUPnPSettings ( const CUPnPSettings & )
protecteddelete

◆ ~CUPnPSettings()

CUPnPSettings::~CUPnPSettings ( )
overrideprotected

Member Function Documentation

◆ Clear()

void CUPnPSettings::Clear ( )

◆ GetInstance()

CUPnPSettings & CUPnPSettings::GetInstance ( )
static

◆ GetMaximumReturnedItems()

int CUPnPSettings::GetMaximumReturnedItems ( ) const
inline

◆ GetRendererPort()

int CUPnPSettings::GetRendererPort ( ) const
inline

◆ GetRendererUUID()

const std::string & CUPnPSettings::GetRendererUUID ( ) const
inline

◆ GetServerPort()

int CUPnPSettings::GetServerPort ( ) const
inline

◆ GetServerUUID()

const std::string & CUPnPSettings::GetServerUUID ( ) const
inline

◆ Load()

bool CUPnPSettings::Load ( const std::string & file)

◆ OnSettingsUnloaded()

void CUPnPSettings::OnSettingsUnloaded ( )
overridevirtual

Setting values have been unloaded.

This callback can be used to trigger uninitializing any state variables (e.g. before re-loading the settings).

Reimplemented from ISettingsHandler.

◆ operator=()

CUPnPSettings & CUPnPSettings::operator= ( CUPnPSettings const & )
protecteddelete

◆ Save()

bool CUPnPSettings::Save ( const std::string & file) const

◆ SetMaximumReturnedItems()

void CUPnPSettings::SetMaximumReturnedItems ( int maximumReturnedItems)
inline

◆ SetRendererPort()

void CUPnPSettings::SetRendererPort ( int port)
inline

◆ SetRendererUUID()

void CUPnPSettings::SetRendererUUID ( const std::string & uuid)
inline

◆ SetServerPort()

void CUPnPSettings::SetServerPort ( int port)
inline

◆ SetServerUUID()

void CUPnPSettings::SetServerUUID ( const std::string & uuid)
inline

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