375 lines
16 KiB
C++
375 lines
16 KiB
C++
|
/*************************************************************************
|
||
|
|
*
|
||
|
|
* $RCSfile: startoptions.cxx,v $
|
||
|
|
*
|
||
|
|
* $Revision: 1.1 $
|
||
|
|
*
|
||
|
|
* last change: $Author: as $ $Date: 2000-10-30 08:30:51 $
|
||
|
|
*
|
||
|
|
* The Contents of this file are made available subject to the terms of
|
||
|
|
* either of the following licenses
|
||
|
|
*
|
||
|
|
* - GNU Lesser General Public License Version 2.1
|
||
|
|
* - Sun Industry Standards Source License Version 1.1
|
||
|
|
*
|
||
|
|
* Sun Microsystems Inc., October, 2000
|
||
|
|
*
|
||
|
|
* GNU Lesser General Public License Version 2.1
|
||
|
|
* =============================================
|
||
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
||
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||
|
|
*
|
||
|
|
* This library is free software; you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU Lesser General Public
|
||
|
|
* License version 2.1, as published by the Free Software Foundation.
|
||
|
|
*
|
||
|
|
* This library 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 for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser General Public
|
||
|
|
* License along with this library; if not, write to the Free Software
|
||
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||
|
|
* MA 02111-1307 USA
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* Sun Industry Standards Source License Version 1.1
|
||
|
|
* =================================================
|
||
|
|
* The contents of this file are subject to the Sun Industry Standards
|
||
|
|
* Source License Version 1.1 (the "License"); You may not use this file
|
||
|
|
* except in compliance with the License. You may obtain a copy of the
|
||
|
|
* License at http://www.openoffice.org/license.html.
|
||
|
|
*
|
||
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
||
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
||
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
||
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
||
|
|
* See the License for the specific provisions governing your rights and
|
||
|
|
* obligations concerning the Software.
|
||
|
|
*
|
||
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
||
|
|
*
|
||
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
||
|
|
*
|
||
|
|
* All Rights Reserved.
|
||
|
|
*
|
||
|
|
* Contributor(s): _______________________________________
|
||
|
|
*
|
||
|
|
*
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
#pragma hdrstop
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// includes
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
#include "startoptions.hxx"
|
||
|
|
|
||
|
|
#ifndef _UTL_CONFIGMGR_HXX_
|
||
|
|
#include <unotools/configmgr.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef _UTL_CONFIGITEM_HXX_
|
||
|
|
#include <unotools/configitem.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef _TOOLS_DEBUG_HXX
|
||
|
|
#include <tools/debug.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef _COM_SUN_STAR_UNO_ANY_HXX_
|
||
|
|
#include <com/sun/star/uno/Any.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
|
||
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
||
|
|
#endif
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// namespaces
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
using namespace ::utl ;
|
||
|
|
using namespace ::rtl ;
|
||
|
|
using namespace ::osl ;
|
||
|
|
using namespace ::com::sun::star::uno ;
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// const
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
#define ROOTNODE_START OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/Start" ))
|
||
|
|
#define DEFAULT_SHOWINTRO sal_True
|
||
|
|
|
||
|
|
#define PROPERTYNAME_SHOWINTRO OUString(RTL_CONSTASCII_USTRINGPARAM("ShowIntro" ))
|
||
|
|
|
||
|
|
#define PROPERTYHANDLE_SHOWINTRO 0
|
||
|
|
|
||
|
|
#define PROPERTYCOUNT 1
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// private declarations!
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
class SvtStartOptions_Impl : public ConfigItem
|
||
|
|
{
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
// public methods
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
//---------------------------------------------------------------------------------------------------------
|
||
|
|
// constructor / destructor
|
||
|
|
//---------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
SvtStartOptions_Impl();
|
||
|
|
~SvtStartOptions_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.
|
||
|
|
|
||
|
|
@ATTENTION We don't implement these method - because we support readonly values at runtime only!
|
||
|
|
|
||
|
|
@seealso baseclass ConfigItem
|
||
|
|
|
||
|
|
@param "seqPropertyNames" is the list of properties which should be updated.
|
||
|
|
@return -
|
||
|
|
|
||
|
|
@onerror -
|
||
|
|
*//*-*****************************************************************************************************/
|
||
|
|
|
||
|
|
virtual void Notify( const Sequence< OUString >& seqPropertyNames )
|
||
|
|
{
|
||
|
|
DBG_ASSERT( sal_False, "SvtStartOptions_Impl::Notify()\nNot implemented yet - we support readonly values only!\n" );
|
||
|
|
}
|
||
|
|
|
||
|
|
/*-****************************************************************************************************//**
|
||
|
|
@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.
|
||
|
|
|
||
|
|
@ATTENTION We don't implement these method - because we support readonly values at runtime only!
|
||
|
|
|
||
|
|
@seealso baseclass ConfigItem
|
||
|
|
|
||
|
|
@param -
|
||
|
|
@return -
|
||
|
|
|
||
|
|
@onerror -
|
||
|
|
*//*-*****************************************************************************************************/
|
||
|
|
|
||
|
|
virtual void Commit()
|
||
|
|
{
|
||
|
|
DBG_ASSERT( sal_False, "SvtStartOptions_Impl::Commit()\nNot implemented yet - we support readonly values only!\n" );
|
||
|
|
}
|
||
|
|
|
||
|
|
//---------------------------------------------------------------------------------------------------------
|
||
|
|
// 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 -
|
||
|
|
*//*-*****************************************************************************************************/
|
||
|
|
|
||
|
|
sal_Bool ShowIntro() const;
|
||
|
|
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
// private methods
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
/*-****************************************************************************************************//**
|
||
|
|
@short return list of fix 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. We return well known key names only - because the "UserData" node
|
||
|
|
is handled in a special way!
|
||
|
|
|
||
|
|
@seealso -
|
||
|
|
|
||
|
|
@param -
|
||
|
|
@return A list of needed configuration keys is returned.
|
||
|
|
|
||
|
|
@onerror -
|
||
|
|
*//*-*****************************************************************************************************/
|
||
|
|
|
||
|
|
static Sequence< OUString > impl_GetPropertyNames();
|
||
|
|
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
// private member
|
||
|
|
//-------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
sal_Bool m_bShowIntro ; /// cache "ShowIntro" of Start section
|
||
|
|
};
|
||
|
|
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
// definitions
|
||
|
|
//_________________________________________________________________________________________________________________
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// constructor
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
SvtStartOptions_Impl::SvtStartOptions_Impl()
|
||
|
|
// Init baseclasses first
|
||
|
|
: ConfigItem ( ROOTNODE_START )
|
||
|
|
// Init member then.
|
||
|
|
, m_bShowIntro ( DEFAULT_SHOWINTRO )
|
||
|
|
{
|
||
|
|
// Use our static list of configuration keys to get his values.
|
||
|
|
Sequence< OUString > seqNames = impl_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()), "SvtStartOptions_Impl::SvtStartOptions_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() ;
|
||
|
|
sal_Int32 nProperty = 0 ;
|
||
|
|
for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
|
||
|
|
{
|
||
|
|
// Safe impossible cases.
|
||
|
|
// Check any for valid value.
|
||
|
|
DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nInvalid property value for property detected!\n" );
|
||
|
|
switch( nProperty )
|
||
|
|
{
|
||
|
|
case PROPERTYHANDLE_SHOWINTRO : {
|
||
|
|
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtStartOptions_Impl::SvtStartOptions_Impl()\nWho has changed the value type of \"Office.Common\\Start\\ShowIntro\"?" );
|
||
|
|
seqValues[nProperty] >>= m_bShowIntro;
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Don't enable notification mechanism of ouer baseclass!
|
||
|
|
// We support readonly variables in the moment.
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// destructor
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
SvtStartOptions_Impl::~SvtStartOptions_Impl()
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// public method
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
sal_Bool SvtStartOptions_Impl::ShowIntro() const
|
||
|
|
{
|
||
|
|
return m_bShowIntro;
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// private method
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
Sequence< OUString > SvtStartOptions_Impl::impl_GetPropertyNames()
|
||
|
|
{
|
||
|
|
// Build static list of configuration key names.
|
||
|
|
static const OUString pProperties[] =
|
||
|
|
{
|
||
|
|
PROPERTYNAME_SHOWINTRO ,
|
||
|
|
};
|
||
|
|
// Initialize return sequence with these list ...
|
||
|
|
static 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
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
SvtStartOptions_Impl* SvtStartOptions::m_pDataContainer = NULL ;
|
||
|
|
sal_Int32 SvtStartOptions::m_nRefCount = 0 ;
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// constructor
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
SvtStartOptions::SvtStartOptions()
|
||
|
|
{
|
||
|
|
// Global access, must be guarded (multithreading!).
|
||
|
|
MutexGuard aGuard( GetInitMutex() );
|
||
|
|
// Increase ouer refcount ...
|
||
|
|
++m_nRefCount;
|
||
|
|
// ... and initialize ouer data container only if it not already!
|
||
|
|
if( m_pDataContainer == NULL )
|
||
|
|
{
|
||
|
|
m_pDataContainer = new SvtStartOptions_Impl();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// destructor
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
SvtStartOptions::~SvtStartOptions()
|
||
|
|
{
|
||
|
|
// Global access, must be guarded (multithreading!)
|
||
|
|
MutexGuard aGuard( GetInitMutex() );
|
||
|
|
// 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
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
sal_Bool SvtStartOptions::ShowIntro() const
|
||
|
|
{
|
||
|
|
return m_pDataContainer->ShowIntro();
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
// private method
|
||
|
|
//*****************************************************************************************************************
|
||
|
|
Mutex& SvtStartOptions::GetInitMutex()
|
||
|
|
{
|
||
|
|
// Initialize static mutex only for one time!
|
||
|
|
static Mutex* pMutex = NULL;
|
||
|
|
// If these method first called (Mutex not already exist!) ...
|
||
|
|
if( pMutex == NULL )
|
||
|
|
{
|
||
|
|
// ... we must create a new one. Protect follow code with the global mutex -
|
||
|
|
// It must be - we create a static variable!
|
||
|
|
MutexGuard aGuard( Mutex::getGlobalMutex() );
|
||
|
|
// We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
|
||
|
|
if( pMutex == NULL )
|
||
|
|
{
|
||
|
|
// Create the new mutex and set it for return on static variable.
|
||
|
|
static Mutex aMutex;
|
||
|
|
pMutex = &aMutex;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// Return new created or already existing mutex object.
|
||
|
|
return *pMutex;
|
||
|
|
}
|