xref: /aoo4110/main/svx/inc/svx/framebordertype.hxx (revision b1cdbd2c)
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 SVX_FRAMEBORDERTYPE_HXX
25 #define SVX_FRAMEBORDERTYPE_HXX
26 
27 #include "svx/svxdllapi.h"
28 
29 namespace svx {
30 
31 // ============================================================================
32 
33 /** Enumerates all borders a frame selection control can contain. */
34 enum FrameBorderType
35 {
36     FRAMEBORDER_NONE,       /// No border (special state).
37     FRAMEBORDER_LEFT,       /// Left frame border.
38     FRAMEBORDER_RIGHT,      /// Right frame border.
39     FRAMEBORDER_TOP,        /// Top frame border.
40     FRAMEBORDER_BOTTOM,     /// Bottom frame border.
41     FRAMEBORDER_HOR,        /// Inner horizontal frame border.
42     FRAMEBORDER_VER,        /// Inner vertical frame border.
43     FRAMEBORDER_TLBR,       /// Top-left to bottom-right frame border.
44     FRAMEBORDER_BLTR        /// Bottom-left to top-right frame border.
45 };
46 
47 /** The number of valid frame border types (excluding FRAMEBORDER_NONE). */
48 const int FRAMEBORDERTYPE_COUNT = 8;
49 
50 /** Returns the frame border type from a 0-based integer index. */
51 SVX_DLLPUBLIC FrameBorderType GetFrameBorderTypeFromIndex( size_t nIndex );
52 
53 /** Returns the zero-based index of a valid frame border type. */
54 size_t GetIndexFromFrameBorderType( FrameBorderType eBorder );
55 
56 // ============================================================================
57 
58 } // namespace svx
59 
60 #endif
61 
62