xref: /aoo41x/main/framework/inc/general.h (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef __FRAMEWORK_GENERAL_H_
29*cdf0e10cSrcweir #define __FRAMEWORK_GENERAL_H_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir //=============================================================================
32*cdf0e10cSrcweir // includes
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #include <macros/generic.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir /* Normaly XInterface isnt used here ...
37*cdf0e10cSrcweir    But we need it to be able to define namespace alias css to anything related to ::com::sun::star
38*cdf0e10cSrcweir    :-) */
39*cdf0e10cSrcweir #include <com/sun/star/uno/XInterface.hpp>
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir #include <rtl/ustring.hxx>
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir //=============================================================================
44*cdf0e10cSrcweir // namespace
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir //-----------------------------------------------------------------------------
47*cdf0e10cSrcweir /** will make our code more readable if we can use such short name css instead
48*cdf0e10cSrcweir     of typing ::com::sun::star everytimes.
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir     On the other side we had so many problems with "using namespace" so we dont use
51*cdf0e10cSrcweir     it here any longer.
52*cdf0e10cSrcweir  */
53*cdf0e10cSrcweir namespace css = ::com::sun::star;
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir namespace framework {
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir //-----------------------------------------------------------------------------
58*cdf0e10cSrcweir /** status event mapped from load event of frame loader
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir     @todo think about me
61*cdf0e10cSrcweir           should be moved to another more specific place.
62*cdf0e10cSrcweir  */
63*cdf0e10cSrcweir static const ::rtl::OUString FEATUREDESCRIPTOR_LOADSTATE = DECLARE_ASCII("loadFinishedOrCancelled");
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir //-----------------------------------------------------------------------------
66*cdf0e10cSrcweir /** Those macro is used to make it more clear where a synchronized block will start.
67*cdf0e10cSrcweir     Because normal documentation code wont be recognized by some developers to be real
68*cdf0e10cSrcweir     I need something where they are thinking about.
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     At least this macro will do nothing ... it's empty.
71*cdf0e10cSrcweir     But it should make the code more clear .-))
72*cdf0e10cSrcweir */
73*cdf0e10cSrcweir #define SYNCHRONIZED_START
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir //-----------------------------------------------------------------------------
76*cdf0e10cSrcweir /** Same then SYNCHRONIZED_START ... but instead it mark the end of such code block.
77*cdf0e10cSrcweir */
78*cdf0e10cSrcweir #define SYNCHRONIZED_END
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir } // namespace framework
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir #endif // #ifndef __FRAMEWORK_GENERAL_H_
83