SalUserEventList Class Reference

#include <salusereventlist.hxx>

Inheritance diagram for SalUserEventList:

Collaboration diagram for SalUserEventList:

Classes
struct	SalUserEvent

Public Member Functions
	SalUserEventList ()
virtual	~SalUserEventList () COVERITY_NOEXCEPT_FALSE
const SalFrameSet &	getFrames () const
SalFrame *	anyFrame () const
void	insertFrame (SalFrame *pFrame)
void	eraseFrame (SalFrame *pFrame)
bool	isFrameAlive (const SalFrame *pFrame) const
void	PostEvent (SalFrame *pFrame, void *pData, SalEvent nEvent)
void	RemoveEvent (SalFrame *pFrame, void *pData, SalEvent nEvent)
bool	HasUserEvents () const
bool	DispatchUserEvents (bool bHandleAllCurrentEvents)

Protected Member Functions
virtual void	ProcessEvent (SalUserEvent aEvent)=0
virtual void	TriggerUserEventProcessing ()=0
virtual void	TriggerAllUserEventsProcessed ()
bool	HasUserEvents_NoLock () const

Protected Attributes
std::mutex	m_aUserEventsMutex
std::list< SalUserEvent >	m_aUserEvents
std::list< SalUserEvent >	m_aProcessingUserEvents
bool	m_bAllUserEventProcessedSignaled
SalFrameSet	m_aFrames
oslThreadIdentifier	m_aProcessingThread

Detailed Description

Definition at line 36 of file salusereventlist.hxx.

Constructor & Destructor Documentation

SalUserEventList()

SalUserEventList::SalUserEventList

(

)

Definition at line 35 of file salusereventlist.cxx.

~SalUserEventList()

SalUserEventList::~SalUserEventList ( )

virtual

Definition at line 41 of file salusereventlist.cxx.

Member Function Documentation

anyFrame()

SalFrame * SalUserEventList::anyFrame ( ) const

inline

Definition at line 89 of file salusereventlist.hxx.

References o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::begin(), and o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::empty().

DispatchUserEvents()

bool SalUserEventList::DispatchUserEvents

(

bool

bHandleAllCurrentEvents

)

Definition at line 59 of file salusereventlist.cxx.

References aEvent, DBG_TESTSOLARMUTEX, HasUserEvents_NoLock(), isFrameAlive(), m_aProcessingThread, m_aProcessingUserEvents, m_aUserEvents, m_aUserEventsMutex, m_bAllUserEventProcessedSignaled, NONE, ProcessEvent(), TriggerAllUserEventsProcessed(), and UserEvent.

eraseFrame()

void SalUserEventList::eraseFrame

(

SalFrame *

pFrame

)

Definition at line 51 of file salusereventlist.cxx.

References o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::end(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::erase(), o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::find(), and m_aFrames.

Referenced by SvpSalInstance::deregisterFrame().

getFrames()

const SalFrameSet & SalUserEventList::getFrames ( ) const

inline

Definition at line 121 of file salusereventlist.hxx.

HasUserEvents()

bool SalUserEventList::HasUserEvents ( ) const

inline

Definition at line 102 of file salusereventlist.hxx.

HasUserEvents_NoLock()

bool SalUserEventList::HasUserEvents_NoLock ( ) const

inlineprotected

Definition at line 108 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

insertFrame()

void SalUserEventList::insertFrame

(

SalFrame *

pFrame

)

Definition at line 45 of file salusereventlist.cxx.

References o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::insert(), and m_aFrames.

Referenced by SvpSalInstance::registerFrame().

isFrameAlive()

bool SalUserEventList::isFrameAlive ( const SalFrame *  pFrame ) const

inline

Definition at line 96 of file salusereventlist.hxx.

References o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::end(), and o3tl::sorted_vector< typename Value, typename Compare, template< typename, typename > class Find, bool >::find().

Referenced by DispatchUserEvents(), and AquaSalFrame::isAlive().

PostEvent()

void SalUserEventList::PostEvent ( SalFrame *  pFrame, void *  pData, SalEvent  nEvent  )

inline

Definition at line 113 of file salusereventlist.hxx.

References pData.

ProcessEvent()

virtual void SalUserEventList::ProcessEvent ( SalUserEvent  aEvent )

protectedpure virtual

Implemented in SvpSalInstance, AquaSalInstance, QtInstance, and SalGenericDisplay.

Referenced by DispatchUserEvents().

RemoveEvent()

void SalUserEventList::RemoveEvent	(	SalFrame *	pFrame,
		void *	pData,
		SalEvent	nEvent
	)

Definition at line 138 of file salusereventlist.cxx.

References aEvent, HasUserEvents_NoLock(), m_aProcessingUserEvents, m_aUserEvents, m_aUserEventsMutex, m_bAllUserEventProcessedSignaled, pData, and TriggerAllUserEventsProcessed().

TriggerAllUserEventsProcessed()

virtual void SalUserEventList::TriggerAllUserEventsProcessed ( )

inlineprotectedvirtual

Reimplemented in GtkSalDisplay.

Definition at line 69 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

TriggerUserEventProcessing()

virtual void SalUserEventList::TriggerUserEventProcessing ( )

protectedpure virtual

Implemented in SvpSalInstance, AquaSalInstance, QtInstance, GtkSalDisplay, and SalX11Display.

Member Data Documentation

m_aFrames

SalFrameSet SalUserEventList::m_aFrames

protected

Definition at line 64 of file salusereventlist.hxx.

Referenced by eraseFrame(), SalDisplay::getFrames(), and insertFrame().

m_aProcessingThread

oslThreadIdentifier SalUserEventList::m_aProcessingThread

protected

Definition at line 65 of file salusereventlist.hxx.

Referenced by DispatchUserEvents().

m_aProcessingUserEvents

std::list< SalUserEvent > SalUserEventList::m_aProcessingUserEvents

protected

Definition at line 62 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

m_aUserEvents

std::list< SalUserEvent > SalUserEventList::m_aUserEvents

protected

Definition at line 61 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

m_aUserEventsMutex

std::mutex SalUserEventList::m_aUserEventsMutex

mutableprotected

Definition at line 60 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

m_bAllUserEventProcessedSignaled

bool SalUserEventList::m_bAllUserEventProcessedSignaled

protected

Definition at line 63 of file salusereventlist.hxx.

Referenced by DispatchUserEvents(), and RemoveEvent().

---

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

• salusereventlist.hxx
• salusereventlist.cxx