1
0
Fork 0
libreoffice/forms/source/component/EditBase.cxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

372 lines
13 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#include "EditBase.hxx"
#include <property.hxx>
#include <tools/debug.hxx>
#include <comphelper/basicio.hxx>
#include <comphelper/property.hxx>
#include <comphelper/types.hxx>
#include <tools/time.hxx>
#include <tools/date.hxx>
#include <com/sun/star/io/XMarkableStream.hpp>
#include <com/sun/star/util/Time.hpp>
#include <com/sun/star/util/Date.hpp>
namespace frm
{
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::sdb;
using namespace ::com::sun::star::sdbc;
using namespace ::com::sun::star::io;
using namespace ::com::sun::star::util;
namespace
{
const sal_uInt16 DEFAULT_LONG = 0x0001;
const sal_uInt16 DEFAULT_DOUBLE = 0x0002;
const sal_uInt16 FILTERPROPOSAL = 0x0004;
const sal_uInt16 DEFAULT_TIME = 0x0008;
const sal_uInt16 DEFAULT_DATE = 0x0010;
}
OEditBaseModel::OEditBaseModel( const Reference< XComponentContext >& _rxFactory, const OUString& rUnoControlModelName,
const OUString& rDefault, const bool _bSupportExternalBinding, const bool _bSupportsValidation )
:OBoundControlModel( _rxFactory, rUnoControlModelName, rDefault, true, _bSupportExternalBinding, _bSupportsValidation )
,m_nLastReadVersion(0)
,m_bEmptyIsNull(true)
,m_bFilterProposal(false)
{
}
OEditBaseModel::OEditBaseModel( const OEditBaseModel* _pOriginal, const Reference< XComponentContext >& _rxFactory )
:OBoundControlModel( _pOriginal, _rxFactory )
,m_nLastReadVersion(0)
{
m_bFilterProposal = _pOriginal->m_bFilterProposal;
m_bEmptyIsNull = _pOriginal->m_bEmptyIsNull;
m_aDefault = _pOriginal->m_aDefault;
m_aDefaultText = _pOriginal->m_aDefaultText;
}
OEditBaseModel::~OEditBaseModel( )
{
}
// XPersist
void OEditBaseModel::write(const Reference<XObjectOutputStream>& _rxOutStream)
{
OBoundControlModel::write(_rxOutStream);
// Version
sal_uInt16 nVersionId = 0x0006;
DBG_ASSERT((getPersistenceFlags() & ~PF_SPECIAL_FLAGS) == 0,
"OEditBaseModel::write : invalid special version flags !");
// please don't use other flags, older versions can't interpret them !
nVersionId |= getPersistenceFlags();
_rxOutStream->writeShort(nVersionId);
// Name
_rxOutStream->writeShort(0); // obsolete
_rxOutStream << m_aDefaultText;
// Masking for any
sal_uInt16 nAnyMask = 0;
if (m_aDefault.getValueTypeClass() == TypeClass_LONG)
nAnyMask |= DEFAULT_LONG;
else if (m_aDefault.getValueTypeClass() == TypeClass_DOUBLE)
nAnyMask |= DEFAULT_DOUBLE;
else if (m_aDefault.getValueType() == cppu::UnoType<util::Time>::get())
nAnyMask |= DEFAULT_TIME;
else if (m_aDefault.getValueType() == cppu::UnoType<util::Date>::get())
nAnyMask |= DEFAULT_DATE;
if (m_bFilterProposal) // Don't save a value, because it's boolean
nAnyMask |= FILTERPROPOSAL;
_rxOutStream->writeBoolean(m_bEmptyIsNull);
_rxOutStream->writeShort(nAnyMask);
if ((nAnyMask & DEFAULT_LONG) == DEFAULT_LONG)
_rxOutStream->writeLong(getINT32(m_aDefault));
else if ((nAnyMask & DEFAULT_DOUBLE) == DEFAULT_DOUBLE)
_rxOutStream->writeDouble(getDouble(m_aDefault));
else if ((nAnyMask & DEFAULT_TIME) == DEFAULT_TIME)
{
util::Time aTime;
OSL_VERIFY(m_aDefault >>= aTime);
_rxOutStream->writeHyper(::tools::Time(aTime).GetTime());
}
else if ((nAnyMask & DEFAULT_DATE) == DEFAULT_DATE)
{
util::Date aDate;
OSL_VERIFY(m_aDefault >>= aDate);
_rxOutStream->writeLong(::Date(aDate).GetDate());
}
// since version 5 we write the help text
writeHelpTextCompatibly(_rxOutStream);
// (that's potentially bad : at the time I added the above line we had two derived classes : OEditModel and
// OFormattedModel. The first one does not have an own version handling, so it can't write the help text itself,
// the second one does its own writing (reading) after calling our method, so normally we shouldn't write any
// additional members as this is not compatible to older office versions.
// We decided to place the writing of the help text here as it seems the less worse alternative. There is no delivered
// office version including formatted controls (and thus the OFormattedModel), and the OFormattedModel::read seems
// robust against this change (as it will read a wrong and unknown file version and thus set its members to defaults).
if ((nVersionId & PF_HANDLE_COMMON_PROPS) != 0)
writeCommonEditProperties(_rxOutStream);
// !!! properties common to all OEditBaseModel derived classes should be written in writeCommonEditProperties !!!
}
sal_uInt16 OEditBaseModel::getPersistenceFlags() const
{
return PF_HANDLE_COMMON_PROPS;
}
void OEditBaseModel::read(const Reference<XObjectInputStream>& _rxInStream)
{
OBoundControlModel::read(_rxInStream);
::osl::MutexGuard aGuard(m_aMutex);
// Version's own version number
sal_uInt16 nVersion = _rxInStream->readShort();
m_nLastReadVersion = nVersion;
bool bHandleCommonProps = (nVersion & PF_HANDLE_COMMON_PROPS) != 0;
nVersion = nVersion & ~PF_SPECIAL_FLAGS;
// obsolete
_rxInStream->readShort();
_rxInStream >> m_aDefaultText;
if (nVersion >= 0x0003)
{
m_bEmptyIsNull = _rxInStream->readBoolean();
sal_uInt16 nAnyMask = _rxInStream->readShort();
if ((nAnyMask & DEFAULT_LONG) == DEFAULT_LONG)
{
sal_Int32 nValue = _rxInStream->readLong();
m_aDefault <<= nValue;
}
else if ((nAnyMask & DEFAULT_DOUBLE) == DEFAULT_DOUBLE)
{
double fValue = _rxInStream->readDouble();
m_aDefault <<= fValue;
}
else if ((nAnyMask & DEFAULT_TIME) == DEFAULT_TIME)
{
m_aDefault <<= ::tools::Time::fromEncodedTime(_rxInStream->readHyper()).GetUNOTime();
}
else if ((nAnyMask & DEFAULT_DATE) == DEFAULT_DATE)
{
m_aDefault <<= ::Date(_rxInStream->readLong()).GetUNODate();
}
if ((nAnyMask & FILTERPROPOSAL) == FILTERPROPOSAL)
m_bFilterProposal = true;
}
if (nVersion > 4)
readHelpTextCompatibly(_rxInStream);
if (bHandleCommonProps)
readCommonEditProperties(_rxInStream);
// After reading, display default values
if ( !getControlSource().isEmpty() )
// (not if we don't have a control source - the "State" property acts like it is persistent, then)
resetNoBroadcast();
};
void OEditBaseModel::defaultCommonEditProperties()
{
OBoundControlModel::defaultCommonProperties();
// no own common properties at the moment
}
void OEditBaseModel::readCommonEditProperties(const Reference<XObjectInputStream>& _rxInStream)
{
sal_Int32 nLen = _rxInStream->readLong();
Reference<XMarkableStream> xMark(_rxInStream, UNO_QUERY);
DBG_ASSERT(xMark.is(), "OBoundControlModel::readCommonProperties : can only work with markable streams !");
sal_Int32 nMark = xMark->createMark();
// read properties common to all OBoundControlModels
OBoundControlModel::readCommonProperties(_rxInStream);
// read properties common to all OEditBaseModels
// skip the remaining bytes
xMark->jumpToMark(nMark);
_rxInStream->skipBytes(nLen);
xMark->deleteMark(nMark);
}
void OEditBaseModel::writeCommonEditProperties(const Reference<XObjectOutputStream>& _rxOutStream)
{
Reference<XMarkableStream> xMark(_rxOutStream, UNO_QUERY);
DBG_ASSERT(xMark.is(), "OEditBaseModel::writeCommonProperties : can only work with markable streams !");
sal_Int32 nMark = xMark->createMark();
// a placeholder where we will write the overall length (later in this method)
sal_Int32 nLen = 0;
_rxOutStream->writeLong(nLen);
// write properties common to all OBoundControlModels
OBoundControlModel::writeCommonProperties(_rxOutStream);
// write properties common to all OEditBaseModels
// close the block - write the correct length at the beginning
nLen = xMark->offsetToMark(nMark) - sizeof(nLen);
xMark->jumpToMark(nMark);
_rxOutStream->writeLong(nLen);
xMark->jumpToFurthest();
xMark->deleteMark(nMark);
}
void OEditBaseModel::getFastPropertyValue( Any& rValue, sal_Int32 nHandle ) const
{
switch (nHandle)
{
case PROPERTY_ID_EMPTY_IS_NULL:
rValue <<= m_bEmptyIsNull;
break;
case PROPERTY_ID_FILTERPROPOSAL:
rValue <<= m_bFilterProposal;
break;
case PROPERTY_ID_DEFAULT_TEXT:
rValue <<= m_aDefaultText;
break;
case PROPERTY_ID_DEFAULT_VALUE:
case PROPERTY_ID_DEFAULT_DATE:
case PROPERTY_ID_DEFAULT_TIME:
rValue = m_aDefault;
break;
default:
OBoundControlModel::getFastPropertyValue(rValue, nHandle);
}
}
sal_Bool OEditBaseModel::convertFastPropertyValue( Any& rConvertedValue, Any& rOldValue,
sal_Int32 nHandle, const Any& rValue )
{
bool bModified(false);
switch (nHandle)
{
case PROPERTY_ID_EMPTY_IS_NULL:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_bEmptyIsNull);
break;
case PROPERTY_ID_FILTERPROPOSAL:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_bFilterProposal);
break;
case PROPERTY_ID_DEFAULT_TEXT:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_aDefaultText);
break;
case PROPERTY_ID_DEFAULT_VALUE:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_aDefault, cppu::UnoType<double>::get());
break;
case PROPERTY_ID_DEFAULT_DATE:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_aDefault, cppu::UnoType<util::Date>::get());
break;
case PROPERTY_ID_DEFAULT_TIME:
bModified = tryPropertyValue(rConvertedValue, rOldValue, rValue, m_aDefault, cppu::UnoType<util::Time>::get());
break;
default:
bModified = OBoundControlModel::convertFastPropertyValue(
rConvertedValue,
rOldValue,
nHandle,
rValue);
}
return bModified;
}
void OEditBaseModel::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const Any& rValue )
{
switch (nHandle)
{
case PROPERTY_ID_EMPTY_IS_NULL:
DBG_ASSERT(rValue.getValueTypeClass() == TypeClass_BOOLEAN, "invalid type" );
m_bEmptyIsNull = getBOOL(rValue);
break;
case PROPERTY_ID_FILTERPROPOSAL:
DBG_ASSERT(rValue.getValueTypeClass() == TypeClass_BOOLEAN, "invalid type" );
m_bFilterProposal = getBOOL(rValue);
break;
// Changing the default values causes a reset
case PROPERTY_ID_DEFAULT_TEXT:
DBG_ASSERT(rValue.getValueTypeClass() == TypeClass_STRING, "invalid type" );
rValue >>= m_aDefaultText;
resetNoBroadcast();
break;
case PROPERTY_ID_DEFAULT_VALUE:
case PROPERTY_ID_DEFAULT_DATE:
case PROPERTY_ID_DEFAULT_TIME:
m_aDefault = rValue;
resetNoBroadcast();
break;
default:
OBoundControlModel::setFastPropertyValue_NoBroadcast(nHandle, rValue );
}
}
// XPropertyState
Any OEditBaseModel::getPropertyDefaultByHandle( sal_Int32 nHandle ) const
{
switch (nHandle)
{
case PROPERTY_ID_DEFAULT_TEXT:
return Any(OUString());
case PROPERTY_ID_FILTERPROPOSAL:
return Any(false);
case PROPERTY_ID_DEFAULT_VALUE:
case PROPERTY_ID_DEFAULT_DATE:
case PROPERTY_ID_DEFAULT_TIME:
return Any();
default:
return OBoundControlModel::getPropertyDefaultByHandle(nHandle);
}
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */