office-gobmx/extensions/source/propctrlr/defaultforminspection.cxx
2010-10-13 12:51:15 +01:00

266 lines
12 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_extensions.hxx"
#include "defaultforminspection.hxx"
#include "pcrcommon.hxx"
#include "propresid.hrc"
#include "formresid.hrc"
#include "modulepcr.hxx"
#include "propctrlr.hrc"
#include "formmetadata.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/ucb/AlreadyInitializedException.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
/** === end UNO includes === **/
#include <cppuhelper/implbase1.hxx>
#include <osl/diagnose.h>
//------------------------------------------------------------------------
extern "C" void SAL_CALL createRegistryInfo_DefaultFormComponentInspectorModel()
{
::pcr::OAutoRegistration< ::pcr::DefaultFormComponentInspectorModel > aAutoRegistration;
}
//........................................................................
namespace pcr
{
//........................................................................
/** === begin UNO using === **/
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::XInterface;
using ::com::sun::star::uno::XComponentContext;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::lang::EventObject;
using ::com::sun::star::inspection::PropertyCategoryDescriptor;
using ::com::sun::star::beans::UnknownPropertyException;
using ::com::sun::star::ucb::AlreadyInitializedException;
using ::com::sun::star::lang::IllegalArgumentException;
/** === end UNO using === **/
//====================================================================
//= DefaultFormComponentInspectorModel
//====================================================================
//--------------------------------------------------------------------
DefaultFormComponentInspectorModel::DefaultFormComponentInspectorModel( const Reference< XComponentContext >& _rxContext, bool _bUseFormFormComponentHandlers )
:ImplInspectorModel( _rxContext )
,m_bUseFormComponentHandlers( _bUseFormFormComponentHandlers )
,m_bConstructed( false )
,m_pInfoService( new OPropertyInfoService )
{
}
//------------------------------------------------------------------------
DefaultFormComponentInspectorModel::~DefaultFormComponentInspectorModel()
{
}
//------------------------------------------------------------------------
::rtl::OUString SAL_CALL DefaultFormComponentInspectorModel::getImplementationName( ) throw(RuntimeException)
{
return getImplementationName_static();
}
//------------------------------------------------------------------------
Sequence< ::rtl::OUString > SAL_CALL DefaultFormComponentInspectorModel::getSupportedServiceNames( ) throw(RuntimeException)
{
return getSupportedServiceNames_static();
}
//------------------------------------------------------------------------
::rtl::OUString DefaultFormComponentInspectorModel::getImplementationName_static( ) throw(RuntimeException)
{
return ::rtl::OUString::createFromAscii( "org.openoffice.comp.extensions.DefaultFormComponentInspectorModel");
}
//------------------------------------------------------------------------
Sequence< ::rtl::OUString > DefaultFormComponentInspectorModel::getSupportedServiceNames_static( ) throw(RuntimeException)
{
Sequence< ::rtl::OUString > aSupported(1);
aSupported[0] = ::rtl::OUString::createFromAscii( "com.sun.star.form.inspection.DefaultFormComponentInspectorModel" );
return aSupported;
}
//------------------------------------------------------------------------
Reference< XInterface > SAL_CALL DefaultFormComponentInspectorModel::Create( const Reference< XComponentContext >& _rxContext )
{
return *new DefaultFormComponentInspectorModel( _rxContext );
}
//--------------------------------------------------------------------
Sequence< Any > SAL_CALL DefaultFormComponentInspectorModel::getHandlerFactories() throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
// service names for all our handlers
struct
{
const sal_Char* serviceName;
bool isFormOnly;
} aFactories[] = {
// a generic handler for form component properties (must precede the ButtonNavigationHandler)
{ "com.sun.star.form.inspection.FormComponentPropertyHandler", false },
// generic virtual edit properties
{ "com.sun.star.form.inspection.EditPropertyHandler", false },
// a handler which virtualizes the ButtonType property, to provide additional types like
// "move to next record"
{ "com.sun.star.form.inspection.ButtonNavigationHandler", false },
// a handler for script events bound to form components or dialog elements
{ "com.sun.star.form.inspection.EventHandler", false },
// a handler which introduces virtual properties for binding controls to spreadsheet cells
{ "com.sun.star.form.inspection.CellBindingPropertyHandler", false },
// properties related to binding to an XForms DOM node
{ "com.sun.star.form.inspection.XMLFormsPropertyHandler", true },
// properties related to the XSD data against which a control content is validated
{ "com.sun.star.form.inspection.XSDValidationPropertyHandler", true },
// a handler which cares for XForms submissions
{ "com.sun.star.form.inspection.SubmissionPropertyHandler", true },
// a handler which cares for geometry properties of form controls
{ "com.sun.star.form.inspection.FormGeometryHandler", true }
};
sal_Int32 nFactories = sizeof( aFactories ) / sizeof( aFactories[ 0 ] );
Sequence< Any > aReturn( nFactories );
Any* pReturn = aReturn.getArray();
for ( sal_Int32 i = 0; i < nFactories; ++i )
{
if ( aFactories[i].isFormOnly && !m_bUseFormComponentHandlers )
continue;
*pReturn++ <<= ::rtl::OUString::createFromAscii( aFactories[i].serviceName );
}
aReturn.realloc( pReturn - aReturn.getArray() );
return aReturn;
}
//--------------------------------------------------------------------
Sequence< PropertyCategoryDescriptor > SAL_CALL DefaultFormComponentInspectorModel::describeCategories( ) throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
struct
{
const sal_Char* programmaticName;
USHORT uiNameResId;
sal_uInt32 helpId;
} aCategories[] = {
{ "General", RID_STR_PROPPAGE_DEFAULT, HID_FM_PROPDLG_TAB_GENERAL },
{ "Data", RID_STR_PROPPAGE_DATA, HID_FM_PROPDLG_TAB_DATA },
{ "Events", RID_STR_EVENTS, HID_FM_PROPDLG_TAB_EVT }
};
sal_Int32 nCategories = sizeof( aCategories ) / sizeof( aCategories[0] );
Sequence< PropertyCategoryDescriptor > aReturn( nCategories );
PropertyCategoryDescriptor* pReturn = aReturn.getArray();
for ( sal_Int32 i=0; i<nCategories; ++i, ++pReturn )
{
pReturn->ProgrammaticName = ::rtl::OUString::createFromAscii( aCategories[i].programmaticName );
pReturn->UIName = String( PcrRes( aCategories[i].uiNameResId ) );
pReturn->HelpURL = HelpIdUrl::getHelpURL( aCategories[i].helpId );
}
return aReturn;
}
//--------------------------------------------------------------------
::sal_Int32 SAL_CALL DefaultFormComponentInspectorModel::getPropertyOrderIndex( const ::rtl::OUString& _rPropertyName ) throw (RuntimeException)
{
sal_Int32 nPropertyId( m_pInfoService->getPropertyId( _rPropertyName ) );
if ( nPropertyId == -1 )
{
if ( _rPropertyName.indexOf( ';' ) != -1 )
// it's an event. Just give it an arbitrary number - events will be on a separate
// page, and by definition, if two properties have the same OrderIndex, then
// they will be ordered as they appear in the handler's getSupportedProperties.
return 1000;
return 0;
}
return m_pInfoService->getPropertyPos( nPropertyId );
}
//--------------------------------------------------------------------
void SAL_CALL DefaultFormComponentInspectorModel::initialize( const Sequence< Any >& _arguments ) throw (Exception, RuntimeException)
{
if ( m_bConstructed )
throw AlreadyInitializedException();
StlSyntaxSequence< Any > arguments( _arguments );
if ( arguments.empty() )
{ // constructor: "createDefault()"
createDefault();
return;
}
sal_Int32 nMinHelpTextLines( 0 ), nMaxHelpTextLines( 0 );
if ( arguments.size() == 2 )
{ // constructor: "createWithHelpSection( long, long )"
if ( !( arguments[0] >>= nMinHelpTextLines ) || !( arguments[1] >>= nMaxHelpTextLines ) )
throw IllegalArgumentException( ::rtl::OUString(), *this, 0 );
createWithHelpSection( nMinHelpTextLines, nMaxHelpTextLines );
return;
}
throw IllegalArgumentException( ::rtl::OUString(), *this, 0 );
}
//--------------------------------------------------------------------
void DefaultFormComponentInspectorModel::createDefault()
{
m_bConstructed = true;
}
//--------------------------------------------------------------------
void DefaultFormComponentInspectorModel::createWithHelpSection( sal_Int32 _nMinHelpTextLines, sal_Int32 _nMaxHelpTextLines )
{
if ( ( _nMinHelpTextLines <= 0 ) || ( _nMaxHelpTextLines <= 0 ) || ( _nMinHelpTextLines > _nMaxHelpTextLines ) )
throw IllegalArgumentException( ::rtl::OUString(), *this, 0 );
enableHelpSectionProperties( _nMinHelpTextLines, _nMaxHelpTextLines );
m_bConstructed = true;
}
//........................................................................
} // namespace pcr
//........................................................................
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */