framework/inc/threadhelp/transactionbase.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_FRAMEWORK_INC_THREADHELP_TRANSACTIONBASE_HXX
  21 #define INCLUDED_FRAMEWORK_INC_THREADHELP_TRANSACTIONBASE_HXX
  22
  23 #include <threadhelp/transactionmanager.hxx>
  24
  25 namespace framework{
  26
  27 /*-************************************************************************************************************
  28     @short          make it possible to instanciate a transacion manager as first member!
  29     @descr          If you use a transaction manager as a member of your class and wish to use it earlier then other ones
  30                     you should have a look on this implementation. You must use it as the first base class
  31                     of your implementation - because base classes are initialized by his order and before your
  32                     member! Thats why ist a good place to declare this member.
  33     @devstatus      ready to use
  34 *//*-*************************************************************************************************************/
  35 struct TransactionBase
  36 {
  37
  38     //  public member
  39
  40     public:
  41
  42         mutable TransactionManager    m_aTransactionManager;   /// "your" public manager-member!
  43                                                                    /// Make it mutable for using in const functions!
  44
  45 };      //  struct TransactionBase
  46
  47 }       //  namespace framework
  48
  49 #endif // INCLUDED_FRAMEWORK_INC_THREADHELP_TRANSACTIONBASE_HXX
  50
  51 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */