sc/source/filter/excel/xipage.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #include <xipage.hxx>
  21 #include <svl/itemset.hxx>
  22 #include <vcl/graph.hxx>
  23 #include <scitems.hxx>
  24 #include <svl/eitem.hxx>
  25 #include <svl/intitem.hxx>
  26 #include <svx/pageitem.hxx>
  27 #include <editeng/sizeitem.hxx>
  28 #include <editeng/lrspitem.hxx>
  29 #include <editeng/ulspitem.hxx>
  30 #include <editeng/brushitem.hxx>
  31 #include <comphelper/configuration.hxx>
  32 #include <document.hxx>
  33 #include <stlsheet.hxx>
  34 #include <attrib.hxx>
  35 #include <xistream.hxx>
  36 #include <xihelper.hxx>
  37 #include <xiescher.hxx>
  38
  39 // Page settings ==============================================================
  40
  41 XclImpPageSettings::XclImpPageSettings( const XclImpRoot& rRoot ) :
  42     XclImpRoot( rRoot )
  43 {
  44     Initialize();
  45 }
  46
  47 void XclImpPageSettings::Initialize()
  48 {
  49     maData.SetDefaults();
  50     mbValidPaper = false;
  51 }
  52
  53 void XclImpPageSettings::ReadSetup( XclImpStream& rStrm )
  54 {
  55     OSL_ENSURE_BIFF( GetBiff() >= EXC_BIFF4 );
  56     if( GetBiff() < EXC_BIFF4 )
  57         return;
  58
  59     // BIFF4 - BIFF8
  60     sal_uInt16 nFlags;
  61     maData.mnPaperSize = rStrm.ReaduInt16();
  62     maData.mnScaling = rStrm.ReaduInt16();
  63     maData.mnStartPage = rStrm.ReaduInt16();
  64     maData.mnFitToWidth = rStrm.ReaduInt16();
  65     maData.mnFitToHeight = rStrm.ReaduInt16();
  66     nFlags = rStrm.ReaduInt16();
  67
  68     mbValidPaper = maData.mbValid = !::get_flag( nFlags, EXC_SETUP_INVALID );
  69     maData.mbPrintInRows = ::get_flag( nFlags, EXC_SETUP_INROWS );
  70     maData.mbPortrait = ::get_flag( nFlags, EXC_SETUP_PORTRAIT );
  71     maData.mbBlackWhite = ::get_flag( nFlags, EXC_SETUP_BLACKWHITE );
  72     maData.mbManualStart = true;
  73
  74     // new in BIFF5 - BIFF8
  75     if( GetBiff() >= EXC_BIFF5 )
  76     {
  77         maData.mnHorPrintRes = rStrm.ReaduInt16();
  78         maData.mnVerPrintRes = rStrm.ReaduInt16();
  79         maData.mfHeaderMargin = rStrm.ReadDouble();
  80         maData.mfFooterMargin = rStrm.ReadDouble();
  81         maData.mnCopies = rStrm.ReaduInt16();
  82
  83         maData.mbDraftQuality = ::get_flag( nFlags, EXC_SETUP_DRAFT );
  84         maData.mbPrintNotes = ::get_flag( nFlags, EXC_SETUP_PRINTNOTES );
  85         maData.mbManualStart = ::get_flag( nFlags, EXC_SETUP_STARTPAGE );
  86     }
  87 }
  88
  89 void XclImpPageSettings::ReadMargin( XclImpStream& rStrm )
  90 {
  91     switch( rStrm.GetRecId() )
  92     {
  93         case EXC_ID_LEFTMARGIN:     maData.mfLeftMargin = rStrm.ReadDouble();   break;
  94         case EXC_ID_RIGHTMARGIN:    maData.mfRightMargin = rStrm.ReadDouble();  break;
  95         case EXC_ID_TOPMARGIN:      maData.mfTopMargin = rStrm.ReadDouble();    break;
  96         case EXC_ID_BOTTOMMARGIN:   maData.mfBottomMargin = rStrm.ReadDouble(); break;
  97         default:    OSL_FAIL( "XclImpPageSettings::ReadMargin - unknown record" );
  98     }
  99 }
 100
 101 void XclImpPageSettings::ReadCenter( XclImpStream& rStrm )
 102 {
 103     OSL_ENSURE_BIFF( GetBiff() >= EXC_BIFF3 );  // read it anyway
 104     bool bCenter = (rStrm.ReaduInt16() != 0);
 105     switch( rStrm.GetRecId() )
 106     {
 107         case EXC_ID_HCENTER:    maData.mbHorCenter = bCenter;   break;
 108         case EXC_ID_VCENTER:    maData.mbVerCenter = bCenter;   break;
 109         default:    OSL_FAIL( "XclImpPageSettings::ReadCenter - unknown record" );
 110     }
 111 }
 112
 113 void XclImpPageSettings::ReadHeaderFooter( XclImpStream& rStrm )
 114 {
 115     OUString aString;
 116     if( rStrm.GetRecLeft() )
 117         aString = (GetBiff() <= EXC_BIFF5) ? rStrm.ReadByteString( false ) : rStrm.ReadUniString();
 118
 119     switch( rStrm.GetRecId() )
 120     {
 121         case EXC_ID_HEADER:          maData.maHeader = aString;  break;
 122         case EXC_ID_FOOTER:          maData.maFooter = aString;  break;
 123         case EXC_ID_HEADER_EVEN:     maData.maHeaderEven = aString;  break;
 124         case EXC_ID_FOOTER_EVEN:     maData.maFooterEven = aString;  break;
 125         default:    OSL_FAIL( "XclImpPageSettings::ReadHeaderFooter - unknown record" );
 126     }
 127
 128     if (comphelper::IsFuzzing())
 129     {
 130         if (maData.maHeader.getLength() > 10)
 131             maData.maHeader = maData.maHeader.copy(0, 10);
 132         if (maData.maFooter.getLength() > 10)
 133             maData.maFooter = maData.maFooter.copy(0, 10);
 134         if (maData.maHeaderEven.getLength() > 10)
 135             maData.maHeaderEven = maData.maHeaderEven.copy(0, 10);
 136         if (maData.maFooterEven.getLength() > 10)
 137             maData.maFooterEven = maData.maFooterEven.copy(0, 10);
 138     }
 139 }
 140
 141 void XclImpPageSettings::ReadPageBreaks( XclImpStream& rStrm )
 142 {
 143     ScfUInt16Vec* pVec = nullptr;
 144     switch( rStrm.GetRecId() )
 145     {
 146         case EXC_ID_HORPAGEBREAKS:  pVec = &maData.maHorPageBreaks;     break;
 147         case EXC_ID_VERPAGEBREAKS:  pVec = &maData.maVerPageBreaks;     break;
 148         default:    OSL_FAIL( "XclImpPageSettings::ReadPageBreaks - unknown record" );
 149     }
 150
 151     if( !pVec )
 152         return;
 153
 154     bool bIgnore = GetBiff() == EXC_BIFF8;  // ignore start/end columns or rows in BIFF8
 155
 156     sal_uInt16 nCount = rStrm.ReaduInt16();
 157     pVec->clear();
 158     pVec->reserve( nCount );
 159
 160     while (nCount)
 161     {
 162         sal_uInt16 nBreak = rStrm.ReaduInt16();
 163         if( nBreak )
 164             pVec->push_back( nBreak );
 165         if( bIgnore )
 166             rStrm.Ignore( 4 );
 167         --nCount;
 168     }
 169 }
 170
 171 void XclImpPageSettings::ReadPrintHeaders( XclImpStream& rStrm )
 172 {
 173     maData.mbPrintHeadings = (rStrm.ReaduInt16() != 0);
 174 }
 175
 176 void XclImpPageSettings::ReadPrintGridLines( XclImpStream& rStrm )
 177 {
 178     maData.mbPrintGrid = (rStrm.ReaduInt16() != 0);
 179 }
 180
 181 void XclImpPageSettings::ReadImgData( XclImpStream& rStrm )
 182 {
 183     Graphic aGraphic = XclImpDrawing::ReadImgData( GetRoot(), rStrm );
 184     if( aGraphic.GetType() != GraphicType::NONE )
 185         maData.mxBrushItem.reset( new SvxBrushItem( aGraphic, GPOS_TILED, ATTR_BACKGROUND ) );
 186 }
 187
 188 void XclImpPageSettings::SetPaperSize( sal_uInt16 nXclPaperSize, bool bPortrait )
 189 {
 190     maData.mnPaperSize = nXclPaperSize;
 191     maData.mbPortrait = bPortrait;
 192     mbValidPaper = true;
 193 }
 194
 195 namespace {
 196
 197 void lclPutMarginItem( SfxItemSet& rItemSet, sal_uInt16 nRecId, double fMarginInch )
 198 {
 199     sal_uInt16 nMarginTwips = XclTools::GetTwipsFromInch( fMarginInch );
 200     switch( nRecId )
 201     {
 202         case EXC_ID_TOPMARGIN:
 203         case EXC_ID_BOTTOMMARGIN:
 204         {
 205             SvxULSpaceItem aItem( rItemSet.Get( ATTR_ULSPACE ) );
 206             if( nRecId == EXC_ID_TOPMARGIN )
 207                 aItem.SetUpperValue( nMarginTwips );
 208             else
 209                 aItem.SetLowerValue( nMarginTwips );
 210             rItemSet.Put( aItem );
 211         }
 212         break;
 213         case EXC_ID_LEFTMARGIN:
 214         case EXC_ID_RIGHTMARGIN:
 215         {
 216             SvxLRSpaceItem aItem( rItemSet.Get( ATTR_LRSPACE ) );
 217             if (nRecId == EXC_ID_LEFTMARGIN)
 218                 aItem.SetLeft(SvxIndentValue::twips(nMarginTwips));
 219             else
 220                 aItem.SetRight(SvxIndentValue::twips(nMarginTwips));
 221             rItemSet.Put( aItem );
 222         }
 223         break;
 224         default:
 225             OSL_FAIL( "XclImpPageSettings::SetMarginItem - unknown record id" );
 226     }
 227 }
 228
 229 } // namespace
 230
 231 void XclImpPageSettings::Finalize()
 232 {
 233     ScDocument& rDoc = GetDoc();
 234     SCTAB nScTab = GetCurrScTab();
 235
 236     // *** create page style sheet ***
 237
 238     OUString aStyleName;
 239     OUString aTableName;
 240     if( GetDoc().GetName( nScTab, aTableName ) )
 241         aStyleName = "PageStyle_" + aTableName;
 242     else
 243         aStyleName = "PageStyle_" + OUString::number(static_cast<sal_Int32>(nScTab+1));
 244
 245     ScStyleSheet& rStyleSheet = ScfTools::MakePageStyleSheet(
 246         GetStyleSheetPool(), aStyleName, false);
 247
 248     SfxItemSet& rItemSet = rStyleSheet.GetItemSet();
 249
 250     // *** page settings ***
 251
 252     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_TOPDOWN,    !maData.mbPrintInRows ),    true );
 253     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_HORCENTER,  maData.mbHorCenter ),       true );
 254     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_VERCENTER,  maData.mbVerCenter ),       true );
 255     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_HEADERS,    maData.mbPrintHeadings ),   true );
 256     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_GRID,       maData.mbPrintGrid ),       true );
 257     ScfTools::PutItem( rItemSet, SfxBoolItem( ATTR_PAGE_NOTES,      maData.mbPrintNotes ),      true );
 258
 259     sal_uInt16 nStartPage = maData.mbManualStart ? maData.mnStartPage : 0;
 260     ScfTools::PutItem( rItemSet, SfxUInt16Item( ATTR_PAGE_FIRSTPAGENO, nStartPage ), true );
 261
 262     if( maData.mxBrushItem )
 263         rItemSet.Put( *maData.mxBrushItem );
 264
 265     if( mbValidPaper )
 266     {
 267         SvxPageItem aPageItem( rItemSet.Get( ATTR_PAGE ) );
 268         aPageItem.SetLandscape( !maData.mbPortrait );
 269         rItemSet.Put( aPageItem );
 270         ScfTools::PutItem( rItemSet, SvxSizeItem( ATTR_PAGE_SIZE, maData.GetScPaperSize() ), true );
 271     }
 272
 273     if( maData.mbFitToPages )
 274         rItemSet.Put( ScPageScaleToItem( maData.mnFitToWidth, maData.mnFitToHeight ) );
 275     else if( maData.mbValid )
 276         rItemSet.Put( SfxUInt16Item( ATTR_PAGE_SCALE, maData.mnScaling ) );
 277
 278     // *** margin preparations ***
 279
 280     double fLeftMargin   = maData.mfLeftMargin;
 281     double fRightMargin  = maData.mfRightMargin;
 282     double fTopMargin    = maData.mfTopMargin;
 283     double fBottomMargin = maData.mfBottomMargin;
 284     // distances between header/footer and page area
 285     double fHeaderHeight = 0.0;
 286     double fHeaderDist = 0.0;
 287     double fFooterHeight = 0.0;
 288     double fFooterDist = 0.0;
 289     // in Calc, "header/footer left/right margin" is X distance between header/footer and page margin
 290     double fHdrLeftMargin  = maData.mfHdrLeftMargin  - maData.mfLeftMargin;
 291     double fHdrRightMargin = maData.mfHdrRightMargin - maData.mfRightMargin;
 292     double fFtrLeftMargin  = maData.mfFtrLeftMargin  - maData.mfLeftMargin;
 293     double fFtrRightMargin = maData.mfFtrRightMargin - maData.mfRightMargin;
 294
 295     // *** header and footer ***
 296
 297     XclImpHFConverter aHFConv( GetRoot() );
 298
 299     // header
 300     bool bHasHeader = !maData.maHeader.isEmpty();
 301     SvxSetItem aHdrSetItem( rItemSet.Get( ATTR_PAGE_HEADERSET ) );
 302     SfxItemSet& rHdrItemSet = aHdrSetItem.GetItemSet();
 303     rHdrItemSet.Put( SfxBoolItem( ATTR_PAGE_ON, bHasHeader ) );
 304     if( bHasHeader )
 305     {
 306         aHFConv.ParseString( maData.maHeader );
 307         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_HEADERLEFT );
 308         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_HEADERRIGHT );
 309         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_HEADERFIRST );
 310         // #i23296# In Calc, "top margin" is distance to header
 311         fTopMargin = maData.mfHeaderMargin;
 312         // Calc uses distance between header and sheet data area
 313         fHeaderHeight = XclTools::GetInchFromTwips( aHFConv.GetTotalHeight() );
 314         fHeaderDist = maData.mfTopMargin - maData.mfHeaderMargin - fHeaderHeight;
 315     }
 316     if( fHeaderDist < 0.0 )
 317     {
 318         /*  #i23296# Header overlays sheet data:
 319             -> set fixed header height to get correct sheet data position. */
 320         ScfTools::PutItem( rHdrItemSet, SfxBoolItem( ATTR_PAGE_DYNAMIC, false ), true );
 321         // shrink header height
 322         tools::Long nHdrHeight = XclTools::GetTwipsFromInch( fHeaderHeight + fHeaderDist );
 323         ScfTools::PutItem( rHdrItemSet, SvxSizeItem( ATTR_PAGE_SIZE, Size( 0, nHdrHeight ) ), true );
 324         lclPutMarginItem( rHdrItemSet, EXC_ID_BOTTOMMARGIN, 0.0 );
 325     }
 326     else
 327     {
 328         // use dynamic header height
 329         ScfTools::PutItem( rHdrItemSet, SfxBoolItem( ATTR_PAGE_DYNAMIC, true ), true );
 330         lclPutMarginItem( rHdrItemSet, EXC_ID_BOTTOMMARGIN, fHeaderDist );
 331     }
 332     lclPutMarginItem( rHdrItemSet, EXC_ID_LEFTMARGIN,   fHdrLeftMargin );
 333     lclPutMarginItem( rHdrItemSet, EXC_ID_RIGHTMARGIN,  fHdrRightMargin );
 334     rItemSet.Put( aHdrSetItem );
 335
 336     // footer
 337     bool bHasFooter = !maData.maFooter.isEmpty();
 338     SvxSetItem aFtrSetItem( rItemSet.Get( ATTR_PAGE_FOOTERSET ) );
 339     SfxItemSet& rFtrItemSet = aFtrSetItem.GetItemSet();
 340     rFtrItemSet.Put( SfxBoolItem( ATTR_PAGE_ON, bHasFooter ) );
 341     if( bHasFooter )
 342     {
 343         aHFConv.ParseString( maData.maFooter );
 344         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_FOOTERLEFT );
 345         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_FOOTERRIGHT );
 346         aHFConv.FillToItemSet( rItemSet, ATTR_PAGE_FOOTERFIRST );
 347         // #i23296# In Calc, "bottom margin" is distance to footer
 348         fBottomMargin = maData.mfFooterMargin;
 349         // Calc uses distance between footer and sheet data area
 350         fFooterHeight = XclTools::GetInchFromTwips( aHFConv.GetTotalHeight() );
 351         fFooterDist = maData.mfBottomMargin - maData.mfFooterMargin - fFooterHeight;
 352     }
 353     if( fFooterDist < 0.0 )
 354     {
 355         /*  #i23296# Footer overlays sheet data:
 356             -> set fixed footer height to get correct sheet data end position. */
 357         ScfTools::PutItem( rFtrItemSet, SfxBoolItem( ATTR_PAGE_DYNAMIC, false ), true );
 358         // shrink footer height
 359         tools::Long nFtrHeight = XclTools::GetTwipsFromInch( fFooterHeight + fFooterDist );
 360         ScfTools::PutItem( rFtrItemSet, SvxSizeItem( ATTR_PAGE_SIZE, Size( 0, nFtrHeight ) ), true );
 361         lclPutMarginItem( rFtrItemSet, EXC_ID_TOPMARGIN, 0.0 );
 362     }
 363     else
 364     {
 365         // use dynamic footer height
 366         ScfTools::PutItem( rFtrItemSet, SfxBoolItem( ATTR_PAGE_DYNAMIC, true ), true );
 367         lclPutMarginItem( rFtrItemSet, EXC_ID_TOPMARGIN, fFooterDist );
 368     }
 369     lclPutMarginItem( rFtrItemSet, EXC_ID_LEFTMARGIN,   fFtrLeftMargin );
 370     lclPutMarginItem( rFtrItemSet, EXC_ID_RIGHTMARGIN,  fFtrRightMargin );
 371     rItemSet.Put( aFtrSetItem );
 372
 373     // *** set final margins ***
 374
 375     lclPutMarginItem( rItemSet, EXC_ID_LEFTMARGIN,   fLeftMargin );
 376     lclPutMarginItem( rItemSet, EXC_ID_RIGHTMARGIN,  fRightMargin );
 377     lclPutMarginItem( rItemSet, EXC_ID_TOPMARGIN,    fTopMargin );
 378     lclPutMarginItem( rItemSet, EXC_ID_BOTTOMMARGIN, fBottomMargin );
 379
 380     // *** put style sheet into document ***
 381
 382     rDoc.SetPageStyle( nScTab, rStyleSheet.GetName() );
 383
 384     // *** page breaks ***
 385
 386     for( const auto& rHorPageBreak : maData.maHorPageBreaks )
 387     {
 388         SCROW nScRow = static_cast< SCROW >( rHorPageBreak );
 389         if( nScRow <= rDoc.MaxRow() )
 390             rDoc.SetRowBreak(nScRow, nScTab, false, true);
 391     }
 392
 393     for( const auto& rVerPageBreak : maData.maVerPageBreaks )
 394     {
 395         SCCOL nScCol = static_cast< SCCOL >( rVerPageBreak );
 396         if( nScCol <= rDoc.MaxCol() )
 397             rDoc.SetColBreak(nScCol, nScTab, false, true);
 398     }
 399 }
 400
 401 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */