diff options
Diffstat (limited to 'offapi/com/sun/star/xforms')
| -rw-r--r-- | offapi/com/sun/star/xforms/Binding.idl | 94 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/InvalidDataOnSubmitException.idl | 57 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XDataTypeRepository.idl | 120 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XFormsEvent.idl | 43 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XFormsSupplier.idl | 65 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XFormsUIHelper1.idl | 165 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XModel.idl | 238 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/XSubmission.idl | 76 | ||||
| -rw-r--r-- | offapi/com/sun/star/xforms/makefile.mk | 55 |
9 files changed, 913 insertions, 0 deletions
diff --git a/offapi/com/sun/star/xforms/Binding.idl b/offapi/com/sun/star/xforms/Binding.idl new file mode 100644 index 000000000000..8885d56a4d9e --- /dev/null +++ b/offapi/com/sun/star/xforms/Binding.idl @@ -0,0 +1,94 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_Binding_idl__ +#define __com_sun_star_xforms_Binding_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_form_binding_ValueBinding_idl__ +#include <com/sun/star/form/binding/ValueBinding.idl> +#endif + +#ifndef __com_sun_star_form_binding_ListEntrySource_idl__ +#include <com/sun/star/form/binding/ListEntrySource.idl> +#endif + +#ifndef __com_sun_star_form_validation_XValidator_idl__ +#include <com/sun/star/form/validation/XValidator.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module xforms { + +interface XSubmission; + +//============================================================================= + +/** represent a binding to one or more nodes in the DOM tree of an <type>XModel</type>. + */ +service Binding +{ + /** allows the binding to act as value supplier for a form component + + @see com::sun::star::form::binding::BindableControlModel + */ + service com::sun::star::form::binding::ValueBinding; + + /** allows external instances to observe the value represented by the binding + + <p>This interface is an optional part of the + <type scope="com::sun::star::form::binding">ValueBinding</type> servce, but loses + its optionality here.</p> + */ + interface com::sun::star::util::XModifyBroadcaster; + + /** allows the binding to act as source for list entries of form controls + + <p>If a binding is associated with more than one node in a DOM tree, it + does not represent a single value, but a list of values. Using this interface, + this list can be displayed in form control list and combo boxes.</p> + */ + service com::sun::star::form::binding::ListEntrySource; + + /** allows the binding to act as validator for a form component + + @see com::sun::star::form::binding::ValidatableControlModel + */ + interface com::sun::star::form::validation::XValidator; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/xforms/InvalidDataOnSubmitException.idl b/offapi/com/sun/star/xforms/InvalidDataOnSubmitException.idl new file mode 100644 index 000000000000..62174ddb8573 --- /dev/null +++ b/offapi/com/sun/star/xforms/InvalidDataOnSubmitException.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +#ifndef __com_sun_star_xforms_InvalidDataOnSubmitException_idl__ +#define __com_sun_star_xforms_InvalidDataOnSubmitException_idl__ + +#ifndef __com_sun_star_util_VetoException_idl__ +#include <com/sun/star/util/VetoException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module xforms { + +//============================================================================= + +/** thrown if the user triggers an XForms submission with invalid + instance data + + The <member scope="com::sun::star::uno">Exception::Source</member> member + refers to the submission which was invoked. + +*/ +exception InvalidDataOnSubmitException : com::sun::star::util::VetoException +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/xforms/XDataTypeRepository.idl b/offapi/com/sun/star/xforms/XDataTypeRepository.idl new file mode 100644 index 000000000000..f2c2f1d2fd67 --- /dev/null +++ b/offapi/com/sun/star/xforms/XDataTypeRepository.idl @@ -0,0 +1,120 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +#ifndef __com_sun_star_xsd_XDataTypeRepository_idl__ +#define __com_sun_star_xsd_XDataTypeRepository_idl__ + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif +#ifndef __com_sun_star_xsd_XDataType_idl__ +#include <com/sun/star/xsd/XDataType.idl> +#endif +#ifndef __com_sun_star_container_NoSuchElementException_idl__ +#include <com/sun/star/container/NoSuchElementException.idl> +#endif +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif +#ifndef __com_sun_star_util_VetoException_idl__ +#include <com/sun/star/util/VetoException.idl> +#endif + + +//============================================================================= +module com { module sun { module star { module xforms { + +//----------------------------------------------------------------------------- +/** specifies a repository of XSD data types + + <p>The elements of the repository are instances supporting the <type scope="com::sun::star::xsd">XDataType</type> + interface.</p> +*/ +interface XDataTypeRepository +{ + /** provides access to an enumeration of the contained data types + */ + interface com::sun::star::container::XEnumerationAccess; + + /** provides untyped access to the elements of the repository, as well as meta information + such as the names of all contained types, and the existence of a named type + */ + interface com::sun::star::container::XNameAccess; + + /** retrieves the basic type for the given type class + + @see com::sun::star::xsd::DataTypeClass + + @throws com::sun::star::container::NoSuchElementException + if in the repository, there is no data type with the given class + */ + com::sun::star::xsd::XDataType + getBasicDataType( [in] short dataTypeClass ) + raises ( com::sun::star::container::NoSuchElementException ); + + /** creates a clone of the given data type, and inserts it into the repository + + @throws com::sun::star::container::NoSuchElementException + if the given name does not refer to a type in the repository + + @throws com::sun::star::container::ElementExistException + if the new name is already used in the repository + */ + com::sun::star::xsd::XDataType + cloneDataType( [in] string sourceName, [in] string newName ) + raises( com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException ); + + /** removes a data type given by name from the repository + + @throws com::sun::star::container::NoSuchElementException + if the given name does not refer to a type in the repository + + @throws com::sun::star::util::VetoException + if the specified data type is a built-in (basic) data type, and cannot + be removed + + @see com::sun::star::xsd::XDataType + */ + void + revokeDataType( [in] string typeName ) + raises( com::sun::star::container::NoSuchElementException, com::sun::star::util::VetoException ); + + /** + */ + com::sun::star::xsd::XDataType + getDataType( [in] string typeName ) + raises( com::sun::star::container::NoSuchElementException ); +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/xforms/XFormsEvent.idl b/offapi/com/sun/star/xforms/XFormsEvent.idl new file mode 100644 index 000000000000..32fa94ec9ce9 --- /dev/null +++ b/offapi/com/sun/star/xforms/XFormsEvent.idl @@ -0,0 +1,43 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_XFormsEvent_idl__ +#define __com_sun_star_xforms_XFormsEvent_idl__ + +#include <com/sun/star/xml/dom/events/XEvent.idl> + +module com { module sun { module star { module xforms { + +interface XFormsEvent : com::sun::star::xml::dom::events::XEvent { + + void initXFormsEvent([in] string typeArg, + [in] boolean canBubbleArg, + [in] boolean cancelableArg); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/xforms/XFormsSupplier.idl b/offapi/com/sun/star/xforms/XFormsSupplier.idl new file mode 100644 index 000000000000..066cabc4918b --- /dev/null +++ b/offapi/com/sun/star/xforms/XFormsSupplier.idl @@ -0,0 +1,65 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_XFormsSupplier_idl__ +#define __com_sun_star_xforms_XFormsSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module xforms { + +//============================================================================= + +/** provides access to the XForms models contained in the component + */ +interface XFormsSupplier: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + /** access XForms model container. + @returns a container for the XForms models contained in the component + */ + com::sun::star::container::XNameContainer getXForms(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/xforms/XFormsUIHelper1.idl b/offapi/com/sun/star/xforms/XFormsUIHelper1.idl new file mode 100644 index 000000000000..35488ba2883d --- /dev/null +++ b/offapi/com/sun/star/xforms/XFormsUIHelper1.idl @@ -0,0 +1,165 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_XFormsUIHelper1_idl__ +#define __com_sun_star_xforms_XFormsUIHelper1_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_xml_dom_XNode_idl__ +#include <com/sun/star/xml/dom/XNode.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XSet.idl> +#endif + +#ifndef __com_sun_star_xforms_XDataTypeRepository_idl__ +#include <com/sun/star/xforms/XDataTypeRepository.idl> +#endif + +#ifndef __com_sun_star_xml_dom_XDocument_idl__ +#include <com/sun/star/xml/dom/XDocument.idl> +#endif + +#ifndef __com_sun_star_xml_dom_XDocument_idl__ +#include <com/sun/star/xml/dom/XNode.idl> +#endif + +#ifndef __com_sun_star_frame_XModel_idl__ +#include <com/sun/star/frame/XModel.idl> +#endif + +#ifndef __com_sun_star_xforms_XModel_idl__ +#include <com/sun/star/xforms/XModel.idl> +#endif + + +//============================================================================= + +module com { module sun { module star { module xforms { + +//============================================================================= + +/** provide several helper methods for the UI + + <b>This interfaces is for UI use only, and will likely be unsupported in + future versions.</p> +*/ +interface XFormsUIHelper1 +{ + string getDefaultServiceNameForNode( [in] com::sun::star::xml::dom::XNode xNode ); + + string getDefaultBindingExpressionForNode( [in] com::sun::star::xml::dom::XNode xNode ); + + string getNodeDisplayName( [in] com::sun::star::xml::dom::XNode xNode, + [in] boolean bDetail ); + + string getNodeName( [in] com::sun::star::xml::dom::XNode xNode ); + + string getBindingName( [in] com::sun::star::beans::XPropertySet xBinding, + [in] boolean bDetail ); + + string getSubmissionName( [in] com::sun::star::beans::XPropertySet xSubm, + [in] boolean bDetail ); + + // Creates a new binding based on the one passed as argument. + // The new binding does *not* contribute to the MIPs table and acts + // as a propertyset in disguise, which is what the UI needs this object for... + com::sun::star::beans::XPropertySet cloneBindingAsGhost( [in] com::sun::star::beans::XPropertySet binding ); + + void removeBindingIfUseless( [in] com::sun::star::beans::XPropertySet xBinding ); + + // handle instances + + com::sun::star::xml::dom::XDocument newInstance( [in] string sName, + [in] string sURL, + [in] boolean bURLOnce ); + + void renameInstance( [in] string sFrom, [in] string sTo, + [in] string sURL, + [in] boolean bURLOnce ); + + void removeInstance( [in] string sName ); + + + // handle models + com::sun::star::xforms::XModel newModel( [in] com::sun::star::frame::XModel xModel, + [in] string sName ); + void renameModel( [in] com::sun::star::frame::XModel xModel, + [in] string sFrom, [in] string sTo ); + void removeModel( [in] com::sun::star::frame::XModel xModel, + [in] string sName ); + + + // DOM helpers + com::sun::star::xml::dom::XNode + createElement( [in] com::sun::star::xml::dom::XNode xParent, + [in] string sName ); + com::sun::star::xml::dom::XNode + createAttribute( [in] com::sun::star::xml::dom::XNode xParent, + [in] string sName ); + + com::sun::star::xml::dom::XNode renameNode( + [in] com::sun::star::xml::dom::XNode xNode, + [in] string sName ); + + com::sun::star::beans::XPropertySet getBindingForNode( + [in] com::sun::star::xml::dom::XNode xNode, + [in] boolean bCreate ); + + void removeBindingForNode( + [in] com::sun::star::xml::dom::XNode xNode ); + + string getResultForExpression( + [in] com::sun::star::beans::XPropertySet xBinding, + [in] boolean bIsBindingExpression, + [in] string sExpression ); + + boolean isValidXMLName( [in] string sName ); + + boolean isValidPrefixName( [in] string sName ); + + void setNodeValue( + [in] com::sun::star::xml::dom::XNode xNode, + [in] string sValue ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/xforms/XModel.idl b/offapi/com/sun/star/xforms/XModel.idl new file mode 100644 index 000000000000..ea2e71bdd39a --- /dev/null +++ b/offapi/com/sun/star/xforms/XModel.idl @@ -0,0 +1,238 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_XModel_idl__ +#define __com_sun_star_xforms_XModel_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XSet.idl> +#endif + +#ifndef __com_sun_star_xforms_XDataTypeRepository_idl__ +#include <com/sun/star/xforms/XDataTypeRepository.idl> +#endif + +#ifndef __com_sun_star_xml_dom_XDocument_idl__ +#include <com/sun/star/xml/dom/XDocument.idl> +#endif + +#ifndef __com_sun_star_util_VetoException_idl__ +#include <com/sun/star/util/VetoException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module xforms { + +interface XSubmission; + +//============================================================================= + +/** represent an XForms model + */ +interface XModel +{ + /** get the XForms model ID */ + string getID(); + + /** set the XForms model ID */ + void setID( [in] string id ); + + + /** initialize the model */ + void initialize(); + + /** rebuild the model */ + void rebuild(); + + /** re-evaluate all calculate attributes */ + void recalculate(); + + /** re-evaluate all validity attributes */ + void revalidate(); + + /** refresh the model */ + void refresh(); + + + /** submit form through given submission id + + <p>This is a convenience method. Calling it is equivalent to calling + <code><member>getSubmission</member>( <arg>id</arg> ).submit()</code>.</p> + + @param id + the ID of the submission to execute + + @throws com::sun::star::util::VetoException + when the current model state does not allow a submission. Usually, this indicates that + consistency criteria for the model data is not fulfilled. + + @throws com::sun::star::lang::WrappedTargetException + when another error occured during the submission. The + <member scope="com::sun::star::lang">WrappedTargetException::TargetException</member> describes + this error then. + */ + void submit( [in] string id ) + raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); + + /** submit form through given submission id + + <p>This is a convenience method. Calling it is equivalent to calling + <code><member>getSubmission</member>( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> + + @param id + the ID of the submission to execute + + @param aHandler + This handler allows additional user interaction, which may be necessary before + the submission can be performed. + + @throws com::sun::star::util::VetoException + when the current model state does not allow a submission. Usually, this indicates that + consistency criteria for the model data is not fulfilled. + + @throws com::sun::star::lang::WrappedTargetException + when another error occured during the submission. The + <member scope="com::sun::star::lang">WrappedTargetException::TargetException</member> describes + this error then. + */ + void submitWithInteraction( [in] string id, [in] com::sun::star::task::XInteractionHandler aHandler ) + raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); + + /** provides management access to the XSD data types associated with the model + */ + XDataTypeRepository + getDataTypeRepository( ); + + + // + // instances + // + + /** gets container containing all instances; + + <p>The elements of the set are arrays of <type scope="com::sun::star::beans">PropertyValue</type>s, + containing the ID, the URL, and the instance itself.</p> + */ + com::sun::star::container::XSet getInstances(); + + /** retrieves the instance with the given id + */ + com::sun::star::xml::dom::XDocument getInstanceDocument( [in] string id ); + + /** get the default instance for this model + */ + com::sun::star::xml::dom::XDocument getDefaultInstance(); + + + // + // bindings + // + + /** create a binding element for this model + + <p>The returned binding still needs to be inserted into the bindings container.</p> + + @see getBindings + */ + com::sun::star::beans::XPropertySet createBinding(); + + /** clone an arbitrary binding element for this model; still needs + + <p>The returned binding still needs to be inserted into the bindings container.</p> + + @see getBindings + */ + com::sun::star::beans::XPropertySet cloneBinding( [in] com::sun::star::beans::XPropertySet binding ); + + /** get a binding with a certain ID + + <p>This is a convenience method: the same result can also be obtained through + <member>getBindings</member></p> + */ + com::sun::star::beans::XPropertySet getBinding( [in] string id ); + + /** get a container containing all bindings; also supports XNameAccess + */ + com::sun::star::container::XSet getBindings(); + + + // + // submissions + // + + /** create a submission element for this model + + <p>The returned submission element still needs to be inserted into the submission container.</p> + + @see getSubmissions + */ + XSubmission createSubmission(); + + /** clone an arbitrary submission element for this model + + <p>The returned submission element still needs to be inserted into the submission container.</p> + + @see getSubmissions + */ + XSubmission cloneSubmission( [in] com::sun::star::beans::XPropertySet submission ); + + /** get a submission with a certain ID. + + <p>This is a convenience method: the same result can also be obtained through + <member>getSubmissions</member>.</p> + */ + XSubmission getSubmission( [in] string id ); + + /** get container containing all submissions; also supports XNameAccess + */ + com::sun::star::container::XSet getSubmissions(); +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/xforms/XSubmission.idl b/offapi/com/sun/star/xforms/XSubmission.idl new file mode 100644 index 000000000000..a7c11f661666 --- /dev/null +++ b/offapi/com/sun/star/xforms/XSubmission.idl @@ -0,0 +1,76 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +#ifndef __com_sun_star_xsd_XSubmission_idl__ +#define __com_sun_star_xsd_XSubmission_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif +#ifndef __com_sun_star_form_submission_XSubmission_idl__ +#include <com/sun/star/form/submission/XSubmission.idl> +#endif + +//============================================================================= +module com { module sun { module star { module xforms { + +//----------------------------------------------------------------------------- +/** specifies a submission object, associated with an <type>XModel</type> +*/ +interface XSubmission +{ + /** allows access to the submission's properties + */ + interface com::sun::star::beans::XPropertySet; + + /** allows access to the name of the submission + + <p>Note that the name of the submission always equals it's the value of its ID + property./p> + */ + interface com::sun::star::container::XNamed; + + /** allows the submission to be associated with certain form controls + + <p>Calling the <member scope="com::sun::star::form::submission">XSubmission::submit</member> + yields exactly the same result as calling <member>XModel::submit</member> of the model which + the submission belongs to, passing the ID of the submission.</p> + */ + interface com::sun::star::form::submission::XSubmission; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/xforms/makefile.mk b/offapi/com/sun/star/xforms/makefile.mk new file mode 100644 index 000000000000..ff09cb53537e --- /dev/null +++ b/offapi/com/sun/star/xforms/makefile.mk @@ -0,0 +1,55 @@ +#************************************************************************* +# +# 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. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=offapi + +TARGET=cssxforms +PACKAGE=com$/sun$/star$/xforms + +# --- Settings ----------------------------------------------------- + +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + XFormsSupplier.idl\ + XModel.idl \ + XDataTypeRepository.idl \ + XFormsEvent.idl \ + XFormsUIHelper1.idl \ + XSubmission.idl \ + Binding.idl \ + InvalidDataOnSubmitException.idl \ + + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |