sc/source/filter/excel/xiview.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 <sal/config.h>
  21
  22 #include <o3tl/safeint.hxx>
  23
  24 #include <xiview.hxx>
  25 #include <document.hxx>
  26 #include <scextopt.hxx>
  27 #include <viewopti.hxx>
  28 #include <xistream.hxx>
  29 #include <xihelper.hxx>
  30 #include <xistyle.hxx>
  31
  32 // Document view settings =====================================================
  33
  34 XclImpDocViewSettings::XclImpDocViewSettings( const XclImpRoot& rRoot ) :
  35     XclImpRoot( rRoot )
  36 {
  37 }
  38
  39 void XclImpDocViewSettings::ReadWindow1( XclImpStream& rStrm )
  40 {
  41     maData.mnWinX = rStrm.ReaduInt16();
  42     maData.mnWinY = rStrm.ReaduInt16();
  43     maData.mnWinWidth = rStrm.ReaduInt16();
  44     maData.mnWinHeight = rStrm.ReaduInt16();
  45     maData.mnFlags = rStrm.ReaduInt16();
  46     if( GetBiff() >= EXC_BIFF5 )
  47     {
  48         maData.mnDisplXclTab = rStrm.ReaduInt16();
  49         maData.mnFirstVisXclTab = rStrm.ReaduInt16();
  50         maData.mnXclSelectCnt = rStrm.ReaduInt16();
  51         maData.mnTabBarWidth = rStrm.ReaduInt16();
  52     }
  53 }
  54
  55 SCTAB XclImpDocViewSettings::GetDisplScTab() const
  56 {
  57     /*  Simply cast Excel index to Calc index.
  58         TODO: This may fail if the document contains scenarios. */
  59     sal_uInt16 nMaxXclTab = static_cast< sal_uInt16 >( GetMaxPos().Tab() );
  60     return static_cast< SCTAB >( (maData.mnDisplXclTab <= nMaxXclTab) ? maData.mnDisplXclTab : 0 );
  61 }
  62
  63 void XclImpDocViewSettings::Finalize()
  64 {
  65     ScViewOptions aViewOpt( GetDoc().GetViewOptions() );
  66     aViewOpt.SetOption( VOPT_HSCROLL,       ::get_flag( maData.mnFlags, EXC_WIN1_HOR_SCROLLBAR ) );
  67     aViewOpt.SetOption( VOPT_VSCROLL,       ::get_flag( maData.mnFlags, EXC_WIN1_VER_SCROLLBAR ) );
  68     aViewOpt.SetOption( VOPT_TABCONTROLS,   ::get_flag( maData.mnFlags, EXC_WIN1_TABBAR ) );
  69     GetDoc().SetViewOptions( aViewOpt );
  70
  71     // displayed sheet
  72     GetExtDocOptions().GetDocSettings().mnDisplTab = GetDisplScTab();
  73
  74     // width of the tabbar with sheet names
  75     if( maData.mnTabBarWidth <= 1000 )
  76         GetExtDocOptions().GetDocSettings().mfTabBarWidth = static_cast< double >( maData.mnTabBarWidth ) / 1000.0;
  77 }
  78
  79 // Sheet view settings ========================================================
  80
  81 namespace {
  82
  83 tools::Long lclGetScZoom( sal_uInt16 nXclZoom, sal_uInt16 nDefZoom )
  84 {
  85     return static_cast< tools::Long >( nXclZoom ? nXclZoom : nDefZoom );
  86 }
  87
  88 } // namespace
  89
  90 XclImpTabViewSettings::XclImpTabViewSettings( const XclImpRoot& rRoot ) :
  91     XclImpRoot( rRoot )
  92 {
  93     Initialize();
  94 }
  95
  96 void XclImpTabViewSettings::Initialize()
  97 {
  98     maData.SetDefaults();
  99 }
 100
 101 void XclImpTabViewSettings::ReadTabBgColor( XclImpStream& rStrm, const XclImpPalette& rPal )
 102 {
 103     OSL_ENSURE_BIFF( GetBiff() >= EXC_BIFF8 );
 104     if( GetBiff() < EXC_BIFF8 )
 105         return;
 106
 107     sal_uInt8 ColorIndex;
 108
 109     rStrm.Ignore( 16 );
 110     ColorIndex = rStrm.ReaduInt8() & EXC_SHEETEXT_TABCOLOR; //0x7F
 111     if ( ColorIndex >= 8 && ColorIndex <= 63 ) //only accept valid index values
 112     {
 113         maData.maTabBgColor = rPal.GetColor( ColorIndex );
 114     }
 115 }
 116
 117 void XclImpTabViewSettings::ReadWindow2( XclImpStream& rStrm, bool bChart )
 118 {
 119     if( GetBiff() == EXC_BIFF2 )
 120     {
 121         maData.mbShowFormulas   = rStrm.ReaduInt8() != 0;
 122         maData.mbShowGrid       = rStrm.ReaduInt8() != 0;
 123         maData.mbShowHeadings   = rStrm.ReaduInt8() != 0;
 124         maData.mbFrozenPanes    = rStrm.ReaduInt8() != 0;
 125         maData.mbShowZeros      = rStrm.ReaduInt8() != 0;
 126         rStrm >> maData.maFirstXclPos;
 127         maData.mbDefGridColor   = rStrm.ReaduInt8() != 0;
 128         rStrm >> maData.maGridColor;
 129     }
 130     else
 131     {
 132         sal_uInt16 nFlags;
 133         nFlags = rStrm.ReaduInt16();
 134         rStrm >> maData.maFirstXclPos;
 135
 136         // #i59590# real life: Excel ignores some view settings in chart sheets
 137         maData.mbSelected       = ::get_flag( nFlags, EXC_WIN2_SELECTED );
 138         maData.mbDisplayed      = ::get_flag( nFlags, EXC_WIN2_DISPLAYED );
 139         maData.mbMirrored       = !bChart && ::get_flag( nFlags, EXC_WIN2_MIRRORED );
 140         maData.mbFrozenPanes    = !bChart && ::get_flag( nFlags, EXC_WIN2_FROZEN );
 141         maData.mbPageMode       = !bChart && ::get_flag( nFlags, EXC_WIN2_PAGEBREAKMODE );
 142         maData.mbDefGridColor   = bChart || ::get_flag( nFlags, EXC_WIN2_DEFGRIDCOLOR );
 143         maData.mbShowFormulas   = !bChart && ::get_flag( nFlags, EXC_WIN2_SHOWFORMULAS );
 144         maData.mbShowGrid       = bChart || ::get_flag( nFlags, EXC_WIN2_SHOWGRID );
 145         maData.mbShowHeadings   = bChart || ::get_flag( nFlags, EXC_WIN2_SHOWHEADINGS );
 146         maData.mbShowZeros      = bChart || ::get_flag( nFlags, EXC_WIN2_SHOWZEROS );
 147         maData.mbShowOutline    = bChart || ::get_flag( nFlags, EXC_WIN2_SHOWOUTLINE );
 148
 149         switch( GetBiff() )
 150         {
 151             case EXC_BIFF3:
 152             case EXC_BIFF4:
 153             case EXC_BIFF5:
 154                 rStrm >> maData.maGridColor;
 155             break;
 156             case EXC_BIFF8:
 157             {
 158                 sal_uInt16 nGridColorIdx;
 159                 nGridColorIdx = rStrm.ReaduInt16();
 160                 // zoom data not included in chart sheets
 161                 if( rStrm.GetRecLeft() >= 6 )
 162                 {
 163                     rStrm.Ignore( 2 );
 164                     maData.mnPageZoom = rStrm.ReaduInt16();
 165                     maData.mnNormalZoom = rStrm.ReaduInt16();
 166                 }
 167
 168                 if( !maData.mbDefGridColor )
 169                     maData.maGridColor = GetPalette().GetColor( nGridColorIdx );
 170             }
 171             break;
 172             default:    DBG_ERROR_BIFF();
 173         }
 174     }
 175
 176     // do not scroll chart sheets
 177     if( bChart )
 178         maData.maFirstXclPos.Set( 0, 0 );
 179 }
 180
 181 void XclImpTabViewSettings::ReadScl( XclImpStream& rStrm )
 182 {
 183     sal_uInt16 nNum, nDenom;
 184     nNum = rStrm.ReaduInt16();
 185     nDenom = rStrm.ReaduInt16();
 186     OSL_ENSURE( nDenom > 0, "XclImpPageSettings::ReadScl - invalid denominator" );
 187     if( nDenom > 0 )
 188         maData.mnCurrentZoom = limit_cast< sal_uInt16 >( (nNum * 100) / nDenom );
 189 }
 190
 191 void XclImpTabViewSettings::ReadPane( XclImpStream& rStrm )
 192 {
 193     maData.mnSplitX = rStrm.ReaduInt16();
 194     maData.mnSplitY = rStrm.ReaduInt16();
 195
 196     rStrm >> maData.maSecondXclPos;
 197     maData.mnActivePane = rStrm.ReaduInt8();
 198 }
 199
 200 void XclImpTabViewSettings::ReadSelection( XclImpStream& rStrm )
 201 {
 202     // pane of this selection
 203     sal_uInt8 nPane;
 204     nPane = rStrm.ReaduInt8();
 205     XclSelectionData& rSelData = maData.CreateSelectionData( nPane );
 206     // cursor position and selection
 207     rStrm >> rSelData.maXclCursor;
 208     rSelData.mnCursorIdx = rStrm.ReaduInt16();
 209     rSelData.maXclSelection.Read( rStrm, false );
 210 }
 211
 212 void XclImpTabViewSettings::Finalize()
 213 {
 214     SCTAB nScTab = GetCurrScTab();
 215     ScDocument& rDoc = GetDoc();
 216     XclImpAddressConverter& rAddrConv = GetAddressConverter();
 217     ScExtTabSettings& rTabSett = GetExtDocOptions().GetOrCreateTabSettings( nScTab );
 218     bool bDisplayed = GetDocViewSettings().GetDisplScTab() == nScTab;
 219
 220     // *** sheet options: cursor, selection, splits, zoom ***
 221
 222     // sheet flags
 223     if( maData.mbMirrored )
 224         // do not call this function with sal_False, it would mirror away all drawing objects
 225         rDoc.SetLayoutRTL( nScTab, true );
 226     rTabSett.mbSelected = maData.mbSelected || bDisplayed;
 227
 228     // first visible cell in top-left pane and in additional pane(s)
 229     rTabSett.maFirstVis = rAddrConv.CreateValidAddress( maData.maFirstXclPos, nScTab, false );
 230     rTabSett.maSecondVis = rAddrConv.CreateValidAddress( maData.maSecondXclPos, nScTab, false );
 231
 232     // cursor position and selection
 233     if( const XclSelectionData* pSelData = maData.GetSelectionData( maData.mnActivePane ) )
 234     {
 235         rTabSett.maCursor = rAddrConv.CreateValidAddress( pSelData->maXclCursor, nScTab, false );
 236         rAddrConv.ConvertRangeList( rTabSett.maSelection, pSelData->maXclSelection, nScTab, false );
 237     }
 238
 239     // active pane
 240     switch( maData.mnActivePane )
 241     {
 242         case EXC_PANE_TOPLEFT:      rTabSett.meActivePane = SCEXT_PANE_TOPLEFT;     break;
 243         case EXC_PANE_TOPRIGHT:     rTabSett.meActivePane = SCEXT_PANE_TOPRIGHT;    break;
 244         case EXC_PANE_BOTTOMLEFT:   rTabSett.meActivePane = SCEXT_PANE_BOTTOMLEFT;  break;
 245         case EXC_PANE_BOTTOMRIGHT:  rTabSett.meActivePane = SCEXT_PANE_BOTTOMRIGHT; break;
 246     }
 247
 248     // freeze/split position
 249     rTabSett.mbFrozenPanes = maData.mbFrozenPanes;
 250     if( maData.mbFrozenPanes )
 251     {
 252         /*  Frozen panes: handle split position as row/column positions.
 253             #i35812# Excel uses number of visible rows/columns, Calc uses position of freeze. */
 254         if( (maData.mnSplitX > 0) && (maData.maFirstXclPos.mnCol + maData.mnSplitX <= GetScMaxPos().Col()) )
 255             rTabSett.maFreezePos.SetCol( static_cast< SCCOL >( maData.maFirstXclPos.mnCol + maData.mnSplitX ) );
 256         if( (maData.mnSplitY > 0) && (maData.maFirstXclPos.mnRow + maData.mnSplitY <= o3tl::make_unsigned(GetScMaxPos().Row())) )
 257             rTabSett.maFreezePos.SetRow( static_cast< SCROW >( maData.maFirstXclPos.mnRow + maData.mnSplitY ) );
 258     }
 259     else
 260     {
 261         // split window: position is in twips
 262         rTabSett.maSplitPos.setX( static_cast< tools::Long >( maData.mnSplitX ) );
 263         rTabSett.maSplitPos.setY( static_cast< tools::Long >( maData.mnSplitY ) );
 264     }
 265
 266     // grid color
 267     if( maData.mbDefGridColor )
 268         rTabSett.maGridColor = COL_AUTO;
 269     else
 270         rTabSett.maGridColor = maData.maGridColor;
 271
 272     // show grid option
 273     rTabSett.mbShowGrid      = maData.mbShowGrid;
 274
 275     // view mode and zoom
 276     if( maData.mnCurrentZoom != 0 )
 277         (maData.mbPageMode ? maData.mnPageZoom : maData.mnNormalZoom) = maData.mnCurrentZoom;
 278     rTabSett.mbPageMode      = maData.mbPageMode;
 279     rTabSett.mnNormalZoom    = lclGetScZoom( maData.mnNormalZoom, EXC_WIN2_NORMALZOOM_DEF );
 280     rTabSett.mnPageZoom      = lclGetScZoom( maData.mnPageZoom, EXC_WIN2_PAGEZOOM_DEF );
 281
 282     // *** additional handling for displayed sheet ***
 283
 284     if( bDisplayed )
 285     {
 286         // set Excel sheet settings globally at Calc document, take settings from displayed sheet
 287         ScViewOptions aViewOpt( rDoc.GetViewOptions() );
 288         aViewOpt.SetOption( VOPT_FORMULAS, maData.mbShowFormulas );
 289         aViewOpt.SetOption( VOPT_HEADER,   maData.mbShowHeadings );
 290         aViewOpt.SetOption( VOPT_NULLVALS, maData.mbShowZeros );
 291         aViewOpt.SetOption( VOPT_OUTLINER, maData.mbShowOutline );
 292         rDoc.SetViewOptions( aViewOpt );
 293     }
 294
 295     // *** set tab bg color
 296     if ( !maData.IsDefaultTabBgColor() )
 297         rDoc.SetTabBgColor(nScTab, maData.maTabBgColor);
 298 }
 299
 300 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */