framework/inc/general.h

   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: general.h,v $
  10  * $Revision: 1.8 $
  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_GENERAL_H_
  32 #define __FRAMEWORK_GENERAL_H_
  33
  34 //=============================================================================
  35 // includes
  36
  37 #include <macros/generic.hxx>
  38
  39 /* Normaly XInterface isnt used here ...
  40    But we need it to be able to define namespace alias css to anything related to ::com::sun::star
  41    :-) */
  42 #include <com/sun/star/uno/XInterface.hpp>
  43
  44 #include <rtl/ustring.hxx>
  45
  46 //=============================================================================
  47 // namespace
  48
  49 //-----------------------------------------------------------------------------
  50 /** will make our code more readable if we can use such short name css instead
  51     of typing ::com::sun::star everytimes.
  52
  53     On the other side we had so many problems with "using namespace" so we dont use
  54     it here any longer.
  55  */
  56 namespace css = ::com::sun::star;
  57
  58 namespace framework {
  59
  60 //-----------------------------------------------------------------------------
  61 /** status event mapped from load event of frame loader
  62
  63     @todo think about me
  64           should be moved to another more specific place.
  65  */
  66 static const ::rtl::OUString FEATUREDESCRIPTOR_LOADSTATE = DECLARE_ASCII("loadFinishedOrCancelled");
  67
  68 //-----------------------------------------------------------------------------
  69 /** Those macro is used to make it more clear where a synchronized block will start.
  70     Because normal documentation code wont be recognized by some developers to be real
  71     I need something where they are thinking about.
  72
  73     At least this macro will do nothing ... it's empty.
  74     But it should make the code more clear .-))
  75 */
  76 #define SYNCHRONIZED_START
  77
  78 //-----------------------------------------------------------------------------
  79 /** Same then SYNCHRONIZED_START ... but instead it mark the end of such code block.
  80 */
  81 #define SYNCHRONIZED_END
  82
  83 } // namespace framework
  84
  85 #endif // #ifndef __FRAMEWORK_GENERAL_H_