AccessibleTextEventQueue.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_SVX_SOURCE_ACCESSIBILITY_ACCESSIBLETEXTEVENTQUEUE_HXX
#define INCLUDED_SVX_SOURCE_ACCESSIBILITY_ACCESSIBLETEXTEVENTQUEUE_HXX
 
#include <memory>
#include <deque>
#include <algorithm>
 
class SfxHint;
class SdrHint;
class TextHint;
class SvxViewChangedHint;
class SvxEditSourceHint;
 
namespace accessibility
{
    class AccessibleTextEventQueue
    {
    public:
        typedef ::std::deque< SfxHint* > EventQueue;
 
        AccessibleTextEventQueue();
        ~AccessibleTextEventQueue();
 
        void Append( const SdrHint& rHint );
        void Append( const TextHint& rHint );
        void Append( const SvxViewChangedHint& rHint );
        void Append( const SvxEditSourceHint& rHint );
 
        ::std::unique_ptr< SfxHint > PopFront();
 
        template < typename Functor > void ForEach( Functor& rFunctor ) const
        {
            // #109864# Make sure results are put back into rFunctor
            rFunctor = ::std::for_each( maEventQueue.begin(), maEventQueue.end(), rFunctor );
        }
 
        bool IsEmpty() const;
 
        void Clear();
 
    private:
        EventQueue maEventQueue;
    };
 
} // end of namespace accessibility
 
#endif // INCLUDED_SVX_SOURCE_ACCESSIBILITY_ACCESSIBLETEXTEVENTQUEUE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */