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