Allow print-twips version of ScDocument::GetNeededSize()...

via an optional boolean argument bInPrintTwips which is false by default.

This is needed for edit-area calculation in print twips which will
aid in the generation of edit-cursor/edit-selection messages in print
twips for LOK clients.

Change-Id: Ibb15411278b9196d956ac952444d6e31c62dccda
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/98117
Tested-by: Jenkins
Reviewed-by: Dennis Francis <dennis.francis@collabora.com>

6 files changed, 76 insertions, 41 deletions

diff --git a/sc/inc/column.hxx b/sc/inc/column.hxx
index 0eb2ad5f1c85..f5417eec3623 100644
--- a/sc/inc/column.hxx
+++ b/sc/inc/column.hxx
@@ -519,7 +519,8 @@ public:
     long GetNeededSize(
         SCROW nRow, OutputDevice* pDev, double nPPTX, double nPPTY,
         const Fraction& rZoomX, const Fraction& rZoomY,
-        bool bWidth, const ScNeededSizeOptions& rOptions, const ScPatternAttr** pPatternChange ) const;
+        bool bWidth, const ScNeededSizeOptions& rOptions, const ScPatternAttr** pPatternChange,
+        bool bInPrintTwips = false ) const;
 
     sal_uInt16 GetOptimalColWidth(
         OutputDevice* pDev, double nPPTX, double nPPTY,
diff --git a/sc/inc/document.hxx b/sc/inc/document.hxx
index 619bcbce8d38..5a487a0d94a9 100644
--- a/sc/inc/document.hxx
+++ b/sc/inc/document.hxx
@@ -1920,7 +1920,8 @@ public:
                                                OutputDevice* pDev,
                                                double nPPTX, double nPPTY,
                                                const Fraction& rZoomX, const Fraction& rZoomY,
-                                               bool bWidth, bool bTotalSize = false );
+                                               bool bWidth, bool bTotalSize = false,
+                                               bool bInPrintTwips = false );
 
     SC_DLLPUBLIC void           ShowCol(SCCOL nCol, SCTAB nTab, bool bShow);
     SC_DLLPUBLIC void           ShowRow(SCROW nRow, SCTAB nTab, bool bShow);
diff --git a/sc/inc/table.hxx b/sc/inc/table.hxx
index 5ffd70c77541..f5e998118f13 100644
--- a/sc/inc/table.hxx
+++ b/sc/inc/table.hxx
@@ -788,7 +788,8 @@ public:
                                     OutputDevice* pDev,
                                     double nPPTX, double nPPTY,
                                     const Fraction& rZoomX, const Fraction& rZoomY,
-                                    bool bWidth, bool bTotalSize );
+                                    bool bWidth, bool bTotalSize,
+                                    bool bInPrintTwips = false);
     void        SetColWidth( SCCOL nCol, sal_uInt16 nNewWidth );
     void        SetColWidthOnly( SCCOL nCol, sal_uInt16 nNewWidth );
     void        SetRowHeight( SCROW nRow, sal_uInt16 nNewHeight );
