summaryrefslogtreecommitdiffstats
path: root/include/editeng/lrspitem.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'include/editeng/lrspitem.hxx')
-rw-r--r--include/editeng/lrspitem.hxx160
1 files changed, 160 insertions, 0 deletions
diff --git a/include/editeng/lrspitem.hxx b/include/editeng/lrspitem.hxx
new file mode 100644
index 000000000..4fd809ae6
--- /dev/null
+++ b/include/editeng/lrspitem.hxx
@@ -0,0 +1,160 @@
+/* -*- 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?)
+ SetTextLeft SetTxtFirst GetLeft GetTextLeft 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_TXTLEFT_VERSION (sal_uInt16(0x0002))
+#define LRSPACE_NEGATIVE_VERSION (sal_uInt16(0x0004))
+
+class EDITENG_DLLPUBLIC SvxLRSpaceItem final : public SfxPoolItem
+{
+ long nTxtLeft; // We spend a sal_uInt16
+ long nLeftMargin; // nLeft or the negative first-line indent
+ long nRightMargin; // The unproblematic right edge
+
+ sal_uInt16 nPropFirstLineOffset, nPropLeftMargin, nPropRightMargin;
+ short nFirstLineOffset; // First-line indent _always_ relative to nTxtLeft
+ bool bAutoFirst; // Automatic calculation of the first line indent
+ bool bExplicitZeroMarginValRight;
+ bool bExplicitZeroMarginValLeft;
+
+ void AdjustLeft(); // nLeftMargin and nTxtLeft are being adjusted.
+
+public:
+
+ static SfxPoolItem* CreateDefault();
+
+ 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 );
+ SvxLRSpaceItem(SvxLRSpaceItem const &) = default; // SfxPoolItem copy function dichotomy
+
+ // "pure virtual Methods" from SfxPoolItem
+ virtual bool operator==( const SfxPoolItem& ) const override;
+
+ virtual bool QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
+ virtual bool PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
+
+ virtual bool GetPresentation( SfxItemPresentation ePres,
+ MapUnit eCoreMetric,
+ MapUnit ePresMetric,
+ OUString &rText, const IntlWrapper& ) const override;
+
+ virtual SvxLRSpaceItem* Clone( SfxItemPool *pPool = nullptr ) const override;
+ virtual void ScaleMetrics( long nMult, long nDiv ) override;
+ virtual bool HasMetrics() const override;
+
+ // The "layout interface":
+ 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
+ long GetLeft() const { return nLeftMargin; }
+ long GetRight() const { return nRightMargin;}
+ void SetLeftValue( const long nL ) { nTxtLeft = nLeftMargin = nL; }
+ void SetRightValue( const long nR ) { nRightMargin = nR; }
+ bool IsAutoFirst() const { return bAutoFirst; }
+ void SetAutoFirst( const bool bNew ) { bAutoFirst = bNew; }
+
+ bool IsExplicitZeroMarginValRight() const { return bExplicitZeroMarginValRight; }
+ bool IsExplicitZeroMarginValLeft() const { return bExplicitZeroMarginValLeft; }
+ void SetExplicitZeroMarginValRight( const bool eR ) { bExplicitZeroMarginValRight = eR; }
+ void SetExplicitZeroMarginValLeft( const bool eL ) { bExplicitZeroMarginValLeft = eL; }
+ sal_uInt16 GetPropLeft() const { return nPropLeftMargin; }
+ sal_uInt16 GetPropRight() const { return nPropRightMargin;}
+
+ // The UI/text interface:
+ inline void SetTextLeft( const long nL, const sal_uInt16 nProp = 100 );
+ long GetTextLeft() const { return nTxtLeft; }
+
+ inline void SetTextFirstLineOffset( const short nF, const sal_uInt16 nProp = 100 );
+ short GetTextFirstLineOffset() const { return nFirstLineOffset; }
+ void SetPropTextFirstLineOffset( const sal_uInt16 nProp )
+ { nPropFirstLineOffset = nProp; }
+ sal_uInt16 GetPropTextFirstLineOffset() const
+ { return nPropFirstLineOffset; }
+ void SetTextFirstLineOffsetValue( const short nValue )
+ { nFirstLineOffset = nValue; }
+
+ void dumpAsXml(xmlTextWriterPtr pWriter) const override;
+ virtual boost::property_tree::ptree dumpAsJSON() const override;
+};
+
+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::SetTextFirstLineOffset( const short nF,
+ const sal_uInt16 nProp )
+{
+ nFirstLineOffset = short((long(nF) * nProp ) / 100);
+ nPropFirstLineOffset = nProp;
+ AdjustLeft();
+}
+
+inline void SvxLRSpaceItem::SetTextLeft( 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: */