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