sc/source/filter/inc/xlview.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 #ifndef INCLUDED_SC_SOURCE_FILTER_INC_XLVIEW_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_XLVIEW_HXX
  22
  23 #include <map>
  24 #include <tools/color.hxx>
  25 #include "ftools.hxx"
  26 #include "xladdress.hxx"
  27 #include <boost/shared_ptr.hpp>
  28
  29 // Constants and enumerations =================================================
  30
  31 const sal_uInt16 EXC_ZOOM_MIN               = 10;
  32 const sal_uInt16 EXC_ZOOM_MAX               = 400;
  33
  34 // (0x001D) SELECTION ---------------------------------------------------------
  35
  36 const sal_uInt16 EXC_ID_SELECTION           = 0x001D;
  37
  38 // (0x003D) WINDOW1 -----------------------------------------------------------
  39
  40 const sal_uInt16 EXC_ID_WINDOW1             = 0x003D;
  41
  42 const sal_uInt16 EXC_WIN1_HIDDEN            = 0x0001;
  43 const sal_uInt16 EXC_WIN1_MINIMIZED         = 0x0002;
  44 const sal_uInt16 EXC_WIN1_HOR_SCROLLBAR     = 0x0008;
  45 const sal_uInt16 EXC_WIN1_VER_SCROLLBAR     = 0x0010;
  46 const sal_uInt16 EXC_WIN1_TABBAR            = 0x0020;
  47
  48 // (0x003E, 0x023E) WINDOW2 ---------------------------------------------------
  49
  50 const sal_uInt16 EXC_ID2_WINDOW2            = 0x003E;
  51 const sal_uInt16 EXC_ID_WINDOW2             = 0x023E;
  52
  53 const sal_uInt16 EXC_WIN2_SHOWFORMULAS      = 0x0001;
  54 const sal_uInt16 EXC_WIN2_SHOWGRID          = 0x0002;
  55 const sal_uInt16 EXC_WIN2_SHOWHEADINGS      = 0x0004;
  56 const sal_uInt16 EXC_WIN2_FROZEN            = 0x0008;
  57 const sal_uInt16 EXC_WIN2_SHOWZEROS         = 0x0010;
  58 const sal_uInt16 EXC_WIN2_DEFGRIDCOLOR      = 0x0020;
  59 const sal_uInt16 EXC_WIN2_MIRRORED          = 0x0040;
  60 const sal_uInt16 EXC_WIN2_SHOWOUTLINE       = 0x0080;
  61 const sal_uInt16 EXC_WIN2_FROZENNOSPLIT     = 0x0100;
  62 const sal_uInt16 EXC_WIN2_SELECTED          = 0x0200;
  63 const sal_uInt16 EXC_WIN2_DISPLAYED         = 0x0400;
  64 const sal_uInt16 EXC_WIN2_PAGEBREAKMODE     = 0x0800;
  65
  66 const sal_uInt16 EXC_WIN2_NORMALZOOM_DEF    = 100;      /// Default zoom for normal view.
  67 const sal_uInt16 EXC_WIN2_PAGEZOOM_DEF      = 60;       /// Default zoom for pagebreak preview.
  68
  69 // (0x0041) PANE --------------------------------------------------------------
  70
  71 const sal_uInt16 EXC_ID_PANE                = 0x0041;
  72
  73 const sal_uInt8 EXC_PANE_BOTTOMRIGHT        = 0;        /// Bottom-right pane.
  74 const sal_uInt8 EXC_PANE_TOPRIGHT           = 1;        /// Right, or top-right pane.
  75 const sal_uInt8 EXC_PANE_BOTTOMLEFT         = 2;        /// Bottom, or bottom-left pane.
  76 const sal_uInt8 EXC_PANE_TOPLEFT            = 3;        /// Single, top, left, or top-left pane.
  77
  78 // (0x00A0) SCL ---------------------------------------------------------------
  79
  80 const sal_uInt16 EXC_ID_SCL                 = 0x00A0;
  81
  82 // (0x0862) SHEETEXT ----------------------------------------------------------
  83
  84 const sal_uInt16 EXC_ID_SHEETEXT            = 0x0862;   /// header id for sheetext
  85 const sal_uInt8 EXC_SHEETEXT_TABCOLOR       = 0x7F;     /// mask for tab color
  86 const sal_uInt16 EXC_COLOR_NOTABBG          = 0x7F;     /// Excel ignores Tab color when set to this value...
  87 // Structs ====================================================================
  88
  89 /** Contains all view settings for the entire document. */
  90 struct XclDocViewData
  91 {
  92     sal_uInt16          mnWinX;             /// X position of the document window (twips).
  93     sal_uInt16          mnWinY;             /// Y position of the document window (twips).
  94     sal_uInt16          mnWinWidth;         /// Width of the document window (twips).
  95     sal_uInt16          mnWinHeight;        /// Height of the document window (twips).
  96     sal_uInt16          mnFlags;            /// Additional flags.
  97     sal_uInt16          mnDisplXclTab;      /// Displayed (active) sheet.
  98     sal_uInt16          mnFirstVisXclTab;   /// First visible sheet.
  99     sal_uInt16          mnXclSelectCnt;     /// Number of selected sheets.
 100     sal_uInt16          mnTabBarWidth;      /// Width of sheet tabbar (1/1000 of window width).
 101
 102     explicit            XclDocViewData();
 103 };
 104
 105 /** Contains all settings for a selection in a single pane of a sheet. */
 106 struct XclSelectionData
 107 {
 108     XclAddress          maXclCursor;        /// Cell cursor position.
 109     XclRangeList        maXclSelection;     /// Selected cell ranges.
 110     sal_uInt16          mnCursorIdx;        /// Index of cursor in selection list.
 111
 112     inline explicit     XclSelectionData() : mnCursorIdx( 0 ) {}
 113 };
 114
 115 typedef boost::shared_ptr< XclSelectionData > XclSelectionDataRef;
 116
 117 /** Contains all view settings for a single sheet. */
 118 struct XclTabViewData
 119 {
 120     typedef ::std::map< sal_uInt8, XclSelectionDataRef > XclSelectionMap;
 121
 122     XclSelectionMap     maSelMap;           /// Selections of all panes.
 123     Color               maGridColor;        /// Grid color.
 124     XclAddress          maFirstXclPos;      /// First visible cell.
 125     XclAddress          maSecondXclPos;     /// First visible cell in additional panes.
 126     sal_uInt16          mnSplitX;           /// Split X position, or number of frozen columns.
 127     sal_uInt32          mnSplitY;           /// Split Y position, or number of frozen rows.
 128     sal_uInt16          mnNormalZoom;       /// Zoom factor for normal view.
 129     sal_uInt16          mnPageZoom;         /// Zoom factor for pagebreak preview.
 130     sal_uInt16          mnCurrentZoom;      /// Zoom factor for current view.
 131     sal_uInt8           mnActivePane;       /// Active pane (with cell cursor).
 132     bool                mbSelected;         /// true = Sheet is selected.
 133     bool                mbDisplayed;        /// true = Sheet is displayed (active).
 134     bool                mbMirrored;         /// true = Mirrored (right-to-left) sheet.
 135     bool                mbFrozenPanes;      /// true = Frozen panes; false = split window.
 136     bool                mbPageMode;         /// true = Pagebreak preview; false = Normal view.
 137     bool                mbDefGridColor;     /// true = Default grid color.
 138     bool                mbShowFormulas;     /// true = Show formulas instead of results.
 139     bool                mbShowGrid;         /// true = Show cell grid.
 140     bool                mbShowHeadings;     /// true = Show column/row headings.
 141     bool                mbShowZeros;        /// true = Show zero value zells.
 142     bool                mbShowOutline;      /// true = Show outlines.
 143     Color               maTabBgColor;       /// Tab Color default = (COL_AUTO )
 144     bool                IsDefaultTabBgColor() const { return maTabBgColor == Color(COL_AUTO); };
 145     sal_uInt32          mnTabBgColorId;         /// pallette color id
 146
 147     explicit            XclTabViewData();
 148                         ~XclTabViewData();
 149
 150     /** Sets Excel default view settings. */
 151     void                SetDefaults();
 152
 153     /** Returns true, if the window is split in any direction. */
 154     bool                IsSplit() const;
 155     /** Returns true, if the specified pane (EXC_PANE_*) is available. */
 156     bool                HasPane( sal_uInt8 nPaneId ) const;
 157
 158     /** Returns the selection data, if available, otherwise 0. */
 159     const XclSelectionData* GetSelectionData( sal_uInt8 nPane ) const;
 160     /** Returns read/write access to the selection data of the specified pane. */
 161     XclSelectionData&   CreateSelectionData( sal_uInt8 nPane );
 162 };
 163
 164 #endif
 165
 166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */