svtools/inc/extcolorcfg.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: extcolorcfg.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef INCLUDED_SVTOOLS_EXTCOLORCFG_HXX
  31 #define INCLUDED_SVTOOLS_EXTCOLORCFG_HXX
  32
  33 #include "svtools/svtdllapi.h"
  34 #include <rtl/ustring.hxx>
  35 #include <tools/color.hxx>
  36 #include <com/sun/star/uno/Sequence.h>
  37 #include <svtools/brdcst.hxx>
  38 #include <svtools/lstner.hxx>
  39
  40 //-----------------------------------------------------------------------------
  41 namespace svtools{
  42 /* -----------------------------22.03.2002 15:36------------------------------
  43
  44  ---------------------------------------------------------------------------*/
  45 class ExtendedColorConfig_Impl;
  46 class ExtendedColorConfigValue
  47 {
  48     ::rtl::OUString m_sName;
  49     ::rtl::OUString m_sDisplayName;
  50     sal_Int32           m_nColor;
  51     sal_Int32           m_nDefaultColor;
  52 public:
  53     ExtendedColorConfigValue() : m_nColor(0),m_nDefaultColor(0){}
  54     ExtendedColorConfigValue(const ::rtl::OUString& _sName
  55                             ,const ::rtl::OUString& _sDisplayName
  56                             ,sal_Int32          _nColor
  57                             ,sal_Int32          _nDefaultColor)
  58     : m_sName(_sName)
  59     ,m_sDisplayName(_sDisplayName)
  60     ,m_nColor(_nColor)
  61     ,m_nDefaultColor(_nDefaultColor)
  62     {}
  63
  64     inline ::rtl::OUString getName()         const { return m_sName; }
  65     inline ::rtl::OUString getDisplayName()  const { return m_sDisplayName; }
  66     inline sal_Int32       getColor()        const { return m_nColor; }
  67     inline sal_Int32       getDefaultColor() const { return m_nDefaultColor; }
  68
  69     inline void setColor(sal_Int32 _nColor) { m_nColor = _nColor; }
  70
  71     sal_Bool operator !=(const ExtendedColorConfigValue& rCmp) const
  72         { return m_nColor != rCmp.m_nColor;}
  73 };
  74 /* -----------------------------22.03.2002 15:36------------------------------
  75
  76  ---------------------------------------------------------------------------*/
  77 class SVT_DLLPUBLIC ExtendedColorConfig : public SfxBroadcaster, public SfxListener
  78 {
  79     friend class ExtendedColorConfig_Impl;
  80 private:
  81     static ExtendedColorConfig_Impl* m_pImpl;
  82 public:
  83     ExtendedColorConfig();
  84     ~ExtendedColorConfig();
  85
  86     virtual void        Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
  87
  88     // get the configured value
  89     ExtendedColorConfigValue        GetColorValue(const ::rtl::OUString& _sComponentName,const ::rtl::OUString& _sName)const;
  90     sal_Int32                                           GetComponentCount() const;
  91     ::rtl::OUString                                     GetComponentName(sal_uInt32 _nPos) const;
  92     ::rtl::OUString                                     GetComponentDisplayName(const ::rtl::OUString& _sComponentName) const;
  93     sal_Int32                                           GetComponentColorCount(const ::rtl::OUString& _sName) const;
  94     ExtendedColorConfigValue            GetComponentColorConfigValue(const ::rtl::OUString& _sComponentName,sal_uInt32 _nPos) const;
  95 };
  96 /* -----------------------------22.03.2002 15:31------------------------------
  97
  98  ---------------------------------------------------------------------------*/
  99 class SVT_DLLPUBLIC EditableExtendedColorConfig
 100 {
 101     ExtendedColorConfig_Impl*   m_pImpl;
 102     sal_Bool            m_bModified;
 103 public:
 104     EditableExtendedColorConfig();
 105     ~EditableExtendedColorConfig();
 106
 107     ::com::sun::star::uno::Sequence< ::rtl::OUString >  GetSchemeNames() const;
 108     void                                                DeleteScheme(const ::rtl::OUString& rScheme );
 109     void                                                AddScheme(const ::rtl::OUString& rScheme );
 110     sal_Bool                                            LoadScheme(const ::rtl::OUString& rScheme );
 111     const ::rtl::OUString&                              GetCurrentSchemeName()const;
 112     void                        SetCurrentSchemeName(const ::rtl::OUString& rScheme);
 113
 114     ExtendedColorConfigValue    GetColorValue(const ::rtl::OUString& _sComponentName,const ::rtl::OUString& _sName)const;
 115     sal_Int32                                   GetComponentCount() const;
 116     ::rtl::OUString                             GetComponentName(sal_uInt32 _nPos) const;
 117     ::rtl::OUString                             GetComponentDisplayName(const ::rtl::OUString& _sComponentName) const;
 118     sal_Int32                                   GetComponentColorCount(const ::rtl::OUString& _sName) const;
 119     ExtendedColorConfigValue    GetComponentColorConfigValue(const ::rtl::OUString& _sName,sal_uInt32 _nPos) const;
 120     void                        SetColorValue(const ::rtl::OUString& _sComponentName, const ExtendedColorConfigValue& rValue);
 121     void                        SetModified();
 122     void                        ClearModified(){m_bModified = sal_False;}
 123     sal_Bool                    IsModified()const{return m_bModified;}
 124     void                        Commit();
 125
 126     void                                                DisableBroadcast();
 127     void                                                EnableBroadcast();
 128 };
 129 }//namespace svtools
 130 #endif
 131