desktop/source/app/omutexmember.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: omutexmember.hxx,v $
  10  * $Revision: 1.3 $
  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_OMUTEXMEMBER_HXX_
  32 #define __FRAMEWORK_OMUTEXMEMBER_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <osl/mutex.hxx>
  39
  40 //_________________________________________________________________________________________________________________
  41 //      namespace
  42 //_________________________________________________________________________________________________________________
  43
  44 //_________________________________________________________________________________________________________________
  45 //      definitions
  46 //_________________________________________________________________________________________________________________
  47
  48 /*-************************************************************************************************************//**
  49     @short                      definition of a public mutex member
  50     @descr                      You can use this struct as baseclass to get a public mutex member for right initialization.
  51                     Don't use it as member. You can't guarantee the right order of initialization of baseclasses then!
  52                     And some other helper classes share the mutex with an implementation and must have a valid one.
  53
  54     @seealso            See implementation of constructors in derived classes for further informations!
  55
  56     @devstatus          ready
  57 *//*-*************************************************************************************************************/
  58
  59 struct OMutexMember
  60 {
  61     ::osl::Mutex        m_aMutex;
  62 };
  63
  64 #endif  //      #ifndef __FRAMEWORK_OMUTEXMEMBER_HXX_