svtools/source/config/printwarningoptions.cxx

   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: printwarningoptions.cxx,v $
  10  * $Revision: 1.8 $
  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
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svtools.hxx"
  33 #ifndef GCC
  34 #endif
  35
  36 //_________________________________________________________________________________________________________________
  37 //      includes
  38 //_________________________________________________________________________________________________________________
  39
  40 #include <svtools/printwarningoptions.hxx>
  41 #include <unotools/configmgr.hxx>
  42 #include <unotools/configitem.hxx>
  43 #include <tools/debug.hxx>
  44 #include <com/sun/star/uno/Any.hxx>
  45 #include <com/sun/star/uno/Sequence.hxx>
  46
  47 #include <itemholder1.hxx>
  48
  49 //_________________________________________________________________________________________________________________
  50 //      namespaces
  51 //_________________________________________________________________________________________________________________
  52
  53 using namespace ::utl                                   ;
  54 using namespace ::rtl                                   ;
  55 using namespace ::osl                                   ;
  56 using namespace ::com::sun::star::uno   ;
  57
  58 //_________________________________________________________________________________________________________________
  59 //      const
  60 //_________________________________________________________________________________________________________________
  61
  62 #define ROOTNODE_START                  OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/Print"))
  63
  64 #define PROPERTYNAME_PAPERSIZE          OUString(RTL_CONSTASCII_USTRINGPARAM("Warning/PaperSize"))
  65 #define PROPERTYNAME_PAPERORIENTATION   OUString(RTL_CONSTASCII_USTRINGPARAM("Warning/PaperOrientation"))
  66 #define PROPERTYNAME_NOTFOUND           OUString(RTL_CONSTASCII_USTRINGPARAM("Warning/NotFound"))
  67 #define PROPERTYNAME_TRANSPARENCY       OUString(RTL_CONSTASCII_USTRINGPARAM("Warning/Transparency"))
  68 #define PROPERTYNAME_PRINTINGMODIFIESDOCUMENT  OUString(RTL_CONSTASCII_USTRINGPARAM("PrintingModifiesDocument"))
  69
  70 #define PROPERTYHANDLE_PAPERSIZE                0
  71 #define PROPERTYHANDLE_PAPERORIENTATION 1
  72 #define PROPERTYHANDLE_NOTFOUND         2
  73 #define PROPERTYHANDLE_TRANSPARENCY     3
  74 #define PROPERTYHDL_PRINTINGMODIFIESDOCUMENT            4
  75
  76 #define PROPERTYCOUNT                   5
  77
  78 class SvtPrintWarningOptions_Impl : public ConfigItem
  79 {
  80 public:
  81
  82 //---------------------------------------------------------------------------------------------------------
  83 //      constructor / destructor
  84 //---------------------------------------------------------------------------------------------------------
  85
  86      SvtPrintWarningOptions_Impl();
  87     ~SvtPrintWarningOptions_Impl();
  88
  89 //---------------------------------------------------------------------------------------------------------
  90 //      overloaded methods of baseclass
  91 //---------------------------------------------------------------------------------------------------------
  92
  93     virtual void Commit();
  94
  95 //---------------------------------------------------------------------------------------------------------
  96 //      public interface
  97 //---------------------------------------------------------------------------------------------------------
  98
  99     sal_Bool    IsPaperSize() const { return m_bPaperSize; }
 100     sal_Bool    IsPaperOrientation() const { return m_bPaperOrientation; }
 101     sal_Bool    IsNotFound() const { return m_bNotFound; }
 102     sal_Bool    IsTransparency() const { return m_bTransparency; }
 103     sal_Bool    IsModifyDocumentOnPrintingAllowed() const { return m_bModifyDocumentOnPrintingAllowed; }
 104
 105     void                SetPaperSize( sal_Bool bState ) { m_bPaperSize = bState; SetModified(); }
 106     void                SetPaperOrientation( sal_Bool bState ) { m_bPaperOrientation = bState; SetModified(); }
 107     void                SetNotFound( sal_Bool bState ) { m_bNotFound = bState; SetModified(); }
 108     void                SetTransparency( sal_Bool bState ) { m_bTransparency = bState; SetModified(); }
 109     void        SetModifyDocumentOnPrintingAllowed( sal_Bool bState ) { m_bModifyDocumentOnPrintingAllowed = bState; SetModified(); }
 110
 111 //-------------------------------------------------------------------------------------------------------------
 112 //      private methods
 113 //-------------------------------------------------------------------------------------------------------------
 114
 115 private:
 116
 117     static Sequence< OUString > impl_GetPropertyNames();
 118
 119 //-------------------------------------------------------------------------------------------------------------
 120 //      private member
 121 //-------------------------------------------------------------------------------------------------------------
 122
 123 private:
 124
 125     sal_Bool    m_bPaperSize;
 126     sal_Bool    m_bPaperOrientation;
 127     sal_Bool    m_bNotFound;
 128     sal_Bool    m_bTransparency;
 129     sal_Bool    m_bModifyDocumentOnPrintingAllowed;
 130 };
 131
 132 //_________________________________________________________________________________________________________________
 133 //      definitions
 134 //_________________________________________________________________________________________________________________
 135
 136 //*****************************************************************************************************************
 137 //      constructor
 138 //*****************************************************************************************************************
 139 SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl() :
 140     ConfigItem( ROOTNODE_START  ),
 141     m_bPaperSize( sal_False ),
 142     m_bPaperOrientation( sal_False ),
 143     m_bNotFound( sal_False ),
 144     m_bTransparency( sal_True ),
 145     m_bModifyDocumentOnPrintingAllowed( sal_True )
 146 {
 147     Sequence< OUString >        seqNames( impl_GetPropertyNames() );
 148     Sequence< Any >                     seqValues( GetProperties( seqNames ) );
 149
 150     DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl()\nI miss some values of configuration keys!\n" );
 151
 152     // Copy values from list in right order to our internal member.
 153     sal_Int32 nPropertyCount = seqValues.getLength();
 154     sal_Int32 nProperty = 0;
 155
 156     for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
 157     {
 158         DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtPrintWarningOptions_Impl::SvtPrintWarningOptions_Impl()\nInvalid property value for property detected!\n" );
 159
 160         switch( nProperty )
 161         {
 162             case PROPERTYHANDLE_PAPERSIZE:
 163             {
 164                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 165                 seqValues[nProperty] >>= m_bPaperSize;
 166             }
 167             break;
 168
 169             case PROPERTYHANDLE_PAPERORIENTATION:
 170             {
 171                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 172                 seqValues[nProperty] >>= m_bPaperOrientation;
 173             }
 174             break;
 175
 176             case PROPERTYHANDLE_NOTFOUND:
 177             {
 178                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 179                 seqValues[nProperty] >>= m_bNotFound;
 180             }
 181             break;
 182
 183             case PROPERTYHANDLE_TRANSPARENCY:
 184             {
 185                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 186                 seqValues[nProperty] >>= m_bTransparency;
 187             }
 188             break;
 189             case PROPERTYHDL_PRINTINGMODIFIESDOCUMENT:
 190             {
 191                 DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "Invalid type" );
 192                 seqValues[nProperty] >>= m_bModifyDocumentOnPrintingAllowed;
 193             }
 194             break;
 195
 196         }
 197     }
 198 }
 199
 200 //*****************************************************************************************************************
 201 //      destructor
 202 //*****************************************************************************************************************
 203 SvtPrintWarningOptions_Impl::~SvtPrintWarningOptions_Impl()
 204 {
 205     if( IsModified() )
 206         Commit();
 207 }
 208
 209 //*****************************************************************************************************************
 210 //      Commit
 211 //*****************************************************************************************************************
 212 void SvtPrintWarningOptions_Impl::Commit()
 213 {
 214     Sequence< OUString >        aSeqNames( impl_GetPropertyNames() );
 215     Sequence< Any >                     aSeqValues( aSeqNames.getLength() );
 216
 217     for( sal_Int32 nProperty = 0, nCount = aSeqNames.getLength(); nProperty < nCount; ++nProperty )
 218     {
 219         switch( nProperty )
 220         {
 221             case PROPERTYHANDLE_PAPERSIZE:
 222                 aSeqValues[nProperty] <<= m_bPaperSize;
 223             break;
 224
 225             case PROPERTYHANDLE_PAPERORIENTATION:
 226                 aSeqValues[nProperty] <<= m_bPaperOrientation;
 227             break;
 228
 229             case PROPERTYHANDLE_NOTFOUND:
 230                 aSeqValues[nProperty] <<= m_bNotFound;
 231             break;
 232
 233             case PROPERTYHANDLE_TRANSPARENCY:
 234                 aSeqValues[nProperty] <<= m_bTransparency;
 235             break;
 236             case PROPERTYHDL_PRINTINGMODIFIESDOCUMENT:
 237                 aSeqValues[nProperty] <<= m_bModifyDocumentOnPrintingAllowed;
 238             break;
 239         }
 240     }
 241
 242     PutProperties( aSeqNames, aSeqValues );
 243 }
 244
 245 //*****************************************************************************************************************
 246 //      private method
 247 //*****************************************************************************************************************
 248 Sequence< OUString > SvtPrintWarningOptions_Impl::impl_GetPropertyNames()
 249 {
 250     // Build static list of configuration key names.
 251     static const OUString pProperties[] =
 252     {
 253         PROPERTYNAME_PAPERSIZE,
 254         PROPERTYNAME_PAPERORIENTATION,
 255         PROPERTYNAME_NOTFOUND,
 256         PROPERTYNAME_TRANSPARENCY,
 257         PROPERTYNAME_PRINTINGMODIFIESDOCUMENT
 258     };
 259
 260     // Initialize return sequence with these list ...
 261     static const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
 262
 263     return seqPropertyNames;
 264 }
 265
 266 //*****************************************************************************************************************
 267 //      initialize static member
 268 //      DON'T DO IT IN YOUR HEADER!
 269 //      see definition for further informations
 270 //*****************************************************************************************************************
 271 SvtPrintWarningOptions_Impl*    SvtPrintWarningOptions::m_pDataContainer = NULL;
 272 sal_Int32                                       SvtPrintWarningOptions::m_nRefCount = 0;
 273
 274 //*****************************************************************************************************************
 275 //      constructor
 276 //*****************************************************************************************************************
 277 SvtPrintWarningOptions::SvtPrintWarningOptions()
 278 {
 279     // Global access, must be guarded (multithreading!).
 280     MutexGuard aGuard( GetOwnStaticMutex() );
 281     // Increase ouer refcount ...
 282     ++m_nRefCount;
 283     // ... and initialize ouer data container only if it not already!
 284     if( m_pDataContainer == NULL )
 285     {
 286         m_pDataContainer = new SvtPrintWarningOptions_Impl();
 287         ItemHolder1::holdConfigItem(E_PRINTWARNINGOPTIONS);
 288     }
 289 }
 290
 291 //*****************************************************************************************************************
 292 //      destructor
 293 //*****************************************************************************************************************
 294 SvtPrintWarningOptions::~SvtPrintWarningOptions()
 295 {
 296     // Global access, must be guarded (multithreading!)
 297     MutexGuard aGuard( GetOwnStaticMutex() );
 298     // Decrease ouer refcount.
 299     --m_nRefCount;
 300     // If last instance was deleted ...
 301     // we must destroy ouer static data container!
 302     if( m_nRefCount <= 0 )
 303     {
 304         delete m_pDataContainer;
 305         m_pDataContainer = NULL;
 306     }
 307 }
 308
 309 //*****************************************************************************************************************
 310 //      public method
 311 //*****************************************************************************************************************
 312 sal_Bool SvtPrintWarningOptions::IsPaperSize() const
 313 {
 314     MutexGuard aGuard( GetOwnStaticMutex() );
 315     return m_pDataContainer->IsPaperSize();
 316 }
 317
 318 //*****************************************************************************************************************
 319 //      public method
 320 //*****************************************************************************************************************
 321 sal_Bool SvtPrintWarningOptions::IsPaperOrientation() const
 322 {
 323     MutexGuard aGuard( GetOwnStaticMutex() );
 324     return m_pDataContainer->IsPaperOrientation();
 325 }
 326
 327 //*****************************************************************************************************************
 328 //      public method
 329 //*****************************************************************************************************************
 330 sal_Bool SvtPrintWarningOptions::IsNotFound() const
 331 {
 332     MutexGuard aGuard( GetOwnStaticMutex() );
 333     return m_pDataContainer->IsNotFound();
 334 }
 335
 336 //*****************************************************************************************************************
 337 //      public method
 338 //*****************************************************************************************************************
 339 sal_Bool SvtPrintWarningOptions::IsTransparency() const
 340 {
 341     MutexGuard aGuard( GetOwnStaticMutex() );
 342     return m_pDataContainer->IsTransparency();
 343 }
 344
 345 //*****************************************************************************************************************
 346 //      public method
 347 //*****************************************************************************************************************
 348 void SvtPrintWarningOptions::SetPaperSize( sal_Bool bState )
 349 {
 350     MutexGuard aGuard( GetOwnStaticMutex() );
 351     m_pDataContainer->SetPaperSize( bState );
 352 }
 353
 354 //*****************************************************************************************************************
 355 //      public method
 356 //*****************************************************************************************************************
 357 void SvtPrintWarningOptions::SetPaperOrientation( sal_Bool bState )
 358 {
 359     MutexGuard aGuard( GetOwnStaticMutex() );
 360     m_pDataContainer->SetPaperOrientation( bState );
 361 }
 362
 363 //*****************************************************************************************************************
 364 //      public method
 365 //*****************************************************************************************************************
 366 void SvtPrintWarningOptions::SetNotFound( sal_Bool bState )
 367 {
 368     MutexGuard aGuard( GetOwnStaticMutex() );
 369     m_pDataContainer->SetNotFound( bState );
 370 }
 371
 372 //*****************************************************************************************************************
 373 //      public method
 374 //*****************************************************************************************************************
 375 void SvtPrintWarningOptions::SetTransparency( sal_Bool bState )
 376 {
 377     MutexGuard aGuard( GetOwnStaticMutex() );
 378     m_pDataContainer->SetTransparency( bState );
 379 }
 380 // -----------------------------------------------------------------------------
 381
 382 sal_Bool SvtPrintWarningOptions::IsModifyDocumentOnPrintingAllowed() const
 383 {
 384     MutexGuard aGuard( GetOwnStaticMutex() );
 385     return m_pDataContainer->IsModifyDocumentOnPrintingAllowed();
 386 }
 387
 388 // -----------------------------------------------------------------------------
 389
 390 void SvtPrintWarningOptions::SetModifyDocumentOnPrintingAllowed( sal_Bool bState )
 391 {
 392     MutexGuard aGuard( GetOwnStaticMutex() );
 393     m_pDataContainer->SetModifyDocumentOnPrintingAllowed( bState ) ;
 394 }
 395
 396 //*****************************************************************************************************************
 397 //      private method
 398 //*****************************************************************************************************************
 399 Mutex& SvtPrintWarningOptions::GetOwnStaticMutex()
 400 {
 401     // Initialize static mutex only for one time!
 402     static Mutex* pMutex = NULL;
 403     // If these method first called (Mutex not already exist!) ...
 404     if( pMutex == NULL )
 405     {
 406         // ... we must create a new one. Protect follow code with the global mutex -
 407         // It must be - we create a static variable!
 408         MutexGuard aGuard( Mutex::getGlobalMutex() );
 409         // We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
 410         if( pMutex == NULL )
 411         {
 412             // Create the new mutex and set it for return on static variable.
 413             static Mutex aMutex;
 414             pMutex = &aMutex;
 415         }
 416     }
 417     // Return new created or already existing mutex object.
 418     return *pMutex;
 419 }