xref: /aoo42x/main/framework/inc/general.h (revision 7a164331)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef __FRAMEWORK_GENERAL_H_
25 #define __FRAMEWORK_GENERAL_H_
26 
27 //=============================================================================
28 // includes
29 
30 #include <macros/generic.hxx>
31 
32 /* Normally XInterface isn't used here ...
33    But we need it to be able to define namespace alias css to anything related to ::com::sun::star
34    :-) */
35 #include <com/sun/star/uno/XInterface.hpp>
36 
37 #include <rtl/ustring.hxx>
38 
39 //=============================================================================
40 // namespace
41 
42 //-----------------------------------------------------------------------------
43 /** will make our code more readable if we can use such short name css instead
44     of typing ::com::sun::star everytimes.
45 
46     On the other side we had so many problems with "using namespace" so we don't use
47     it here any longer.
48  */
49 namespace css = ::com::sun::star;
50 
51 namespace framework {
52 
53 //-----------------------------------------------------------------------------
54 /** status event mapped from load event of frame loader
55 
56     @todo think about me
57           should be moved to another more specific place.
58  */
59 static const ::rtl::OUString FEATUREDESCRIPTOR_LOADSTATE = DECLARE_ASCII("loadFinishedOrCancelled");
60 
61 //-----------------------------------------------------------------------------
62 /** This macro is used to make it more clear where a synchronized block will start.
63     Because normal documentation code won't be recognized by some developers to be real
64     I need something where they are thinking about.
65 
66     At least this macro will do nothing ... it's empty.
67     But it should make the code more clear .-))
68 */
69 #define SYNCHRONIZED_START
70 
71 //-----------------------------------------------------------------------------
72 /** Same then SYNCHRONIZED_START ... but instead it mark the end of such code block.
73 */
74 #define SYNCHRONIZED_END
75 
76 } // namespace framework
77 
78 #endif // #ifndef __FRAMEWORK_GENERAL_H_
79