framework/inc/threadhelp/transactionbase.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: transactionbase.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_THREADHELP_TRANSACTIONBASE_H_
  32 #define __FRAMEWORK_THREADHELP_TRANSACTIONBASE_H_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <threadhelp/transactionmanager.hxx>
  39
  40 //_________________________________________________________________________________________________________________
  41 //      interface includes
  42 //_________________________________________________________________________________________________________________
  43
  44 //_________________________________________________________________________________________________________________
  45 //      other includes
  46 //_________________________________________________________________________________________________________________
  47
  48 //_________________________________________________________________________________________________________________
  49 //      namespace
  50 //_________________________________________________________________________________________________________________
  51
  52 namespace framework{
  53
  54 //_________________________________________________________________________________________________________________
  55 //      const
  56 //_________________________________________________________________________________________________________________
  57
  58 //_________________________________________________________________________________________________________________
  59 //      declarations
  60 //_________________________________________________________________________________________________________________
  61
  62 /*-************************************************************************************************************//**
  63     @short          make it possible to instanciate a transacion manager as first member!
  64     @descr          If you use a transaction manager as a member of your class and whish to use it earlier then other ones
  65                     you should have a look on this implementation. You must use it as the first base class
  66                     of your implementation - because base classes are initialized by his order and before your
  67                     member! Thats why ist a good place to declare this member.
  68
  69     @implements         -
  70     @base                       -
  71
  72     @devstatus          ready to use
  73 *//*-*************************************************************************************************************/
  74 struct TransactionBase
  75 {
  76     //-------------------------------------------------------------------------------------------------------------
  77     //  public member
  78     //-------------------------------------------------------------------------------------------------------------
  79     public:
  80
  81         mutable TransactionManager    m_aTransactionManager    ;   /// "your" public manager-member!
  82                                                                    /// Make it mutable for using in const functions!
  83
  84 };      //  struct TransactionBase
  85
  86 }               //      namespace framework
  87
  88 #endif  //  #ifndef __FRAMEWORK_THREADHELP_TRANSACTIONBASE_H_