INTEGRATION: CWS formcelllinkage (1.1.6); FILE ADDED
2003/10/01 09:17:52 fs 1.1.6.1: #i18994# merging the changes from the CWS fs002
This commit is contained in:
Oliver Bolte
parent
28431921d7
commit
4852801766
1 changed files with 333 additions and 0 deletions
333
extensions/source/propctrlr/cellbindinghelper.hxx
Normal file
333
extensions/source/propctrlr/cellbindinghelper.hxx
Normal file
|
|
@ -0,0 +1,333 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* $RCSfile: cellbindinghelper.hxx,v $
|
||||
*
|
||||
* $Revision: 1.2 $
|
||||
*
|
||||
* last change: $Author: obo $ $Date: 2003-10-21 09:04:35 $
|
||||
*
|
||||
* 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 EXPRESS 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): _______________________________________
|
||||
*
|
||||
*
|
||||
************************************************************************/
|
||||
|
||||
#ifndef EXTENSIONS_PROPCTRLR_CELLBINDINGHELPER_HXX
|
||||
#define EXTENSIONS_PROPCTRLR_CELLBINDINGHELPER_HXX
|
||||
|
||||
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
|
||||
#include <com/sun/star/beans/XPropertySet.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_SHEET_XSPREADSHEETDOCUMENT_HPP_
|
||||
#include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_TABLE_CELLADDRESS_HPP_
|
||||
#include <com/sun/star/table/CellAddress.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_TABLE_CELLRANGEADDRESS_HPP_
|
||||
#include <com/sun/star/table/CellRangeAddress.hpp>
|
||||
#endif
|
||||
#ifndef _DRAFTS_COM_SUN_STAR_FORM_XVALUEBINDING_HPP_
|
||||
#include <drafts/com/sun/star/form/XValueBinding.hpp>
|
||||
#endif
|
||||
#ifndef _DRAFTS_COM_SUN_STAR_FORM_XLISTENTRYSOURCE_HPP_
|
||||
#include <drafts/com/sun/star/form/XListEntrySource.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
|
||||
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
||||
#endif
|
||||
|
||||
//............................................................................
|
||||
namespace pcr
|
||||
{
|
||||
//............................................................................
|
||||
|
||||
//========================================================================
|
||||
//= CellBindingHelper
|
||||
//========================================================================
|
||||
/** encapsulates functionality related to binding a form control to a spreadsheet cell
|
||||
*/
|
||||
class CellBindingHelper
|
||||
{
|
||||
protected:
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
|
||||
m_xControlModel; // the model we work for
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::sheet::XSpreadsheetDocument >
|
||||
m_xDocument; // the document where the model lives
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
|
||||
m_xORB; // service factory, needed sometimes
|
||||
|
||||
public:
|
||||
/** ctor
|
||||
@param _rxControlModel
|
||||
the control model which is or will be bound
|
||||
*/
|
||||
CellBindingHelper(
|
||||
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
|
||||
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel
|
||||
);
|
||||
|
||||
public:
|
||||
/** determines whether the given control model lives in a spreadsheet document
|
||||
<p>If this method returns <FALSE/>, you cannot instantiate a CellBindingHelper with
|
||||
this model, since then no of it's functionality will be available.</p>
|
||||
*/
|
||||
static sal_Bool livesInSpreadsheetDocument(
|
||||
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel
|
||||
);
|
||||
|
||||
/** gets a cell binding for the given address
|
||||
@precond
|
||||
isCellBindingAllowed returns <TRUE/>
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >
|
||||
createCellBindingFromStringAddress(
|
||||
const ::rtl::OUString& _rAddress,
|
||||
bool _bSupportIntegerExchange = false
|
||||
) const;
|
||||
|
||||
/** creates a cell binding (supporting integer exchange, if requested) for
|
||||
the given address object
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >
|
||||
createCellBindingFromAddress(
|
||||
const ::com::sun::star::table::CellAddress& _rAddress,
|
||||
bool _bSupportIntegerExchange = false
|
||||
) const;
|
||||
|
||||
/** gets a cell range list source binding for the given address
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XListEntrySource >
|
||||
createCellListSourceFromStringAddress( const ::rtl::OUString& _rAddress ) const;
|
||||
|
||||
/** creates a string representation for the given value binding's address
|
||||
|
||||
<p>If the sheet of the bound cell is the same as the sheet which our control belongs
|
||||
to, then the sheet name is omitted in the resulting string representation.</p>
|
||||
|
||||
@precond
|
||||
The binding is a valid cell binding, or <NULL/>
|
||||
@see isCellBinding
|
||||
*/
|
||||
::rtl::OUString getStringAddressFromCellBinding(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >& _rxBinding
|
||||
) const;
|
||||
|
||||
/** creates an address object for the given value binding's address
|
||||
|
||||
@precond
|
||||
The binding is a valid cell binding, or <NULL/>
|
||||
@return
|
||||
<FALSE/> if and only if an error occured and no valid address could be obtained
|
||||
@see isCellBinding
|
||||
*/
|
||||
bool getAddressFromCellBinding(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >& _rxBinding,
|
||||
::com::sun::star::table::CellAddress& _rAddress
|
||||
) const;
|
||||
|
||||
/** creates a string representation for the given list source's range address
|
||||
|
||||
<p>If the sheet of the cell range which acts as list source is the same as the
|
||||
sheet which our control belongs to, then the sheet name is omitted in the
|
||||
resulting string representation.</p>
|
||||
|
||||
@precond
|
||||
The object is a valid cell range list source, or <NULL/>
|
||||
@see isCellRangeListSource
|
||||
*/
|
||||
::rtl::OUString getStringAddressFromCellListSource(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XListEntrySource >& _rxSource
|
||||
) const;
|
||||
|
||||
/** returns the current binding of our control model, if any.
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >
|
||||
getCurrentBinding( ) const;
|
||||
|
||||
/** returns the current external list source of the control model, if any
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XListEntrySource >
|
||||
getCurrentListSource( ) const;
|
||||
|
||||
/** sets a new binding for our control model
|
||||
@precond
|
||||
the control model is bindable (which is implied by <member>isCellBindingAllowed</member>
|
||||
returning <TRUE/>)
|
||||
*/
|
||||
void setBinding(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >& _rxBinding
|
||||
);
|
||||
|
||||
/** sets a list source for our control model
|
||||
@precond
|
||||
the control model is a list sink (which is implied by <member>isListCellRangeAllowed</member>
|
||||
returning <TRUE/>)
|
||||
*/
|
||||
void setListSource(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XListEntrySource >& _rxSource
|
||||
);
|
||||
|
||||
/** checks whether it's possible to bind the control model to a spreadsheet cell
|
||||
*/
|
||||
bool isCellBindingAllowed( ) const;
|
||||
|
||||
/** checks whether it's possible to bind the control model to a spreadsheet cell,
|
||||
with exchanging integer values
|
||||
*/
|
||||
bool isCellIntegerBindingAllowed( ) const;
|
||||
|
||||
/** checks whether it's possible to bind the control model to range of spreadsheet cells
|
||||
supplying the list entries
|
||||
*/
|
||||
bool isListCellRangeAllowed( ) const;
|
||||
|
||||
/** checks whether a given binding is a spreadsheet cell binding
|
||||
*/
|
||||
bool isCellBinding(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >& _rxBinding
|
||||
) const;
|
||||
|
||||
/** checks whether a given binding is a spreadsheet cell binding, exchanging
|
||||
integer values
|
||||
*/
|
||||
bool isCellIntegerBinding(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XValueBinding >& _rxBinding
|
||||
) const;
|
||||
|
||||
/** checks whether a given list source is a spreadsheet cell list source
|
||||
*/
|
||||
bool isCellRangeListSource(
|
||||
const ::com::sun::star::uno::Reference< ::drafts::com::sun::star::form::XListEntrySource >& _rxSource
|
||||
) const;
|
||||
|
||||
protected:
|
||||
/** creates an address object from a string representation of a cell address
|
||||
*/
|
||||
bool convertStringAddress(
|
||||
const ::rtl::OUString& _rAddressDescription,
|
||||
::com::sun::star::table::CellAddress& /* [out] */ _rAddress
|
||||
) const;
|
||||
|
||||
/** creates an address range object from a string representation of a cell range address
|
||||
*/
|
||||
bool convertStringAddress(
|
||||
const ::rtl::OUString& _rAddressDescription,
|
||||
::com::sun::star::table::CellRangeAddress& /* [out] */ _rAddress
|
||||
) const;
|
||||
|
||||
/** retrieves the index of the sheet which our control belongs to
|
||||
@return the index of the sheet which our control belongs to or -1, if an error occured
|
||||
*/
|
||||
sal_Int16 getControlSheetIndex( ) const;
|
||||
|
||||
/** determines if our document is a spreadsheet document, *and* can supply
|
||||
the given service
|
||||
*/
|
||||
bool isSpreadsheetDocumentWhichSupplies( const ::rtl::OUString& _rService ) const;
|
||||
|
||||
/** checkes whether a given component supports a given servive
|
||||
*/
|
||||
bool doesComponentSupport(
|
||||
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxComponent,
|
||||
const ::rtl::OUString& _rService
|
||||
) const;
|
||||
|
||||
/** uses the document (it's factory interface, respectively) to create a component instance
|
||||
@param _rService
|
||||
the service name
|
||||
@param _rArgumentName
|
||||
the name of the single argument to pass during creation. May be empty, in this case
|
||||
no arguments are passed
|
||||
@param _rArgumentValue
|
||||
the value of the instantiation argument. Not evaluated if <arg>_rArgumentName</arg>
|
||||
is empty.
|
||||
*/
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
|
||||
createDocumentDependentInstance(
|
||||
const ::rtl::OUString& _rService,
|
||||
const ::rtl::OUString& _rArgumentName,
|
||||
const ::com::sun::star::uno::Any& _rArgumentValue
|
||||
) const;
|
||||
|
||||
/** converts an address representation into another one
|
||||
|
||||
@param _rInputProperty
|
||||
the input property name for the conversion service
|
||||
@param _rInputValue
|
||||
the input property value for the conversion service
|
||||
@param _rOutputProperty
|
||||
the output property name for the conversion service
|
||||
@param _rOutputValue
|
||||
the output property value for the conversion service
|
||||
@param _bIsRange
|
||||
if <TRUE/>, the RangeAddressConversion service will be used, else
|
||||
the AddressConversion service
|
||||
|
||||
@return
|
||||
<TRUE/> if any only if the conversion was successfull
|
||||
|
||||
@see com::sun::star::table::CellAddressConversion
|
||||
@see com::sun::star::table::CellRangeAddressConversion
|
||||
*/
|
||||
bool doConvertAddressRepresentations(
|
||||
const ::rtl::OUString& _rInputProperty,
|
||||
const ::com::sun::star::uno::Any& _rInputValue,
|
||||
const ::rtl::OUString& _rOutputProperty,
|
||||
::com::sun::star::uno::Any& _rOutputValue,
|
||||
bool _bIsRange
|
||||
) const SAL_THROW(());
|
||||
};
|
||||
|
||||
//............................................................................
|
||||
} // namespace pcr
|
||||
//............................................................................
|
||||
|
||||
#endif EXTENSIONS_PROPCTRLR_CELLBINDINGHELPER_HXX
|
||||
Loading…
Reference in a new issue