Branch libreoffice-5-0-4
[LibreOffice.git] / include / editeng / ulspitem.hxx
blob3fd40f0dca03bc3050329dc8b9080dcd2266744d
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 .
19 #ifndef INCLUDED_EDITENG_ULSPITEM_HXX
20 #define INCLUDED_EDITENG_ULSPITEM_HXX
22 #include <svl/poolitem.hxx>
23 #include <editeng/editengdllapi.h>
26 // class SvxULSpaceItem --------------------------------------------------
28 /* [Description]
30 This item describes the Upper- and Lower space of a page or paragraph.
33 #define ULSPACE_16_VERSION ((sal_uInt16)0x0001)
35 class EDITENG_DLLPUBLIC SvxULSpaceItem : public SfxPoolItem
37 sal_uInt16 nUpper; // Upper space
38 sal_uInt16 nLower; // Lower space
39 bool bContext; // Contextual spacing?
40 sal_uInt16 nPropUpper, nPropLower; // relative or absolute (=100%)
41 public:
42 TYPEINFO_OVERRIDE();
44 explicit SvxULSpaceItem( const sal_uInt16 nId );
45 SvxULSpaceItem( const sal_uInt16 nUp, const sal_uInt16 nLow,
46 const sal_uInt16 nId );
47 inline SvxULSpaceItem& operator=( const SvxULSpaceItem &rCpy );
49 // "pure virtual Methods" from SfxPoolItem
50 virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
52 virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
53 virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
55 virtual bool GetPresentation( SfxItemPresentation ePres,
56 SfxMapUnit eCoreMetric,
57 SfxMapUnit ePresMetric,
58 OUString &rText, const IntlWrapper * = 0 ) const SAL_OVERRIDE;
60 virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
61 virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const SAL_OVERRIDE;
62 virtual SvStream& Store(SvStream &, sal_uInt16 nItemVersion ) const SAL_OVERRIDE;
63 virtual sal_uInt16 GetVersion( sal_uInt16 nFileVersion ) const SAL_OVERRIDE;
64 virtual bool ScaleMetrics( long nMult, long nDiv ) SAL_OVERRIDE;
65 virtual bool HasMetrics() const SAL_OVERRIDE;
67 inline void SetUpper( const sal_uInt16 nU, const sal_uInt16 nProp = 100 );
68 inline void SetLower( const sal_uInt16 nL, const sal_uInt16 nProp = 100 );
70 void SetUpperValue( const sal_uInt16 nU ) { nUpper = nU; }
71 void SetLowerValue( const sal_uInt16 nL ) { nLower = nL; }
72 void SetContextValue( const bool bC ) { bContext = bC; }
73 void SetPropUpper( const sal_uInt16 nU ) { nPropUpper = nU; }
74 void SetPropLower( const sal_uInt16 nL ) { nPropLower = nL; }
76 sal_uInt16 GetUpper() const { return nUpper; }
77 sal_uInt16 GetLower() const { return nLower; }
78 bool GetContext() const { return bContext; }
79 sal_uInt16 GetPropUpper() const { return nPropUpper; }
80 sal_uInt16 GetPropLower() const { return nPropLower; }
81 void dumpAsXml(struct _xmlTextWriter* pWriter) const SAL_OVERRIDE;
84 inline SvxULSpaceItem &SvxULSpaceItem::operator=( const SvxULSpaceItem &rCpy )
86 nUpper = rCpy.GetUpper();
87 nLower = rCpy.GetLower();
88 bContext = rCpy.GetContext();
89 nPropUpper = rCpy.GetPropUpper();
90 nPropLower = rCpy.GetPropLower();
91 return *this;
94 inline void SvxULSpaceItem::SetUpper( const sal_uInt16 nU, const sal_uInt16 nProp )
96 nUpper = sal_uInt16((sal_uInt32(nU) * nProp ) / 100); nPropUpper = nProp;
98 inline void SvxULSpaceItem::SetLower( const sal_uInt16 nL, const sal_uInt16 nProp )
100 nLower = sal_uInt16((sal_uInt32(nL) * nProp ) / 100); nPropLower = nProp;
103 #endif
105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */