office-gobmx/include/editeng/lrspitem.hxx
Stephan Bergmann 70cc2b191b First batch of adding SAL_OVERRRIDE to overriding function declarations
...mostly done with a rewriting Clang plugin, with just some manual tweaking
necessary to fix poor macro usage.

Change-Id: I71fa20213e86be10de332ece0aa273239df7b61a
2014-03-26 16:39:26 +01:00

182 lines
7.7 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_EDITENG_LRSPITEM_HXX
#define INCLUDED_EDITENG_LRSPITEM_HXX
#include <svl/poolitem.hxx>
#include <editeng/editengdllapi.h>
// class SvxLRSpaceItem --------------------------------------------------
/* [Description]
Left/Right margin and first line indent
SvxLRSpaceItem offers two interfaces for views from the left margin and
first line indent. The get methods return the member, with the layout also
as expected: the left edge shifts to the negative first line indent to the
left. The SetTxt/Gettxt methods assume that the left side represents the
0 coordinate for the first line indent:
UI UI LAYOUT UI/TEXT UI/TEXT (Where?)
SetTxtLeft SetTxtFirst GetLeft GetTxtLeft GetTxtFirst (What?)
500 -500 0 500 -500 (How much?)
500 0 500 500 0
500 +500 500 500 +500
700 -500 200 700 -500
*/
#define LRSPACE_16_VERSION ((sal_uInt16)0x0001)
#define LRSPACE_TXTLEFT_VERSION ((sal_uInt16)0x0002)
#define LRSPACE_AUTOFIRST_VERSION ((sal_uInt16)0x0003)
#define LRSPACE_NEGATIVE_VERSION ((sal_uInt16)0x0004)
class EDITENG_DLLPUBLIC SvxLRSpaceItem : public SfxPoolItem
{
short nFirstLineOfst; // First-line indent _always_ relative to nTxtLeft
long nTxtLeft; // We spend a sal_uInt16
long nLeftMargin; // nLeft or the negative first-line indent
long nRightMargin; // The unproblematic right edge
sal_uInt16 nPropFirstLineOfst, nPropLeftMargin, nPropRightMargin;
bool bAutoFirst : 1; // Automatic calculation of the first line indent
bool bExplicitZeroMarginValRight;
bool bExplicitZeroMarginValLeft;
void AdjustLeft(); // nLeftMargin and nTxtLeft are being adjusted.
public:
TYPEINFO_OVERRIDE();
explicit SvxLRSpaceItem( const sal_uInt16 nId );
SvxLRSpaceItem( const long nLeft, const long nRight,
const long nTLeft /*= 0*/, const short nOfset /*= 0*/,
const sal_uInt16 nId );
inline SvxLRSpaceItem& operator=( const SvxLRSpaceItem &rCpy );
// "pure virtual Methods" from SfxPoolItem
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText, const IntlWrapper * = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const SAL_OVERRIDE;
virtual SvStream& Store(SvStream &, sal_uInt16 nItemVersion ) const SAL_OVERRIDE;
virtual sal_uInt16 GetVersion( sal_uInt16 nFileVersion ) const SAL_OVERRIDE;
virtual bool ScaleMetrics( long nMult, long nDiv ) SAL_OVERRIDE;
virtual bool HasMetrics() const SAL_OVERRIDE;
// Die "Layout-Schnittstelle":
inline void SetLeft ( const long nL, const sal_uInt16 nProp = 100 );
inline void SetRight( const long nR, const sal_uInt16 nProp = 100 );
// Query/direct setting of the absolute values
inline long GetLeft() const { return nLeftMargin; }
inline long GetRight() const { return nRightMargin;}
inline void SetLeftValue( const long nL ) { nTxtLeft = nLeftMargin = nL; }
inline void SetRightValue( const long nR ) { nRightMargin = nR; }
inline bool IsAutoFirst() const { return bAutoFirst; }
inline void SetAutoFirst( const bool bNew ) { bAutoFirst = bNew; }
inline bool IsExplicitZeroMarginValRight() const { return bExplicitZeroMarginValRight; }
inline bool IsExplicitZeroMarginValLeft() const { return bExplicitZeroMarginValLeft; }
inline void SetExplicitZeroMarginValRight( const bool eR ) { bExplicitZeroMarginValRight = eR; }
inline void SetExplicitZeroMarginValLeft( const bool eL ) { bExplicitZeroMarginValLeft = eL; }
// Query/Setting the percentage values
inline void SetPropLeft( const sal_uInt16 nProp = 100 )
{ nPropLeftMargin = nProp; }
inline void SetPropRight( const sal_uInt16 nProp = 100 )
{ nPropRightMargin = nProp;}
inline sal_uInt16 GetPropLeft() const { return nPropLeftMargin; }
inline sal_uInt16 GetPropRight() const { return nPropRightMargin;}
// The UI/text interface:
inline void SetTxtLeft( const long nL, const sal_uInt16 nProp = 100 );
inline long GetTxtLeft() const { return nTxtLeft; }
inline void SetTxtFirstLineOfst( const short nF, const sal_uInt16 nProp = 100 );
inline short GetTxtFirstLineOfst() const { return nFirstLineOfst; }
inline void SetPropTxtFirstLineOfst( const sal_uInt16 nProp = 100 )
{ nPropFirstLineOfst = nProp; }
inline sal_uInt16 GetPropTxtFirstLineOfst() const
{ return nPropFirstLineOfst; }
inline void SetTxtFirstLineOfstValue( const short nValue )
{ nFirstLineOfst = nValue; }
};
inline SvxLRSpaceItem &SvxLRSpaceItem::operator=( const SvxLRSpaceItem &rCpy )
{
nFirstLineOfst = rCpy.nFirstLineOfst;
nTxtLeft = rCpy.nTxtLeft;
nLeftMargin = rCpy.nLeftMargin;
nRightMargin = rCpy.nRightMargin;
nPropFirstLineOfst = rCpy.nPropFirstLineOfst;
nPropLeftMargin = rCpy.nPropLeftMargin;
nPropRightMargin = rCpy.nPropRightMargin;
bAutoFirst = rCpy.bAutoFirst;
bExplicitZeroMarginValRight = rCpy.bExplicitZeroMarginValRight;
bExplicitZeroMarginValLeft = rCpy.bExplicitZeroMarginValLeft;
return *this;
}
inline void SvxLRSpaceItem::SetLeft( const long nL, const sal_uInt16 nProp )
{
nLeftMargin = (nL * nProp) / 100;
nTxtLeft = nLeftMargin;
nPropLeftMargin = nProp;
}
inline void SvxLRSpaceItem::SetRight( const long nR, const sal_uInt16 nProp )
{
if (0 == nR)
{
SetExplicitZeroMarginValRight(true);
}
nRightMargin = (nR * nProp) / 100;
nPropRightMargin = nProp;
}
inline void SvxLRSpaceItem::SetTxtFirstLineOfst( const short nF,
const sal_uInt16 nProp )
{
nFirstLineOfst = short((long(nF) * nProp ) / 100);
nPropFirstLineOfst = nProp;
AdjustLeft();
}
inline void SvxLRSpaceItem::SetTxtLeft( const long nL, const sal_uInt16 nProp )
{
if (0 == nL)
{
SetExplicitZeroMarginValLeft(true);
}
nTxtLeft = (nL * nProp) / 100;
nPropLeftMargin = nProp;
AdjustLeft();
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */