unotools/source/config/printwarningoptions.cxx

   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 #include <unotools/printwarningoptions.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <tools/debug.hxx>
  23 #include <com/sun/star/uno/Any.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25
  26 #include "itemholder1.hxx"
  27
  28 //  namespaces
  29
  30 using namespace ::utl;
  31 using namespace ::osl;
  32 using namespace ::com::sun::star::uno;
  33
  34 #define ROOTNODE_START                  "Office.Common/Print"
  35
  36 #define PROPERTYNAME_PAPERSIZE          OUString("Warning/PaperSize")
  37 #define PROPERTYNAME_PAPERORIENTATION   OUString("Warning/PaperOrientation")
  38 #define PROPERTYNAME_NOTFOUND           OUString("Warning/NotFound")
  39 #define PROPERTYNAME_TRANSPARENCY       OUString("Warning/Transparency")
  40 #define PROPERTYNAME_PRINTINGMODIFIESDOCUMENT  OUString("PrintingModifiesDocument")
  41
  42 #define PROPERTYHANDLE_PAPERSIZE        0
  43 #define PROPERTYHANDLE_PAPERORIENTATION 1
  44 #define PROPERTYHANDLE_NOTFOUND         2
  45 #define PROPERTYHANDLE_TRANSPARENCY     3
  46 #define PROPERTYHDL_PRINTINGMODIFIESDOCUMENT            4
  47
  48 #define PROPERTYCOUNT                   5
  49
  50 class SvtPrintWarningOptions_Impl : public ConfigItem
  51 {
  52 public:
  53
  54 //  constructor / destructor
  55
  56      SvtPrintWarningOptions_Impl();
  57     virtual ~SvtPrintWarningOptions_Impl() override;
  58
  59 //  override methods of baseclass
  60
  61     virtual void    Notify( const css::uno::Sequence< OUString >& aPropertyNames ) override;
  62
  63 //  public interface
  64
  65     bool    IsPaperSize() const { return m_bPaperSize; }
  66     bool    IsPaperOrientation() const { return m_bPaperOrientation; }
  67     bool    IsTransparency() const { return m_bTransparency; }
  68     bool    IsModifyDocumentOnPrintingAllowed() const { return m_bModifyDocumentOnPrintingAllowed; }
  69
  70     void        SetPaperSize( bool bState ) { m_bPaperSize = bState; SetModified(); }
  71     void        SetPaperOrientation( bool bState ) { m_bPaperOrientation = bState; SetModified(); }
  72     void        SetTransparency( bool bState ) { m_bTransparency = bState; SetModified(); }
  73     void        SetModifyDocumentOnPrintingAllowed( bool bState ) { m_bModifyDocumentOnPrintingAllowed = bState; SetModified(); }
  74
  75 //  private methods
  76
  77 private:
  78
  79     virtual void ImplCommit() override;
  80
  81     static Sequence< OUString > impl_GetPropertyNames();
  82
  83 //  private member
  84
  85 private:
  86
  87     bool    m_bPaperSize;
  88     bool    m_bPaperOrientation;
  89     bool    m_bNotFound;
  90     bool    m_bTransparency;
  91     bool    m_bModifyDocumentOnPrintingAllowed;
  92 };
  93
  94 //  constructor
  95
  96 SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl() :
  97     ConfigItem( ROOTNODE_START  ),
  98     m_bPaperSize( false ),
  99     m_bPaperOrientation( false ),
 100     m_bNotFound( false ),
 101     m_bTransparency( true ),
 102     m_bModifyDocumentOnPrintingAllowed( true )
 103 {
 104     Sequence< OUString >    seqNames( impl_GetPropertyNames() );
 105     Sequence< Any >         seqValues( GetProperties( seqNames ) );
 106
 107     DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl()\nI miss some values of configuration keys!\n" );
 108
 109     // Copy values from list in right order to our internal member.
 110     sal_Int32 nPropertyCount = seqValues.getLength();
 111     sal_Int32 nProperty = 0;
 112
 113     for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
 114     {
 115         DBG_ASSERT( seqValues[nProperty].hasValue(), "SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl()\nInvalid property value for property detected!\n" );
 116
 117         switch( nProperty )
 118         {
 119             case PROPERTYHANDLE_PAPERSIZE:
 120             {
 121                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 122                 seqValues[nProperty] >>= m_bPaperSize;
 123             }
 124             break;
 125
 126             case PROPERTYHANDLE_PAPERORIENTATION:
 127             {
 128                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 129                 seqValues[nProperty] >>= m_bPaperOrientation;
 130             }
 131             break;
 132
 133             case PROPERTYHANDLE_NOTFOUND:
 134             {
 135                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 136                 seqValues[nProperty] >>= m_bNotFound;
 137             }
 138             break;
 139
 140             case PROPERTYHANDLE_TRANSPARENCY:
 141             {
 142                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 143                 seqValues[nProperty] >>= m_bTransparency;
 144             }
 145             break;
 146             case PROPERTYHDL_PRINTINGMODIFIESDOCUMENT:
 147             {
 148                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 149                 seqValues[nProperty] >>= m_bModifyDocumentOnPrintingAllowed;
 150             }
 151             break;
 152
 153         }
 154     }
 155 }
 156
 157 //  destructor
 158
 159 SvtPrintWarningOptions_Impl::~SvtPrintWarningOptions_Impl()
 160 {
 161     assert(!IsModified()); // should have been committed
 162 }
 163
 164 //  Commit
 165
 166 void SvtPrintWarningOptions_Impl::ImplCommit()
 167 {
 168     Sequence< OUString >    aSeqNames( impl_GetPropertyNames() );
 169     Sequence< Any >         aSeqValues( aSeqNames.getLength() );
 170
 171     for( sal_Int32 nProperty = 0, nCount = aSeqNames.getLength(); nProperty < nCount; ++nProperty )
 172     {
 173         switch( nProperty )
 174         {
 175             case PROPERTYHANDLE_PAPERSIZE:
 176                 aSeqValues[nProperty] <<= m_bPaperSize;
 177             break;
 178
 179             case PROPERTYHANDLE_PAPERORIENTATION:
 180                 aSeqValues[nProperty] <<= m_bPaperOrientation;
 181             break;
 182
 183             case PROPERTYHANDLE_NOTFOUND:
 184                 aSeqValues[nProperty] <<= m_bNotFound;
 185             break;
 186
 187             case PROPERTYHANDLE_TRANSPARENCY:
 188                 aSeqValues[nProperty] <<= m_bTransparency;
 189             break;
 190             case PROPERTYHDL_PRINTINGMODIFIESDOCUMENT:
 191                 aSeqValues[nProperty] <<= m_bModifyDocumentOnPrintingAllowed;
 192             break;
 193         }
 194     }
 195
 196     PutProperties( aSeqNames, aSeqValues );
 197 }
 198
 199 void SvtPrintWarningOptions_Impl::Notify( const Sequence< OUString >&  )
 200 {
 201 }
 202
 203 //  private method
 204
 205 Sequence< OUString > SvtPrintWarningOptions_Impl::impl_GetPropertyNames()
 206 {
 207     // Build list of configuration key names.
 208     const OUString pProperties[] =
 209     {
 210         PROPERTYNAME_PAPERSIZE,
 211         PROPERTYNAME_PAPERORIENTATION,
 212         PROPERTYNAME_NOTFOUND,
 213         PROPERTYNAME_TRANSPARENCY,
 214         PROPERTYNAME_PRINTINGMODIFIESDOCUMENT
 215     };
 216
 217     // Initialize return sequence with these list ...
 218     const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
 219
 220     return seqPropertyNames;
 221 }
 222
 223 static std::weak_ptr<SvtPrintWarningOptions_Impl> g_pPrintWarningOptions;
 224
 225 SvtPrintWarningOptions::SvtPrintWarningOptions()
 226 {
 227     // Global access, must be guarded (multithreading!).
 228     MutexGuard aGuard( GetOwnStaticMutex() );
 229
 230     m_pImpl = g_pPrintWarningOptions.lock();
 231     if( !m_pImpl )
 232     {
 233         m_pImpl = std::make_shared<SvtPrintWarningOptions_Impl>();
 234         g_pPrintWarningOptions = m_pImpl;
 235         ItemHolder1::holdConfigItem(EItem::PrintWarningOptions);
 236     }
 237 }
 238
 239 SvtPrintWarningOptions::~SvtPrintWarningOptions()
 240 {
 241     // Global access, must be guarded (multithreading!)
 242     MutexGuard aGuard( GetOwnStaticMutex() );
 243
 244     m_pImpl.reset();
 245 }
 246
 247 //  public method
 248
 249 bool SvtPrintWarningOptions::IsPaperSize() const
 250 {
 251     MutexGuard aGuard( GetOwnStaticMutex() );
 252     return m_pImpl->IsPaperSize();
 253 }
 254
 255 //  public method
 256
 257 bool SvtPrintWarningOptions::IsPaperOrientation() const
 258 {
 259     MutexGuard aGuard( GetOwnStaticMutex() );
 260     return m_pImpl->IsPaperOrientation();
 261 }
 262
 263 //  public method
 264
 265 bool SvtPrintWarningOptions::IsTransparency() const
 266 {
 267     MutexGuard aGuard( GetOwnStaticMutex() );
 268     return m_pImpl->IsTransparency();
 269 }
 270
 271 //  public method
 272
 273 void SvtPrintWarningOptions::SetPaperSize( bool bState )
 274 {
 275     MutexGuard aGuard( GetOwnStaticMutex() );
 276     m_pImpl->SetPaperSize( bState );
 277 }
 278
 279 //  public method
 280
 281 void SvtPrintWarningOptions::SetPaperOrientation( bool bState )
 282 {
 283     MutexGuard aGuard( GetOwnStaticMutex() );
 284     m_pImpl->SetPaperOrientation( bState );
 285 }
 286
 287 //  public method
 288
 289 void SvtPrintWarningOptions::SetTransparency( bool bState )
 290 {
 291     MutexGuard aGuard( GetOwnStaticMutex() );
 292     m_pImpl->SetTransparency( bState );
 293 }
 294
 295 bool SvtPrintWarningOptions::IsModifyDocumentOnPrintingAllowed() const
 296 {
 297     MutexGuard aGuard( GetOwnStaticMutex() );
 298     return m_pImpl->IsModifyDocumentOnPrintingAllowed();
 299 }
 300
 301 void SvtPrintWarningOptions::SetModifyDocumentOnPrintingAllowed( bool bState )
 302 {
 303     MutexGuard aGuard( GetOwnStaticMutex() );
 304     m_pImpl->SetModifyDocumentOnPrintingAllowed( bState );
 305 }
 306
 307 namespace
 308 {
 309     class thePrintWarningOptionsMutex : public rtl::Static<osl::Mutex, thePrintWarningOptionsMutex>{};
 310 }
 311
 312 //  private method
 313
 314 Mutex& SvtPrintWarningOptions::GetOwnStaticMutex()
 315 {
 316     return thePrintWarningOptionsMutex::get();
 317 }
 318
 319 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */