sc/inc/viewopti.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 <svx/optgrid.hxx>
  23
  24 #include "scdllapi.h"
  25 #include "optutil.hxx"
  26 #include "global.hxx"
  27
  28 // View options
  29
  30 enum ScViewOption
  31 {
  32     VOPT_FORMULAS = 0,
  33     VOPT_NULLVALS,
  34     VOPT_SYNTAX,
  35     VOPT_NOTES,
  36     VOPT_FORMULAS_MARKS,
  37     VOPT_VSCROLL,
  38     VOPT_HSCROLL,
  39     VOPT_TABCONTROLS,
  40     VOPT_OUTLINER,
  41     VOPT_HEADER,
  42     VOPT_GRID,
  43     VOPT_GRID_ONTOP,
  44     VOPT_HELPLINES,
  45     VOPT_ANCHOR,
  46     VOPT_PAGEBREAKS,
  47     VOPT_SUMMARY,
  48     VOPT_THEMEDCURSOR,
  49 };
  50
  51 enum ScVObjType
  52 {
  53     VOBJ_TYPE_OLE = 0,
  54     VOBJ_TYPE_CHART,
  55     VOBJ_TYPE_DRAW
  56 };
  57
  58 #define MAX_OPT             sal_uInt16(VOPT_THEMEDCURSOR)+1
  59 #define MAX_TYPE            sal_uInt16(VOBJ_TYPE_DRAW)+1
  60
  61 // SvxGrid options with standard operators
  62
  63 class ScGridOptions : public SvxOptionsGrid
  64 {
  65 public:
  66                 ScGridOptions()  {}
  67                 ScGridOptions( const SvxOptionsGrid& rOpt ) : SvxOptionsGrid( rOpt ) {}
  68
  69     void                    SetDefaults();
  70     bool                    operator== ( const ScGridOptions& rOpt ) const;
  71     bool                    operator!= ( const ScGridOptions& rOpt ) const { return !(operator==(rOpt)); }
  72 };
  73
  74 // Options - View
  75
  76 class SC_DLLPUBLIC ScViewOptions
  77 {
  78 public:
  79                 ScViewOptions();
  80                 ScViewOptions( const ScViewOptions& rCpy );
  81                 ~ScViewOptions();
  82
  83     void                    SetDefaults();
  84
  85     void                    SetOption( ScViewOption eOpt, bool bNew )    { aOptArr[eOpt] = bNew; }
  86     bool                    GetOption( ScViewOption eOpt ) const         { return aOptArr[eOpt]; }
  87
  88     void                    SetObjMode( ScVObjType eObj, ScVObjMode eMode ) { aModeArr[eObj] = eMode; }
  89     ScVObjMode              GetObjMode( ScVObjType eObj ) const             { return aModeArr[eObj]; }
  90
  91     void                    SetGridColor( const Color& rCol, const OUString& rName ) { aGridCol = rCol; aGridColName = rName;}
  92     Color const &           GetGridColor( OUString* pStrName = nullptr ) const;
  93
  94     const ScGridOptions&    GetGridOptions() const                      { return aGridOpt; }
  95     void                    SetGridOptions( const ScGridOptions& rNew ) { aGridOpt = rNew; }
  96     std::unique_ptr<SvxGridItem> CreateGridItem() const;
  97
  98     const OUString& GetColorSchemeName() const { return sColorSchemeName; }
  99     void SetColorSchemeName( const OUString& rName ) { sColorSchemeName = rName; }
 100
 101     const Color& GetDocColor() const { return aDocCol; }
 102     void SetDocColor(const Color& rDocColor) { aDocCol = rDocColor; }
 103
 104     ScViewOptions&          operator=  ( const ScViewOptions& rCpy );
 105     bool                    operator== ( const ScViewOptions& rOpt ) const;
 106     bool                    operator!= ( const ScViewOptions& rOpt ) const { return !(operator==(rOpt)); }
 107
 108 private:
 109     bool            aOptArr     [MAX_OPT];
 110     ScVObjMode      aModeArr    [MAX_TYPE];
 111     Color           aGridCol;
 112     OUString        aGridColName;
 113     ScGridOptions   aGridOpt;
 114     // The name of the color scheme
 115     OUString sColorSchemeName = "Default";
 116     // The background color of the document
 117     Color aDocCol;
 118 };
 119
 120 // Item for the options dialog - View
 121
 122 class SC_DLLPUBLIC ScTpViewItem final : public SfxPoolItem
 123 {
 124 public:
 125                 ScTpViewItem( const ScViewOptions& rOpt );
 126                 virtual ~ScTpViewItem() override;
 127
 128     ScTpViewItem(ScTpViewItem const &) = default;
 129     ScTpViewItem(ScTpViewItem &&) = default;
 130     ScTpViewItem & operator =(ScTpViewItem const &) = delete; // due to SfxPoolItem
 131     ScTpViewItem & operator =(ScTpViewItem &&) = delete; // due to SfxPoolItem
 132
 133     virtual bool            operator==( const SfxPoolItem& ) const override;
 134     virtual ScTpViewItem*   Clone( SfxItemPool *pPool = nullptr ) const override;
 135
 136     const ScViewOptions&    GetViewOptions() const { return theOptions; }
 137
 138 private:
 139     ScViewOptions   theOptions;
 140 };
 141
 142 // CfgItem for View options
 143
 144 class ScViewCfg : public ScViewOptions
 145 {
 146     ScLinkConfigItem    aLayoutItem;
 147     ScLinkConfigItem    aDisplayItem;
 148     ScLinkConfigItem    aGridItem;
 149
 150     DECL_LINK( LayoutCommitHdl, ScLinkConfigItem&, void );
 151     DECL_LINK( DisplayCommitHdl, ScLinkConfigItem&, void );
 152     DECL_LINK( GridCommitHdl, ScLinkConfigItem&, void );
 153
 154     static css::uno::Sequence<OUString> GetLayoutPropertyNames();
 155     static css::uno::Sequence<OUString> GetDisplayPropertyNames();
 156     static css::uno::Sequence<OUString> GetGridPropertyNames();
 157
 158 public:
 159             ScViewCfg();
 160
 161     void            SetOptions( const ScViewOptions& rNew );
 162 };
 163
 164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */