include/comphelper/SelectionMultiplex.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_COMPHELPER_SELECTIONMULTIPLEX_HXX
  21 #define INCLUDED_COMPHELPER_SELECTIONMULTIPLEX_HXX
  22
  23 #include <com/sun/star/view/XSelectionChangeListener.hpp>
  24 #include <com/sun/star/lang/EventObject.hpp>
  25 #include <cppuhelper/implbase.hxx>
  26 #include <comphelper/comphelperdllapi.h>
  27
  28 namespace com::sun::star::view { class XSelectionSupplier; }
  29
  30 //= selection helper classes
  31
  32
  33 namespace comphelper
  34 {
  35
  36
  37     //= OSelectionChangeListener
  38
  39     /// simple listener adapter for selections
  40     class COMPHELPER_DLLPUBLIC OSelectionChangeListener
  41     {
  42         friend class OSelectionChangeMultiplexer;
  43
  44     public:
  45         virtual ~OSelectionChangeListener();
  46
  47         /// @throws css::uno::RuntimeException
  48         virtual void _selectionChanged( const css::lang::EventObject& aEvent ) = 0;
  49         /// @throws css::uno::RuntimeException
  50         virtual void _disposing(const css::lang::EventObject& _rSource);
  51     };
  52
  53
  54     //= OSelectionChangeMultiplexer
  55
  56     /// multiplexer for selection changes
  57     class COMPHELPER_DLLPUBLIC OSelectionChangeMultiplexer final : public cppu::WeakImplHelper< css::view::XSelectionChangeListener>
  58     {
  59         friend class OSelectionChangeListener;
  60         css::uno::Reference< css::view::XSelectionSupplier>  m_xSet;
  61         OSelectionChangeListener*                            m_pListener;
  62         sal_Int32                                            m_nLockCount;
  63
  64         OSelectionChangeMultiplexer(const OSelectionChangeMultiplexer&) = delete;
  65         OSelectionChangeMultiplexer& operator=(const OSelectionChangeMultiplexer&) = delete;
  66
  67         virtual ~OSelectionChangeMultiplexer() override;
  68     public:
  69         OSelectionChangeMultiplexer(OSelectionChangeListener* _pListener, const  css::uno::Reference< css::view::XSelectionSupplier>& _rxSet);
  70
  71     // XEventListener
  72         virtual void SAL_CALL disposing( const  css::lang::EventObject& Source ) override;
  73
  74     // XSelectionChangeListener
  75         virtual void SAL_CALL selectionChanged( const css::lang::EventObject& aEvent ) override;
  76
  77         /// incremental lock
  78         void        lock();
  79         /// incremental unlock
  80         void        unlock();
  81         /// get the lock count
  82         sal_Int32   locked() const { return m_nLockCount; }
  83
  84         void dispose();
  85     };
  86
  87
  88 }   // namespace comphelper
  89
  90
  91 #endif // INCLUDED_COMPHELPER_SELECTIONMULTIPLEX_HXX
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */