Version 5.4.3.2, tag libreoffice-5.4.3.2
[LibreOffice.git] / include / svx / framebordertype.hxx
blob2eda996062f1b6dae26e000a5bedd4bbb5b6f201
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef INCLUDED_SVX_FRAMEBORDERTYPE_HXX
21 #define INCLUDED_SVX_FRAMEBORDERTYPE_HXX
23 #include <svx/svxdllapi.h>
25 namespace svx {
28 /** Enumerates all borders a frame selection control can contain. */
29 enum class FrameBorderType
31 NONE, /// No border (special state).
32 Left, /// Left frame border.
33 Right, /// Right frame border.
34 Top, /// Top frame border.
35 Bottom, /// Bottom frame border.
36 Horizontal, /// Inner horizontal frame border.
37 Vertical, /// Inner vertical frame border.
38 TLBR, /// Top-left to bottom-right frame border.
39 BLTR /// Bottom-left to top-right frame border.
42 /** The number of valid frame border types (excluding FrameBorderType::NONE). */
43 const int FRAMEBORDERTYPE_COUNT = 8;
45 /** Returns the frame border type from a 0-based integer index. */
46 SVX_DLLPUBLIC FrameBorderType GetFrameBorderTypeFromIndex( size_t nIndex );
48 /** Returns the zero-based index of a valid frame border type. */
49 size_t GetIndexFromFrameBorderType( FrameBorderType eBorder );
54 #endif
56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */