dbaccess/source/core/dataaccess/documenteventnotifier.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2
   3 /*
   4  * This file is part of the LibreOffice project.
   5  *
   6  * This Source Code Form is subject to the terms of the Mozilla Public
   7  * License, v. 2.0. If a copy of the MPL was not distributed with this
   8  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   9  *
  10  * This file incorporates work covered by the following license notice:
  11  *
  12  *   Licensed to the Apache Software Foundation (ASF) under one or more
  13  *   contributor license agreements. See the NOTICE file distributed
  14  *   with this work for additional information regarding copyright
  15  *   ownership. The ASF licenses this file to you under the Apache
  16  *   License, Version 2.0 (the "License"); you may not use this file
  17  *   except in compliance with the License. You may obtain a copy of
  18  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  19  */
  20
  21 #pragma once
  22
  23 #include <com/sun/star/document/XEventListener.hpp>
  24 #include <com/sun/star/document/XDocumentEventListener.hpp>
  25
  26 #include <rtl/ref.hxx>
  27
  28 namespace cppu
  29 {
  30     class OWeakObject;
  31 }
  32
  33 namespace dbaccess
  34 {
  35
  36     class DocumentEventNotifier_Impl;
  37     // DocumentEventNotifier
  38     class DocumentEventNotifier
  39     {
  40     public:
  41         DocumentEventNotifier( ::cppu::OWeakObject& _rBroadcasterDocument, ::osl::Mutex& _rMutex );
  42         ~DocumentEventNotifier();
  43
  44         void addLegacyEventListener( const css::uno::Reference< css::document::XEventListener >& Listener );
  45         void removeLegacyEventListener( const css::uno::Reference< css::document::XEventListener >& Listener );
  46         void addDocumentEventListener( const css::uno::Reference< css::document::XDocumentEventListener >& Listener );
  47         void removeDocumentEventListener( const css::uno::Reference< css::document::XDocumentEventListener >& Listener );
  48
  49         /** disposes the instance
  50             @precond
  51                 the mutex is not locked
  52         */
  53         void    disposing();
  54
  55         /** tells the instance that its document is completely initialized now.
  56
  57             Before you call this method, no notification will actually happen
  58
  59             @precond
  60                 the mutex is locked
  61         */
  62         void    onDocumentInitialized();
  63
  64         /** notifies a document event described by the given parameters
  65
  66             @precond
  67                 the mutex is not locked
  68             @precond
  69                 ->onDocumentInitialized has been called
  70         */
  71         void    notifyDocumentEvent(
  72                     const OUString& EventName,
  73                     const css::uno::Reference< css::frame::XController2 >& _rxViewController,
  74                     const css::uno::Any& Supplement
  75                 );
  76
  77         /** notifies a document event, described by the given parameters, asynchronously
  78
  79             Note that no event is actually notified before you called ->onDocumentInitialized.
  80
  81             @precond
  82                 the mutex is locked
  83         */
  84         void    notifyDocumentEventAsync(
  85                     const OUString& EventName,
  86                     const css::uno::Reference< css::frame::XController2 >& ViewController,
  87                     const css::uno::Any& Supplement
  88                 );
  89
  90     private:
  91         ::rtl::Reference< DocumentEventNotifier_Impl >   m_pImpl;
  92     };
  93
  94 } // namespace dbaccess
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */