sc/source/filter/inc/xiview.hxx

   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 #pragma once
  21
  22 #include "xlview.hxx"
  23 #include "xiroot.hxx"
  24
  25 // Document view settings =====================================================
  26
  27 /** Contains document view settings (WINDOW1 record). */
  28 class XclImpDocViewSettings : protected XclImpRoot
  29 {
  30 public:
  31     explicit            XclImpDocViewSettings( const XclImpRoot& rRoot );
  32
  33     /** Reads a WINDOW1 record. */
  34     void                ReadWindow1( XclImpStream& rStrm );
  35
  36     /** Returns the Calc index of the displayed sheet. */
  37     SCTAB               GetDisplScTab() const;
  38
  39     /** Sets the view settings at the document. */
  40     void                Finalize();
  41
  42 private:
  43     XclDocViewData      maData;         /// Document view settings data.
  44 };
  45
  46 // Sheet view settings ========================================================
  47
  48 /** Contains all view settings for a single sheet.
  49
  50     Usage:
  51     1)  When import filter starts reading a worksheet substream, initialize an
  52         instance of this class with the Initialize() function. This will set
  53         all view options to Excel default values.
  54     2)  Read all view related records using the Read*() functions.
  55     3)  When import filter ends reading a worksheet substream, call Finalize()
  56         to set all view settings to the current sheet of the Calc document.
  57  */
  58 class XclImpTabViewSettings : protected XclImpRoot
  59 {
  60 public:
  61     explicit            XclImpTabViewSettings( const XclImpRoot& rRoot );
  62
  63     /** Initializes the object to be used for a new sheet. */
  64     void                Initialize();
  65
  66     /** Reads a WINDOW2 record. */
  67     void                ReadWindow2( XclImpStream& rStrm, bool bChart );
  68     /** Reads an SCL record. */
  69     void                ReadScl( XclImpStream& rStrm );
  70     /** Reads a PANE record. */
  71     void                ReadPane( XclImpStream& rStrm );
  72     /** Reads a SELECTION record. */
  73     void                ReadSelection( XclImpStream& rStrm );
  74     /** Reads a SHEETEXT record (Tab Color). */
  75     void                ReadTabBgColor( XclImpStream& rStrm, const XclImpPalette& rPal );
  76     /** Sets the view settings at the current sheet or the extended sheet options object. */
  77     void                Finalize();
  78
  79 private:
  80     XclTabViewData      maData;         /// Sheet view settings data.
  81 };
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */