WinSalTimer Class Reference

#include <saltimer.h>

Inheritance diagram for WinSalTimer:

Collaboration diagram for WinSalTimer:

Public Member Functions
	WinSalTimer ()
virtual	~WinSalTimer () override
virtual void	Start (sal_uInt64 nMS) override
virtual void	Stop () override
bool	IsDirectTimeout () const
bool	HasTimerElapsed () const
void	SetForceRealTimer (bool bVal)
	Enforces the usage of a real timer instead of the message queue. More...
bool	GetForceRealTimer () const
Public Member Functions inherited from SalTimer
	SalTimer ()
virtual	~SalTimer () COVERITY_NOEXCEPT_FALSE
virtual void	Start (sal_uInt64 nMS)=0
virtual void	Stop ()=0
void	SetCallback (SALTIMERPROC pProc)
void	CallCallback ()

Private Member Functions
void	ImplStart (sal_uInt64 nMS)
void	ImplStop ()
void	ImplHandleTimerEvent (WPARAM aWPARAM)
void	ImplHandleElapsedTimer ()
void	ImplHandle_WM_TIMER (WPARAM aWPARAM)

Private Attributes
HANDLE	m_nTimerId
	Windows timer id. More...
bool	m_bDirectTimeout
	timeout can be processed directly More...
bool	m_bForceRealTimer
	enforce using a real timer for 0ms More...
bool	m_bSetTimerRunning
	true, if a SetTimer is running More...

Static Private Attributes
static constexpr UINT_PTR	m_aWmTimerId = 0xdeadbeef
	Identifier for our SetTimer based timer. More...

Friends
LRESULT CALLBACK	SalComWndProc (HWND, UINT nMsg, WPARAM wParam, LPARAM lParam, bool &rDef)
void CALLBACK	SalTimerProc (PVOID data, BOOLEAN)
bool	ImplSalYield (bool bWait, bool bHandleAllCurrentEvents)

Additional Inherited Members
Protected Member Functions inherited from VersionedEvent
	VersionedEvent ()
sal_Int32	GetNextEventVersion ()
void	InvalidateEvent ()
bool	ExistsValidEvent () const
bool	IsValidEventVersion (const sal_Int32 nEventVersion) const

Detailed Description

Definition at line 25 of file win/saltimer.h.

Constructor & Destructor Documentation

WinSalTimer()

WinSalTimer::WinSalTimer

(

)

~WinSalTimer()

virtual WinSalTimer::~WinSalTimer ( )

overridevirtual

Member Function Documentation

GetForceRealTimer()

bool WinSalTimer::GetForceRealTimer ( ) const

inline

Definition at line 79 of file win/saltimer.h.

References m_bForceRealTimer.

HasTimerElapsed()

bool WinSalTimer::HasTimerElapsed ( ) const

inline

Definition at line 74 of file win/saltimer.h.

References VersionedEvent::ExistsValidEvent(), and m_bDirectTimeout.

ImplHandle_WM_TIMER()

void WinSalTimer::ImplHandle_WM_TIMER ( WPARAM  aWPARAM )

private

ImplHandleElapsedTimer()

void WinSalTimer::ImplHandleElapsedTimer ( )

private

ImplHandleTimerEvent()

void WinSalTimer::ImplHandleTimerEvent ( WPARAM  aWPARAM )

private

ImplStart()

void WinSalTimer::ImplStart ( sal_uInt64  nMS )

private

ImplStop()

void WinSalTimer::ImplStop ( )

private

IsDirectTimeout()

bool WinSalTimer::IsDirectTimeout ( ) const

inline

Definition at line 69 of file win/saltimer.h.

References m_bDirectTimeout.

SetForceRealTimer()

void WinSalTimer::SetForceRealTimer

(

bool

bVal

)

Enforces the usage of a real timer instead of the message queue.

Needed for Window resize processing, as this starts a modal event loop.

Start()

virtual void WinSalTimer::Start ( sal_uInt64  nMS )

overridevirtual

Implements SalTimer.

Stop()

virtual void WinSalTimer::Stop ( )

overridevirtual

Implements SalTimer.

Friends And Related Function Documentation

ImplSalYield

bool ImplSalYield ( bool  bWait, bool  bHandleAllCurrentEvents  )

friend

SalComWndProc

LRESULT CALLBACK SalComWndProc ( HWND  , UINT  nMsg, WPARAM  wParam, LPARAM  lParam, bool &  rDef  )

friend

SalTimerProc

void CALLBACK SalTimerProc ( PVOID  data, BOOLEAN    )

friend

Member Data Documentation

m_aWmTimerId

constexpr UINT_PTR WinSalTimer::m_aWmTimerId = 0xdeadbeef

staticconstexprprivate

Identifier for our SetTimer based timer.

Definition at line 37 of file win/saltimer.h.

m_bDirectTimeout

bool WinSalTimer::m_bDirectTimeout

private

timeout can be processed directly

Definition at line 40 of file win/saltimer.h.

Referenced by HasTimerElapsed(), and IsDirectTimeout().

m_bForceRealTimer

bool WinSalTimer::m_bForceRealTimer

private

enforce using a real timer for 0ms

Definition at line 41 of file win/saltimer.h.

Referenced by GetForceRealTimer().

m_bSetTimerRunning

bool WinSalTimer::m_bSetTimerRunning

private

true, if a SetTimer is running

Definition at line 42 of file win/saltimer.h.

m_nTimerId

HANDLE WinSalTimer::m_nTimerId

private

Windows timer id.

Definition at line 39 of file win/saltimer.h.

---

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

• win/saltimer.h