include/unotools/closeveto.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_UNOTOOLS_CLOSEVETO_HXX
  21 #define INCLUDED_UNOTOOLS_CLOSEVETO_HXX
  22
  23 #include <unotools/unotoolsdllapi.h>
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <memory>
  26
  27 namespace com::sun::star::uno { class XInterface; }
  28
  29 namespace utl
  30 {
  31
  32     //= CloseVeto
  33     struct CloseVeto_Data;
  34     /** will add a XCloseListener to a given component, and veto its closing as long as the <code>CloseVeto</code>
  35         instance is alive.
  36
  37         If closing has been requested and vetoed while the <code>CloseVeto</code> instance is alive, and the ownership
  38         went to the <code>CloseVeto</code> instance, then it will close the component in its dtor.
  39     */
  40     class UNOTOOLS_DLLPUBLIC CloseVeto
  41     {
  42     public:
  43         CloseVeto( const css::uno::Reference< css::uno::XInterface >& i_closeable,
  44                 bool bHasOwnership = false);
  45         ~CloseVeto();
  46
  47     private:
  48         std::unique_ptr< CloseVeto_Data >   m_xData;
  49     };
  50
  51 } // namespace dbaui
  52
  53 #endif // INCLUDED_UNOTOOLS_CLOSEVETO_HXX
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */