LibreOffice Module vcl (master)  1
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
WinSalTimer Class Referencefinal

#include <saltimer.h>

Inheritance diagram for WinSalTimer:
[legend]
Collaboration diagram for WinSalTimer:
[legend]

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
 
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 ( )
virtual WinSalTimer::~WinSalTimer ( )
overridevirtual

Member Function Documentation

bool WinSalTimer::GetForceRealTimer ( ) const
inline

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

References m_bForceRealTimer.

bool WinSalTimer::HasTimerElapsed ( ) const
inline

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

References VersionedEvent::ExistsValidEvent(), and m_bDirectTimeout.

void WinSalTimer::ImplHandle_WM_TIMER ( WPARAM  aWPARAM)
private
void WinSalTimer::ImplHandleElapsedTimer ( )
private
void WinSalTimer::ImplHandleTimerEvent ( WPARAM  aWPARAM)
private
void WinSalTimer::ImplStart ( sal_uInt64  nMS)
private
void WinSalTimer::ImplStop ( )
private
bool WinSalTimer::IsDirectTimeout ( ) const
inline

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

References m_bDirectTimeout.

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.

virtual void WinSalTimer::Start ( sal_uInt64  nMS)
overridevirtual

Implements SalTimer.

virtual void WinSalTimer::Stop ( )
overridevirtual

Implements SalTimer.

Friends And Related Function Documentation

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

Member Data Documentation

constexpr UINT_PTR WinSalTimer::m_aWmTimerId = 0xdeadbeef
staticprivate

Identifier for our SetTimer based timer.

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

bool WinSalTimer::m_bDirectTimeout
private

timeout can be processed directly

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

Referenced by HasTimerElapsed(), and IsDirectTimeout().

bool WinSalTimer::m_bForceRealTimer
private

enforce using a real timer for 0ms

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

Referenced by GetForceRealTimer().

bool WinSalTimer::m_bSetTimerRunning
private

true, if a SetTimer is running

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

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: