LibreOffice Module svx (master)  1
Public Types | Public Member Functions | Private Attributes | List of all members
accessibility::AccessibleTextEventQueue Class Reference

This class handles the notification events for the AccessibleTextHelper class. More...

#include <AccessibleTextEventQueue.hxx>

Public Types

typedef ::std::deque< SfxHint * > EventQueue
 

Public Member Functions

 AccessibleTextEventQueue ()
 
 ~AccessibleTextEventQueue ()
 
void Append (const SdrHint &rHint)
 Append event to end of queue. More...
 
void Append (const TextHint &rHint)
 Append event to end of queue. More...
 
void Append (const SvxViewChangedHint &rHint)
 Append event to end of queue. More...
 
void Append (const SvxEditSourceHint &rHint)
 Append event to end of queue. More...
 
::std::unique_ptr< SfxHintPopFront ()
 Pop first queue element. More...
 
template<typename Functor >
void ForEach (Functor &rFunctor) const
 Apply functor to every queue member. More...
 
bool IsEmpty () const
 Query whether queue is empty. More...
 
void Clear ()
 Clear event queue. More...
 

Private Attributes

EventQueue maEventQueue
 

Detailed Description

This class handles the notification events for the AccessibleTextHelper class.

For various reasons, we cannot process EditEngine events as they arrive, but have to queue and handle them in a batch.

Definition at line 41 of file AccessibleTextEventQueue.hxx.

Member Typedef Documentation

Definition at line 44 of file AccessibleTextEventQueue.hxx.

Constructor & Destructor Documentation

accessibility::AccessibleTextEventQueue::AccessibleTextEventQueue ( )

Definition at line 41 of file AccessibleTextEventQueue.cxx.

accessibility::AccessibleTextEventQueue::~AccessibleTextEventQueue ( )

Definition at line 45 of file AccessibleTextEventQueue.cxx.

References Clear().

Member Function Documentation

void accessibility::AccessibleTextEventQueue::Append ( const SdrHint rHint)

Append event to end of queue.

Definition at line 50 of file AccessibleTextEventQueue.cxx.

References BeginEdit, EndEdit, SdrHint::GetKind(), and maEventQueue.

Referenced by accessibility::AccessibleTextHelper_Impl::Notify().

void accessibility::AccessibleTextEventQueue::Append ( const TextHint rHint)

Append event to end of queue.

Definition at line 61 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

void accessibility::AccessibleTextEventQueue::Append ( const SvxViewChangedHint rHint)

Append event to end of queue.

Definition at line 66 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

void accessibility::AccessibleTextEventQueue::Append ( const SvxEditSourceHint rHint)

Append event to end of queue.

Definition at line 71 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

void accessibility::AccessibleTextEventQueue::Clear ( )

Clear event queue.

Definition at line 88 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

Referenced by accessibility::AccessibleTextHelper_Impl::Notify(), and ~AccessibleTextEventQueue().

template<typename Functor >
void accessibility::AccessibleTextEventQueue::ForEach ( Functor &  rFunctor) const
inline

Apply functor to every queue member.

Parameters
rFunctorFunctor to apply. Functor receives queue element as parameter: void func( const SfxHint* );

Definition at line 70 of file AccessibleTextEventQueue.hxx.

References maEventQueue.

Referenced by accessibility::AccessibleTextHelper_Impl::ProcessQueue().

bool accessibility::AccessibleTextEventQueue::IsEmpty ( ) const

Query whether queue is empty.

Definition at line 83 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

Referenced by accessibility::AccessibleTextHelper_Impl::ProcessQueue().

std::unique_ptr< SfxHint > accessibility::AccessibleTextEventQueue::PopFront ( )

Pop first queue element.

return first queue element, ownership transfers to caller

Definition at line 76 of file AccessibleTextEventQueue.cxx.

References maEventQueue.

Referenced by accessibility::AccessibleTextHelper_Impl::ProcessQueue().

Member Data Documentation

EventQueue accessibility::AccessibleTextEventQueue::maEventQueue
private

Definition at line 83 of file AccessibleTextEventQueue.hxx.

Referenced by Append(), Clear(), ForEach(), IsEmpty(), and PopFront().


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