diff --git a/sc/source/core/data/column2.cxx b/sc/source/core/data/column2.cxx
index 9a45e48899f6..9cf2be715011 100644
--- a/sc/source/core/data/column2.cxx
+++ b/sc/source/core/data/column2.cxx
@@ -83,8 +83,15 @@ long ScColumn::GetNeededSize(
     SCROW nRow, OutputDevice* pDev, double nPPTX, double nPPTY,
     const Fraction& rZoomX, const Fraction& rZoomY,
     bool bWidth, const ScNeededSizeOptions& rOptions,
-    const ScPatternAttr** ppPatternChange ) const
+    const ScPatternAttr** ppPatternChange, bool bInPrintTwips ) const
 {
+    // If bInPrintTwips is set, the size calculated should be in print twips,
+    // else it should be in pixels.
+
+    // Switch unit to MapTwip instead ? (temporarily and then revert before exit).
+    if (bInPrintTwips)
+        assert(pDev->GetMapMode().GetMapUnit() == MapUnit::MapTwip);
+
     std::pair<sc::CellStoreType::const_iterator,size_t> aPos = maCells.position(nRow);
     sc::CellStoreType::const_iterator it = aPos.first;
     if (it == maCells.end() || it->type == sc::element_type_empty)
@@ -95,6 +102,10 @@ long ScColumn::GetNeededSize(
     ScRefCellValue aCell = GetCellValue(it, aPos.second);
     double nPPT = bWidth ? nPPTX : nPPTY;
 
+    auto conditionalScaleFunc = [bInPrintTwips](long nMeasure, double fScale) {
+        return bInPrintTwips ? nMeasure : static_cast<long>(nMeasure * fScale);
+    };
+
     const ScPatternAttr* pPattern = rOptions.pPattern;
     if (!pPattern)
         pPattern = pAttrArray->GetPattern( nRow );
@@ -300,13 +311,13 @@ long ScColumn::GetNeededSize(
                     nWidth  = static_cast<long>( aSize.Width() * nCosAbs + aSize.Height() * nSinAbs );
                 else if ( rOptions.bTotalSize )
                 {
-                    nWidth = static_cast<long>( pDocument->GetColWidth( nCol,nTab ) * nPPT );
+                    nWidth = conditionalScaleFunc(pDocument->GetColWidth( nCol,nTab ), nPPT);
                     bAddMargin = false;
                     //  only to the right:
                     //TODO: differ on direction up/down (only Text/whole height)
                     if ( pPattern->GetRotateDir( pCondSet ) == ScRotateDir::Right )
                         nWidth += static_cast<long>( pDocument->GetRowHeight( nRow,nTab ) *
-                                            nPPT * nCosAbs / nSinAbs );
+                                            (bInPrintTwips ? 1.0 : nPPT) * nCosAbs / nSinAbs );
                 }
                 else
                     nWidth  = static_cast<long>( aSize.Height() / nSinAbs );   //TODO: limit?
@@ -327,14 +338,14 @@ long ScColumn::GetNeededSize(
             {
                 if (bWidth)
                 {
-                    nValue += static_cast<long>( pMargin->GetLeftMargin() * nPPT ) +
-                              static_cast<long>( pMargin->GetRightMargin() * nPPT );
+                    nValue += conditionalScaleFunc(pMargin->GetLeftMargin(), nPPT) +
+                              conditionalScaleFunc(pMargin->GetRightMargin(), nPPT);
                     if ( nIndent )
-                        nValue += static_cast<long>( nIndent * nPPT );
+                        nValue += conditionalScaleFunc(nIndent, nPPT);
                 }
                 else
-                    nValue += static_cast<long>( pMargin->GetTopMargin() * nPPT ) +
-                              static_cast<long>( pMargin->GetBottomMargin() * nPPT );
+                    nValue += conditionalScaleFunc(pMargin->GetTopMargin(), nPPT) +
+                              conditionalScaleFunc(pMargin->GetBottomMargin(), nPPT);
             }
 
             //  linebreak done ?
@@ -344,12 +355,11 @@ long ScColumn::GetNeededSize(
                 //  test with EditEngine the safety at 90%
                 //  (due to rounding errors and because EditEngine formats partially differently)
 
-                long nDocPixel = static_cast<long>( ( pDocument->GetColWidth( nCol,nTab ) -
+                long nDocSize = conditionalScaleFunc((pDocument->GetColWidth( nCol,nTab ) -
                                     pMargin->GetLeftMargin() - pMargin->GetRightMargin() -
-                                    nIndent )
-                                    * nPPTX );
-                nDocPixel = (nDocPixel * 9) / 10;           // for safety
-                if ( aSize.Width() > nDocPixel )
+                                    nIndent), nPPTX);
+                nDocSize = (nDocSize * 9) / 10;           // for safety
+                if ( aSize.Width() > nDocSize )
                     bEditEngine = true;
             }
         }
@@ -361,6 +371,7 @@ long ScColumn::GetNeededSize(
         vcl::Font aOldFont = pDev->GetFont();
 
         MapMode aHMMMode( MapUnit::Map100thMM, Point(), rZoomX, rZoomY );
+        MapMode aTwipMode(MapUnit::MapTwip, Point(), rZoomX, rZoomY);
 
         // save in document ?
         std::unique_ptr<ScFieldEditEngine> pEngine = pDocument->CreateFieldEditEngine();
@@ -403,7 +414,7 @@ long ScColumn::GetNeededSize(
             aPaper.setWidth( 1 );
         else if (bBreak)
         {
-            double fWidthFactor = nPPTX;
+            double fWidthFactor = bInPrintTwips ? 1.0 : nPPTX;
             if ( bTextWysiwyg )
             {
                 //  if text is formatted for printer, don't use PixelToLogic,
@@ -426,13 +437,19 @@ long ScColumn::GetNeededSize(
                 nDocWidth -= static_cast<long>( nIndent * fWidthFactor );
 
             // space for AutoFilter button:  20 * nZoom/100
+            constexpr long nFilterButtonWidthPix = 20; // Autofilter pixel width at 100% zoom.
             if ( pFlag->HasAutoFilter() && !bTextWysiwyg )
-                nDocWidth -= long(rZoomX*20);
+                nDocWidth -= bInPrintTwips ?
+                        (nFilterButtonWidthPix * TWIPS_PER_PIXEL) : long(rZoomX * nFilterButtonWidthPix);
 
             aPaper.setWidth( nDocWidth );
 
             if ( !bTextWysiwyg )
-                aPaper = pDev->PixelToLogic( aPaper, aHMMMode );
+            {
+                aPaper = bInPrintTwips ?
+                        OutputDevice::LogicToLogic(aPaper, aTwipMode, aHMMMode) :
+                        pDev->PixelToLogic(aPaper, aHMMMode);
+            }
         }
         pEngine->SetPaperSize(aPaper);
 
@@ -475,22 +492,25 @@ long ScColumn::GetNeededSize(
                 nWidth  = static_cast<long>( aSize.Width() * nCosAbs + aSize.Height() * nSinAbs );
             else if ( rOptions.bTotalSize )
             {
-                nWidth = static_cast<long>( pDocument->GetColWidth( nCol,nTab ) * nPPT );
+                nWidth = conditionalScaleFunc(pDocument->GetColWidth( nCol,nTab ), nPPT);
                 bAddMargin = false;
                 if ( pPattern->GetRotateDir( pCondSet ) == ScRotateDir::Right )
                     nWidth += static_cast<long>( pDocument->GetRowHeight( nRow,nTab ) *
-                                        nPPT * nCosAbs / nSinAbs );
+                                        (bInPrintTwips ? 1.0 : nPPT) * nCosAbs / nSinAbs );
             }
             else
                 nWidth  = static_cast<long>( aSize.Height() / nSinAbs );   //TODO: limit?
             aSize = Size( nWidth, nHeight );
 
-            Size aPixSize = pDev->LogicToPixel( aSize, aHMMMode );
+            Size aTextSize = bInPrintTwips ?
+                    OutputDevice::LogicToLogic(aSize, aHMMMode, aTwipMode) :
+                    pDev->LogicToPixel(aSize, aHMMMode);
+
             if ( bEdWidth )
-                nValue = aPixSize.Width();
+                nValue = aTextSize.Width();
             else
             {
-                nValue = aPixSize.Height();
+                nValue = aTextSize.Height();
 
                 if ( bBreak && !rOptions.bTotalSize )
                 {
@@ -506,13 +526,19 @@ long ScColumn::GetNeededSize(
             if (bBreak)
                 nValue = 0;
             else
-                nValue = pDev->LogicToPixel(Size( pEngine->CalcTextWidth(), 0 ),
-                                    aHMMMode).Width();
+            {
+                Size aTextSize(pEngine->CalcTextWidth(), 0);
+                nValue = bInPrintTwips ?
+                        OutputDevice::LogicToLogic(aTextSize, aHMMMode, aTwipMode).Width() :
+                        pDev->LogicToPixel(aTextSize, aHMMMode).Width();
+            }
         }
         else            // height
         {
-            nValue = pDev->LogicToPixel(Size( 0, pEngine->GetTextHeight() ),
-                                aHMMMode).Height();
+            Size aTextSize(0, pEngine->GetTextHeight());
+            nValue = bInPrintTwips ?
+                    OutputDevice::LogicToLogic(aTextSize, aHMMMode, aTwipMode).Height() :
+                    pDev->LogicToPixel(aTextSize, aHMMMode).Height();
 
             // With non-100% zoom and several lines or paragraphs, don't shrink below the result with FORMAT100 set
             if ( !bTextWysiwyg && ( rZoomY.GetNumerator() != 1 || rZoomY.GetDenominator() != 1 ) &&
@@ -520,7 +546,10 @@ long ScColumn::GetNeededSize(
             {
                 pEngine->SetControlWord( nCtrl | EEControlBits::FORMAT100 );
                 pEngine->QuickFormatDoc( true );
-                long nSecondValue = pDev->LogicToPixel(Size( 0, pEngine->GetTextHeight() ), aHMMMode).Height();
+                aTextSize = Size(0, pEngine->GetTextHeight());
+                long nSecondValue = bInPrintTwips ?
+                        OutputDevice::LogicToLogic(aTextSize, aHMMMode, aTwipMode).Height() :
+                        pDev->LogicToPixel(aTextSize, aHMMMode).Height();
                 if ( nSecondValue > nValue )
                     nValue = nSecondValue;
             }
@@ -530,20 +559,21 @@ long ScColumn::GetNeededSize(
         {
             if (bWidth)
             {
-                nValue += static_cast<long>( pMargin->GetLeftMargin() * nPPT ) +
-                          static_cast<long>( pMargin->GetRightMargin() * nPPT );
+                nValue += conditionalScaleFunc(pMargin->GetLeftMargin(), nPPT) +
+                          conditionalScaleFunc(pMargin->GetRightMargin(), nPPT);
                 if (nIndent)
-                    nValue += static_cast<long>( nIndent * nPPT );
+                    nValue += conditionalScaleFunc(nIndent, nPPT);
             }
             else
             {
-                nValue += static_cast<long>( pMargin->GetTopMargin() * nPPT ) +
-                          static_cast<long>( pMargin->GetBottomMargin() * nPPT );
+                nValue += conditionalScaleFunc(pMargin->GetTopMargin(), nPPT) +
+                          conditionalScaleFunc(pMargin->GetBottomMargin(), nPPT);
 
                 if ( bAsianVertical && pDev->GetOutDevType() != OUTDEV_PRINTER )
                 {
                     //  add 1pt extra (default margin value) for line breaks with SetVertical
-                    nValue += static_cast<long>( 20 * nPPT );
+                    constexpr long nDefaultMarginInPoints = 1;
+                    nValue += conditionalScaleFunc(nDefaultMarginInPoints * TWIPS_PER_POINT, nPPT);
                 }
             }
         }
@@ -562,11 +592,13 @@ long ScColumn::GetNeededSize(
         //      place for Autofilter Button
         //      20 * nZoom/100
         //      Conditional formatting is not interesting here
-
+        constexpr long nFilterButtonWidthPix = 20; // Autofilter pixel width at 100% zoom.
         ScMF nFlags = pPattern->GetItem(ATTR_MERGE_FLAG).GetValue();
         if (nFlags & ScMF::Auto)
-            nValue += long(rZoomX*20);
+            nValue += bInPrintTwips ?
+                (nFilterButtonWidthPix * TWIPS_PER_PIXEL) : long(rZoomX * nFilterButtonWidthPix);
     }
+
     return nValue;
 }
 
diff --git a/sc/source/core/data/document.cxx b/sc/source/core/data/document.cxx
index fb8c040ba5c3..8f6eff2cc7d6 100644
--- a/sc/source/core/data/document.cxx
+++ b/sc/source/core/data/document.cxx
@@ -4256,11 +4256,11 @@ long ScDocument::GetNeededSize( SCCOL nCol, SCROW nRow, SCTAB nTab,
                                     OutputDevice* pDev,
                                     double nPPTX, double nPPTY,
                                     const Fraction& rZoomX, const Fraction& rZoomY,
-                                    bool bWidth, bool bTotalSize )
+                                    bool bWidth, bool bTotalSize, bool bInPrintTwips )
 {
     if ( ValidTab(nTab) && nTab < static_cast<SCTAB>(maTabs.size()) && maTabs[nTab] )
         return maTabs[nTab]->GetNeededSize
-                ( nCol, nRow, pDev, nPPTX, nPPTY, rZoomX, rZoomY, bWidth, bTotalSize );
+                ( nCol, nRow, pDev, nPPTX, nPPTY, rZoomX, rZoomY, bWidth, bTotalSize, bInPrintTwips );
     OSL_FAIL("wrong table number");
     return 0;
 }
diff --git a/sc/source/core/data/table1.cxx b/sc/source/core/data/table1.cxx
index 078e4dffb074..25d7a3f68bd0 100644
--- a/sc/source/core/data/table1.cxx
+++ b/sc/source/core/data/table1.cxx
@@ -433,7 +433,7 @@ long ScTable::GetNeededSize( SCCOL nCol, SCROW nRow,
                                 OutputDevice* pDev,
                                 double nPPTX, double nPPTY,
                                 const Fraction& rZoomX, const Fraction& rZoomY,
-                                bool bWidth, bool bTotalSize )
+                                bool bWidth, bool bTotalSize, bool bInPrintTwips )
 {
     if ( nCol >= aCol.size() )
         return 0;
@@ -443,7 +443,7 @@ long ScTable::GetNeededSize( SCCOL nCol, SCROW nRow,
     aOptions.bTotalSize  = bTotalSize;
 
     return aCol[nCol].GetNeededSize
-        ( nRow, pDev, nPPTX, nPPTY, rZoomX, rZoomY, bWidth, aOptions, nullptr );
+        ( nRow, pDev, nPPTX, nPPTY, rZoomX, rZoomY, bWidth, aOptions, nullptr, bInPrintTwips );
 }
 
 bool ScTable::SetOptimalHeight(