378 lines
17 KiB
C++
378 lines
17 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2000, 2010 Oracle and/or its affiliates.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
// MARKER(update_precomp.py): autogen include statement, do not remove
|
|
#include "precompiled_unotools.hxx"
|
|
|
|
#include <unotools/workingsetoptions.hxx>
|
|
#include <unotools/configmgr.hxx>
|
|
#include <unotools/configitem.hxx>
|
|
#include <tools/debug.hxx>
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
|
|
#include <itemholder1.hxx>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// namespaces
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
using namespace ::utl ;
|
|
using namespace ::rtl ;
|
|
using namespace ::osl ;
|
|
using namespace ::com::sun::star::uno ;
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// const
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#define ROOTNODE_WORKINGSET OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/WorkingSet"))
|
|
#define DEFAULT_WINDOWLIST Sequence< OUString >()
|
|
|
|
#define PROPERTYNAME_WINDOWLIST OUString(RTL_CONSTASCII_USTRINGPARAM("WindowList" ))
|
|
|
|
#define PROPERTYHANDLE_WINDOWLIST 0
|
|
|
|
#define PROPERTYCOUNT 1
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// private declarations!
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
class SvtWorkingSetOptions_Impl : public ConfigItem
|
|
{
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// public methods
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// constructor / destructor
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
SvtWorkingSetOptions_Impl();
|
|
~SvtWorkingSetOptions_Impl();
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// overloaded methods of baseclass
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short called for notify of configmanager
|
|
@descr These method is called from the ConfigManager before application ends or from the
|
|
PropertyChangeListener if the sub tree broadcasts changes. You must update your
|
|
internal values.
|
|
|
|
@seealso baseclass ConfigItem
|
|
|
|
@param "seqPropertyNames" is the list of properties which should be updated.
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual void Notify( const Sequence< OUString >& seqPropertyNames );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short write changes to configuration
|
|
@descr These method writes the changed values into the sub tree
|
|
and should always called in our destructor to guarantee consistency of config data.
|
|
|
|
@seealso baseclass ConfigItem
|
|
|
|
@param -
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual void Commit();
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// public interface
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short access method to get internal values
|
|
@descr These method give us a chance to regulate acces to ouer internal values.
|
|
It's not used in the moment - but it's possible for the feature!
|
|
|
|
@seealso -
|
|
|
|
@param -
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
Sequence< OUString > GetWindowList( ) const ;
|
|
void SetWindowList( const Sequence< OUString >& seqWindowList ) ;
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// private methods
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short return list of key names of ouer configuration management which represent oue module tree
|
|
@descr These methods return a static const list of key names. We need it to get needed values from our
|
|
configuration management.
|
|
|
|
@seealso -
|
|
|
|
@param -
|
|
@return A list of needed configuration keys is returned.
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
static Sequence< OUString > GetPropertyNames();
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// private member
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
Sequence< OUString > m_seqWindowList ;
|
|
};
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// definitions
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
//*****************************************************************************************************************
|
|
// constructor
|
|
//*****************************************************************************************************************
|
|
SvtWorkingSetOptions_Impl::SvtWorkingSetOptions_Impl()
|
|
// Init baseclasses first
|
|
: ConfigItem ( ROOTNODE_WORKINGSET )
|
|
// Init member then.
|
|
, m_seqWindowList ( DEFAULT_WINDOWLIST )
|
|
{
|
|
// Use our static list of configuration keys to get his values.
|
|
Sequence< OUString > seqNames = GetPropertyNames ( );
|
|
Sequence< Any > seqValues = GetProperties ( seqNames );
|
|
|
|
// Safe impossible cases.
|
|
// We need values from ALL configuration keys.
|
|
// Follow assignment use order of values in relation to our list of key names!
|
|
DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtWorkingSetOptions_Impl::SvtWorkingSetOptions_Impl()\nI miss some values of configuration keys!\n" );
|
|
|
|
// Copy values from list in right order to ouer internal member.
|
|
sal_Int32 nPropertyCount = seqValues.getLength();
|
|
for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
|
|
{
|
|
// Safe impossible cases.
|
|
// Check any for valid value.
|
|
DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtWorkingSetOptions_Impl::SvtWorkingSetOptions_Impl()\nInvalid property value detected!\n" );
|
|
switch( nProperty )
|
|
{
|
|
case PROPERTYHANDLE_WINDOWLIST : {
|
|
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_SEQUENCE), "SvtWorkingSetOptions_Impl::SvtWorkingSetOptions_Impl()\nWho has changed the value type of \"Office.Common\\WorkingSet\\WindowList\"?" );
|
|
seqValues[nProperty] >>= m_seqWindowList;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Enable notification mechanism of ouer baseclass.
|
|
// We need it to get information about changes outside these class on ouer used configuration keys!
|
|
EnableNotification( seqNames );
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// destructor
|
|
//*****************************************************************************************************************
|
|
SvtWorkingSetOptions_Impl::~SvtWorkingSetOptions_Impl()
|
|
{
|
|
// We must save our current values .. if user forget it!
|
|
if( IsModified() == sal_True )
|
|
{
|
|
Commit();
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
void SvtWorkingSetOptions_Impl::Notify( const Sequence< OUString >& seqPropertyNames )
|
|
{
|
|
// Use given list of updated properties to get his values from configuration directly!
|
|
Sequence< Any > seqValues = GetProperties( seqPropertyNames );
|
|
// Safe impossible cases.
|
|
// We need values from ALL notified configuration keys.
|
|
DBG_ASSERT( !(seqPropertyNames.getLength()!=seqValues.getLength()), "SvtWorkingSetOptions_Impl::Notify()\nI miss some values of configuration keys!\n" );
|
|
// Step over list of property names and get right value from coreesponding value list to set it on internal members!
|
|
sal_Int32 nCount = seqPropertyNames.getLength();
|
|
for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
|
|
{
|
|
if( seqPropertyNames[nProperty] == PROPERTYNAME_WINDOWLIST )
|
|
{
|
|
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_SEQUENCE), "SvtWorkingSetOptions_Impl::Notify()\nWho has changed the value type of \"Office.Common\\WorkingSet\\WindowList\"?" );
|
|
seqValues[nProperty] >>= m_seqWindowList;
|
|
}
|
|
#if OSL_DEBUG_LEVEL > 1
|
|
else DBG_ASSERT( sal_False, "SvtWorkingSetOptions_Impl::Notify()\nUnkown property detected ... I can't handle these!\n" );
|
|
#endif
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
void SvtWorkingSetOptions_Impl::Commit()
|
|
{
|
|
// Get names of supported properties, create a list for values and copy current values to it.
|
|
Sequence< OUString > seqNames = GetPropertyNames ();
|
|
sal_Int32 nCount = seqNames.getLength();
|
|
Sequence< Any > seqValues ( nCount );
|
|
for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
|
|
{
|
|
switch( nProperty )
|
|
{
|
|
case PROPERTYHANDLE_WINDOWLIST : {
|
|
seqValues[nProperty] <<= m_seqWindowList;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
// Set properties in configuration.
|
|
PutProperties( seqNames, seqValues );
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
Sequence< OUString > SvtWorkingSetOptions_Impl::GetWindowList() const
|
|
{
|
|
return m_seqWindowList;
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
void SvtWorkingSetOptions_Impl::SetWindowList( const Sequence< OUString >& seqWindowList )
|
|
{
|
|
m_seqWindowList = seqWindowList;
|
|
SetModified();
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// private method
|
|
//*****************************************************************************************************************
|
|
Sequence< OUString > SvtWorkingSetOptions_Impl::GetPropertyNames()
|
|
{
|
|
// Build list of configuration key names.
|
|
const OUString pProperties[] =
|
|
{
|
|
PROPERTYNAME_WINDOWLIST ,
|
|
};
|
|
// Initialize return sequence with these list ...
|
|
const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
|
|
// ... and return it.
|
|
return seqPropertyNames;
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// initialize static member
|
|
// DON'T DO IT IN YOUR HEADER!
|
|
// see definition for further informations
|
|
//*****************************************************************************************************************
|
|
SvtWorkingSetOptions_Impl* SvtWorkingSetOptions::m_pDataContainer = NULL ;
|
|
sal_Int32 SvtWorkingSetOptions::m_nRefCount = 0 ;
|
|
|
|
//*****************************************************************************************************************
|
|
// constructor
|
|
//*****************************************************************************************************************
|
|
SvtWorkingSetOptions::SvtWorkingSetOptions()
|
|
{
|
|
// Global access, must be guarded (multithreading!).
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
// Increase ouer refcount ...
|
|
++m_nRefCount;
|
|
// ... and initialize ouer data container only if it not already exist!
|
|
if( m_pDataContainer == NULL )
|
|
{
|
|
m_pDataContainer = new SvtWorkingSetOptions_Impl;
|
|
ItemHolder1::holdConfigItem(E_WORKINGSETOPTIONS);
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// destructor
|
|
//*****************************************************************************************************************
|
|
SvtWorkingSetOptions::~SvtWorkingSetOptions()
|
|
{
|
|
// Global access, must be guarded (multithreading!)
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
// Decrease ouer refcount.
|
|
--m_nRefCount;
|
|
// If last instance was deleted ...
|
|
// we must destroy ouer static data container!
|
|
if( m_nRefCount <= 0 )
|
|
{
|
|
delete m_pDataContainer;
|
|
m_pDataContainer = NULL;
|
|
}
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
Sequence< OUString > SvtWorkingSetOptions::GetWindowList() const
|
|
{
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
return m_pDataContainer->GetWindowList();
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public method
|
|
//*****************************************************************************************************************
|
|
void SvtWorkingSetOptions::SetWindowList( const Sequence< OUString >& seqWindowList )
|
|
{
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
m_pDataContainer->SetWindowList( seqWindowList );
|
|
}
|
|
|
|
namespace
|
|
{
|
|
class theWorkingSetOptionsMutex : public rtl::Static<osl::Mutex, theWorkingSetOptionsMutex>{};
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// private method
|
|
//*****************************************************************************************************************
|
|
Mutex& SvtWorkingSetOptions::GetOwnStaticMutex()
|
|
{
|
|
return theWorkingSetOptionsMutex::get();
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|