CGUIPassword Class Reference

#include <GUIPassword.h>

Inheritance diagram for CGUIPassword:

Public Member Functions
	CGUIPassword (void)
	~CGUIPassword (void) override
template<typename T >
bool	IsItemUnlocked (T pItem, const std::string &strType, const std::string &strLabel, const std::string &strHeading)
bool	IsItemUnlocked (CFileItem *pItem, const std::string &strType)
	Tests if the user is allowed to access the share folder.
bool	IsItemUnlocked (CMediaSource *pItem, const std::string &strType)
	Tests if the user is allowed to access the Mediasource.
bool	CheckLock (LockType btnType, const std::string &strPassword, int iHeading)
bool	CheckLock (LockType btnType, const std::string &strPassword, int iHeading, bool &bCanceled)
bool	IsProfileLockUnlocked (int iProfile=-1)
bool	IsProfileLockUnlocked (int iProfile, bool &bCanceled, bool prompt=true)
bool	IsMasterLockUnlocked (bool bPromptUser)
bool	IsMasterLockUnlocked (bool bPromptUser, bool &bCanceled)
void	UpdateMasterLockRetryCount (bool bResetCount)
bool	CheckStartUpLock ()
bool	CheckSettingLevelLock (const SettingLevel &level, bool enforce=false)
	Checks if the current profile is allowed to access the given settings level.
bool	CheckMenuLock (int iWindowID)
bool	SetMasterLockMode (bool bDetails=true)
bool	LockSource (const std::string &strType, const std::string &strName, bool bState)
void	LockSources (bool lock)
void	RemoveSourceLocks ()
bool	IsDatabasePathUnlocked (const std::string &strPath, VECSOURCES &vecSources)
bool	IsMediaFileUnlocked (const std::string &type, const std::string &file) const
	Helper function to test if a matching mediasource is currently unlocked for a given media file.
void	SetMediaSourcePath (const std::string &strMediaSourcePath)
void	OnSettingAction (const std::shared_ptr< const CSetting > &setting) override
	The given setting has been activated.
Public Member Functions inherited from ISettingCallback
virtual	~ISettingCallback ()=default
virtual bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting is being changed.
virtual void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting has changed.
virtual bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
	The given setting needs to be updated.
virtual void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
	The given property of the given setting has changed.

Public Attributes
bool	bMasterUser
int	iMasterLockRetriesLeft

Constructor & Destructor Documentation

CGUIPassword()

CGUIPassword::CGUIPassword

(

void

)

~CGUIPassword()

CGUIPassword::~CGUIPassword ( void )

overridedefault

Member Function Documentation

CheckLock() [1/2]

bool CGUIPassword::CheckLock	(	LockType	btnType,
		const std::string &	strPassword,
		int	iHeading )

CheckLock() [2/2]

bool CGUIPassword::CheckLock	(	LockType	btnType,
		const std::string &	strPassword,
		int	iHeading,
		bool &	bCanceled )

CheckMenuLock()

bool CGUIPassword::CheckMenuLock

(

int

iWindowID

)

CheckSettingLevelLock()

bool CGUIPassword::CheckSettingLevelLock	(	const SettingLevel &	level,
		bool	enforce = false )

Checks if the current profile is allowed to access the given settings level.

Parameters

level	- The level to check
enforce	- If false, CheckSettingLevelLock is allowed to lower the current settings level to a level we're allowed to access

Returns

true if we're allowed to access the settings

CheckStartUpLock()

bool CGUIPassword::CheckStartUpLock

(

)

IsDatabasePathUnlocked()

bool CGUIPassword::IsDatabasePathUnlocked	(	const std::string &	strPath,
		VECSOURCES &	vecSources )

IsItemUnlocked() [1/3]

bool CGUIPassword::IsItemUnlocked	(	CFileItem *	pItem,
		const std::string &	strType )

Tests if the user is allowed to access the share folder.

Parameters

pItem	The share folder item to access
strType	The type of share being accessed, e.g. "music", "video", etc. See CSettings::UpdateSources()

Returns

If access is granted, returns true

IsItemUnlocked() [2/3]

bool CGUIPassword::IsItemUnlocked	(	CMediaSource *	pItem,
		const std::string &	strType )

Tests if the user is allowed to access the Mediasource.

Parameters

pItem	The share folder item to access
strType	The type of share being accessed, e.g. "music", "video", etc. See CSettings::UpdateSources()

Returns

If access is granted, returns true

IsItemUnlocked() [3/3]

template<typename T >

bool CGUIPassword::IsItemUnlocked	(	T	pItem,
		const std::string &	strType,
		const std::string &	strLabel,
		const std::string &	strHeading )

IsMasterLockUnlocked() [1/2]

bool CGUIPassword::IsMasterLockUnlocked

(

bool

bPromptUser

)

IsMasterLockUnlocked() [2/2]

bool CGUIPassword::IsMasterLockUnlocked	(	bool	bPromptUser,
		bool &	bCanceled )

IsMediaFileUnlocked()

bool CGUIPassword::IsMediaFileUnlocked	(	const std::string &	type,
		const std::string &	file ) const

Helper function to test if a matching mediasource is currently unlocked for a given media file.

Note

this function only returns the lock state. it does not provide unlock functionality

Parameters

type	The type of share being accessed, e.g. "music", "video", etc.
file	The file to check lock state for

Returns

If access is granted, returns true

IsProfileLockUnlocked() [1/2]

bool CGUIPassword::IsProfileLockUnlocked	(	int	iProfile,
		bool &	bCanceled,
		bool	prompt = true )

IsProfileLockUnlocked() [2/2]

bool CGUIPassword::IsProfileLockUnlocked

(

int

iProfile = -1

)

LockSource()

bool CGUIPassword::LockSource	(	const std::string &	strType,
		const std::string &	strName,
		bool	bState )

LockSources()

void CGUIPassword::LockSources

(

bool

lock

)

OnSettingAction()

void CGUIPassword::OnSettingAction ( const std::shared_ptr< const CSetting > & setting )

overridevirtual

The given setting has been activated.

This callback is triggered whenever the given setting has been activated. This callback is only fired for CSettingAction settings.

Parameters

setting

The setting which has been activated.

Reimplemented from ISettingCallback.

RemoveSourceLocks()

void CGUIPassword::RemoveSourceLocks

(

)

SetMasterLockMode()

bool CGUIPassword::SetMasterLockMode

(

bool

bDetails = true

)

SetMediaSourcePath()

void CGUIPassword::SetMediaSourcePath ( const std::string & strMediaSourcePath )

inline

UpdateMasterLockRetryCount()

void CGUIPassword::UpdateMasterLockRetryCount

(

bool

bResetCount

)

Member Data Documentation

bMasterUser

bool CGUIPassword::bMasterUser

iMasterLockRetriesLeft

int CGUIPassword::iMasterLockRetriesLeft

---

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

• GUIPassword.h
• GUIPassword.cpp