mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e46064a43b58e03ca5cd8f77cd6eea77706fa381
libreoffice/xmloff/source/forms/layerexport.hxx

393 lines
17 KiB
C++
Raw Blame History

/*************************************************************************
*
* $RCSfile: layerexport.hxx,v $
*
* $Revision: 1.13 $
*
* last change: $Author: fs $ $Date: 2002-10-25 08:00:10 $
*
* 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 _XMLOFF_FORMS_LAYEREXPORT_HXX_
#define _XMLOFF_FORMS_LAYEREXPORT_HXX_
#ifndef _COM_SUN_STAR_CONTAINER_XINDEXACCESS_HPP_
#include <com/sun/star/container/XIndexAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_SCRIPT_SCRIPTEVENTDESCRIPTOR_HPP_
#include <com/sun/star/script/ScriptEventDescriptor.hpp>
#endif
#ifndef _COM_SUN_STAR_UTIL_XNUMBERFORMATS_HPP_
#include <com/sun/star/util/XNumberFormats.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XCONTROLMODEL_HPP_
#include <com/sun/star/awt/XControlModel.hpp>
#endif
#ifndef _XMLOFF_FORMS_CALLBACKS_HXX_
#include "callbacks.hxx"
#endif
#ifndef _XMLOFF_FORMS_IFACECOMPARE_HXX_
#include "ifacecompare.hxx"
#endif
#ifndef _VOS_REF_HXX_
#include <vos/ref.hxx>
#endif
#ifndef _COMPHELPER_STLTYPES_HXX_
#include <comphelper/stl_types.hxx>
#endif
class SvXMLExport;
class SvXMLNumFmtExport;
class XMLPropertyHandlerFactory;
class SvXMLExportPropertyMapper;
//.........................................................................
namespace xmloff
{
//.........................................................................
typedef ::std::set< ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >, ::comphelper::OInterfaceCompare< ::com::sun::star::beans::XPropertySet > >
PropertySetBag;
//=====================================================================
//= OFormLayerXMLExport_Impl
//=====================================================================
/** the implementation class for OFormLayerXMLExport
*/
class OFormLayerXMLExport_Impl
:public IFormsExportContext
{
friend class OFormLayerXMLExport;
protected:
SvXMLExport& m_rContext;
SvXMLNumFmtExport* m_pControlNumberStyles;
// ignore list for control models
PropertySetBag m_aIgnoreList;
// style handling
::vos::ORef< XMLPropertyHandlerFactory > m_xPropertyHandlerFactory;
::vos::ORef< SvXMLExportPropertyMapper > m_xExportMapper;
// we need our own number formats supplier:
// Controls which have a number formats do not work with the formats supplier of the document they reside
// in, instead they use the formats of the data source their form is associated with. If there is no
// such form or no such data source, they work with an own formatter.
// Even more, time and date fields do not work with a central formatter at all, they have their own one
// (which is shared internally, but this is a (hidden) implementation detail.)
//
// To not contaminate the global (document) number formats supplier (which could be obtained from the context),
// we have an own one.
// (Contaminate means: If a user adds a user-defined format to a formatted field, this format is stored in
// in the data source's formats supplier. To export this _and_ reuse existing structures, we would need to
// add this format to the global (document) formats supplier.
// In case of an export we could do some cleanup afterwards, but in case of an import, there is no such
// chance, as (if other user-defined formats exist in the document as well) we can't distinguish
// between user-defined formats really beeded for the doc (i.e. in a calc cell) and formats only added
// to the supplier because the controls needed it.
::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormats >
m_xControlNumberFormats;
DECLARE_STL_MAP( ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >, ::rtl::OUString, OPropertySetCompare, MapPropertySet2String);
// maps objects (property sets) to strings, e.g. control ids.
DECLARE_STL_MAP( ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >, MapPropertySet2String, ODrawPageCompare, MapPropertySet2Map);
// map pages to maps (of property sets to strings)
MapPropertySet2Map m_aControlIds;
// the control ids of all control on all pages we ever examined
MapPropertySet2Map m_aReferringControls;
// for a given page (iter->first), and a given control (iter->second->first), this is the comma-separated
// lists of ids of the controls refering to the control given.
MapPropertySet2MapIterator
m_aCurrentPageIds;
// the iterator for the control id map for the page beeing handled
MapPropertySet2MapIterator
m_aCurrentPageReferring;
// the same for the map of referring controls
// TODO: To avoid this construct above, and to have a cleaner implementation, an class encapsulating the
// export of a single page should be introduced.
DECLARE_STL_MAP( ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >, sal_Int32, OPropertySetCompare, MapPropertySet2Int);
MapPropertySet2Int m_aControlNumberFormats;
// maps controls to format keys, which are relative to our own formats supplier
MapPropertySet2String m_aGridColumnStyles;
// style names of grid columns
public:
OFormLayerXMLExport_Impl(SvXMLExport& _rContext);
protected:
/** exports one single grid column
*/
void exportGridColumn(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn,
const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents
);
/** exports one single control
*/
void exportControl(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl,
const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents
);
/** exports one single form
*/
void exportForm(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxProps,
const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents
);
/** seek to the page given.
<p>This must be called before you can retrieve any ids for controls on the page.</p>
@see
getControlId
*/
sal_Bool seekPage(
const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& _rxDrawPage);
/** get the id of the given control.
<p>You must have sought to the page of the control before calling this.</p>
*/
::rtl::OUString
getControlId(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl);
/** retrieves the style name for the control's number style.
<p>For performance reasons, this method is allowed to be called for any controls, even those which
do not have a number style. In this case, an empty string is returned.</p>
*/
::rtl::OUString
getControlNumberStyle( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl );
// IFormsExportContext
virtual void exportCollectionElements(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxCollection);
virtual SvXMLExport& getGlobalContext();
virtual ::rtl::OUString getObjectStyleName(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxObject );
virtual ::vos::ORef< SvXMLExportPropertyMapper > getStylePropertyMapper();
/** clear any structures which have been build in the recent <method>examine</method> calls.
*/
void clear();
/** examine a forms collection.
<p>The method will collect control ids and add styles to the export context as necessary.</p>
<p>Every control in the object hierarchy given will be assigned to a unique id, which is stored for later
use.</p>
<p>In addition, any references the controls may have between each other, are collected and stored for
later use.</p>
<p>Upon calling this method, the id map will be cleared before collecting the new ids, so any ids
you collected previously will be lost</p>
@param _rxDrawPage
the draw page which's forms collection should be examined
@see getControlId
@see exportControl
@see exportForms
*/
void examineForms(
const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& _rxDrawPage);
/** export a forms collection of a draw page
<p>The method will obtain the forms collection of the page and call
<method>exportCollectionElements</method>.</p>
*/
void exportForms(
const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& _rxDrawPage);
/** exports the controls number styles
*/
void exportControlNumberStyles();
/** exports the automatic control number styles
*/
void exportAutoControlNumberStyles();
/** exports the auto-styles collected during the examineForms calls
*/
void exportAutoStyles();
protected:
sal_Bool implCheckPage(
const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& _rxDrawPage,
::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& _rxForms);
/** moves the m_aCurrentPage* members to the positions specifying the given page.
@return <TRUE/> if there already were structures for the given page
*/
sal_Bool implMoveIterators(
const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage >& _rxDrawPage,
sal_Bool _bClear);
/** check the object given if it's a control, if so, examine it.
@return <TRUE/> if the object has been handled
*/
sal_Bool checkExamineControl(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxObject);
/** examines the control's number format, so later the format style can be referred
<p>remembers the format key for the control, so it can later be asked for in getControlNumberStyle</p>
*/
void examineControlNumberFormat(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl);
/** examines the control's number format, so later the format style can be referred
<p>does not remember the information returned in any way</p>
*/
sal_Int32 implExamineControlNumberFormat( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxObject );
/** collects AutoStyles for grid columns
*/
void collectGridAutoStyles( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControl );
/** ensures that the number format of the given control exist in our own formats supplier.
<p>The given control is examined for it's format (i.e. it's FormatKey/FormatsSupplier properties),
and the format is added (if necessary) to m_xControlNumberFormats</p>.
@return
the format key of the control's format relative to our own formats supplier
*/
sal_Int32 ensureTranslateFormat(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxFormattedControl);
/// returns the instance exporting our control's number styles
SvXMLNumFmtExport* getControlNumberStyleExport();
/// ensures that the instance exporting our control's number styles exists
void ensureControlNumberStyleExport();
/** determines the number format style for the given object without remembering it
*/
::rtl::OUString
getImmediateNumberStyle( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxObject );
/** returns the prefix to be used for control number styles
*/
static const ::rtl::OUString& getControlNumberStyleNamePrefix();
/** exclude the given control (model) from export.
<p>If your document contains form controls which are not to be exported for whatever reason,
you need to announce the models of these controls (can be retrieved from XControlShape::getControl)
to the form layer exporter.<br/>
Of course you have to do this before calling <member>exportForms</member></p>
*/
void excludeFromExport( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > _rxControl );
};
//.........................................................................
} // namespace xmloff
//.........................................................................
#endif // _XMLOFF_FORMS_LAYEREXPORT_HXX_
/*************************************************************************
* history:
* $Log: not supported by cvs2svn $
* Revision 1.12 2002/09/25 12:04:19 fs
* #103597# +excludeFromExport/m_aIgnoreList
*
* Revision 1.11 2001/05/29 15:37:44 fs
* #86712# no explicit dtor anymore
*
* Revision 1.10 2001/05/28 14:59:18 fs
* #86712# added control number style related functionality
*
* Revision 1.9 2001/02/01 09:46:47 fs
* no own style handling anymore - the shape exporter is responsible for our styles now
*
* Revision 1.8 2001/01/02 15:58:22 fs
* event ex- & import
*
* Revision 1.7 2000/12/19 12:13:57 fs
* some changes ... now the exported styles are XSL conform
*
* Revision 1.6 2000/12/18 15:14:35 fs
* some changes ... now exporting/importing styles
*
* Revision 1.5 2000/12/13 10:40:15 fs
* new import related implementations - at this version, we should be able to import everything we export (which is all except events and styles)
*
* Revision 1.4 2000/12/06 17:28:05 fs
* changes for the formlayer import - still under construction
*
* Revision 1.3 2000/12/03 10:57:06 fs
* some changes to support more than one page to be examined/exported
*
* Revision 1.2 2000/11/19 15:41:32 fs
* extended the export capabilities - generic controls / grid columns / generic properties / some missing form properties
*
* Revision 1.1 2000/11/17 19:02:39 fs
* initial checkin - export and/or import the applications form layer
*
*
* Revision 1.0 17.11.00 17:21:00 fs
************************************************************************/
Reference in New Issue View Git Blame Copy Permalink