include/svtools/colorcfg.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 #ifndef INCLUDED_SVTOOLS_COLORCFG_HXX
  20 #define INCLUDED_SVTOOLS_COLORCFG_HXX
  21
  22 #include <svtools/svtdllapi.h>
  23 #include <rtl/ustring.hxx>
  24 #include <tools/color.hxx>
  25 #include <com/sun/star/uno/Sequence.h>
  26 #include <unotools/options.hxx>
  27 #include <memory>
  28
  29
  30 namespace svtools{
  31 enum ColorConfigEntry
  32 {
  33     DOCCOLOR            ,
  34     DOCBOUNDARIES       ,
  35     APPBACKGROUND       ,
  36     OBJECTBOUNDARIES    ,
  37     TABLEBOUNDARIES     ,
  38     FONTCOLOR           ,
  39     LINKS               ,
  40     LINKSVISITED        ,
  41     SPELL         ,
  42     SMARTTAGS     ,
  43     SHADOWCOLOR         ,
  44     WRITERTEXTGRID      ,
  45     WRITERFIELDSHADINGS ,
  46     WRITERIDXSHADINGS         ,
  47     WRITERDIRECTCURSOR        ,
  48     WRITERSCRIPTINDICATOR,
  49     WRITERSECTIONBOUNDARIES,
  50     WRITERHEADERFOOTERMARK,
  51     WRITERPAGEBREAKS,
  52     HTMLSGML            ,
  53     HTMLCOMMENT         ,
  54     HTMLKEYWORD         ,
  55     HTMLUNKNOWN         ,
  56     CALCGRID            ,
  57     CALCPAGEBREAK       ,
  58     CALCPAGEBREAKMANUAL,
  59     CALCPAGEBREAKAUTOMATIC,
  60     CALCDETECTIVE       ,
  61     CALCDETECTIVEERROR       ,
  62     CALCREFERENCE       ,
  63     CALCNOTESBACKGROUND     ,
  64     DRAWGRID            ,
  65     BASICIDENTIFIER,
  66     BASICCOMMENT   ,
  67     BASICNUMBER    ,
  68     BASICSTRING    ,
  69     BASICOPERATOR  ,
  70     BASICKEYWORD   ,
  71     BASICERROR   ,
  72     SQLIDENTIFIER,
  73     SQLNUMBER,
  74     SQLSTRING,
  75     SQLOPERATOR,
  76     SQLKEYWORD,
  77     SQLPARAMETER,
  78     SQLCOMMENT,
  79     ColorConfigEntryCount
  80 };
  81
  82 class ColorConfig_Impl;
  83 struct ColorConfigValue
  84 {
  85
  86     bool        bIsVisible; //validity depends on the element type
  87     sal_Int32   nColor;
  88     ColorConfigValue() : bIsVisible(false), nColor(0) {}
  89     bool operator !=(const ColorConfigValue& rCmp) const
  90         { return nColor != rCmp.nColor || bIsVisible != rCmp.bIsVisible;}
  91 };
  92
  93 class SVT_DLLPUBLIC ColorConfig:
  94     public utl::detail::Options
  95 {
  96     friend class ColorConfig_Impl;
  97 private:
  98     static ColorConfig_Impl* m_pImpl;
  99 public:
 100     ColorConfig();
 101     virtual ~ColorConfig() override;
 102
 103     // get the configured value - if bSmart is set the default color setting is provided
 104     // instead of the automatic color
 105     ColorConfigValue        GetColorValue(ColorConfigEntry eEntry, bool bSmart = true) const;
 106     static Color            GetDefaultColor(ColorConfigEntry eEntry);
 107 };
 108
 109 class SVT_DLLPUBLIC EditableColorConfig
 110 {
 111     std::unique_ptr<ColorConfig_Impl> m_pImpl;
 112     bool                m_bModified;
 113 public:
 114     EditableColorConfig();
 115     ~EditableColorConfig();
 116
 117     css::uno::Sequence< OUString >  GetSchemeNames() const;
 118     void                        DeleteScheme(const OUString& rScheme );
 119     void                        AddScheme(const OUString& rScheme );
 120     bool                        LoadScheme(const OUString& rScheme );
 121     const OUString&             GetCurrentSchemeName() const;
 122     void                        SetCurrentSchemeName(const OUString& rScheme);
 123
 124     const ColorConfigValue&     GetColorValue(ColorConfigEntry eEntry) const;
 125     void                        SetColorValue(ColorConfigEntry eEntry, const ColorConfigValue& rValue);
 126     void                        SetModified();
 127     void                        ClearModified() {m_bModified = false;}
 128     bool                        IsModified() const {return m_bModified;}
 129     void                        Commit();
 130
 131     void                        DisableBroadcast();
 132     void                        EnableBroadcast();
 133 };
 134 }//namespace svtools
 135 #endif
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */