diff options
Diffstat (limited to 'offapi/com/sun/star/form/inspection')
10 files changed, 724 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl new file mode 100644 index 000000000000..17b40b58dc67 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl @@ -0,0 +1,68 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: ButtonNavigationHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_ButtonNavigationHandler_idl__ +#define __com_sun_star_form_ButtonNavigationHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which is able to enhance the <member scope="com::sun::star::form::component">CommandButton::ButtonType</member> + and <member scope="com::sun::star::form::component">CommandButton::TargetURL</member> properties of a + <type scope="com::sun::star::form::component">CommandButton</type>. + + <p>For this, the two properties are superseded by new versions, where as button type, additional + possible values are added for navigating the parent form of the button. For instance, in an + <type scope="com::sun::star::inspection">ObjectInspector</type> using this handler, the user will be able + to choose a button type saying "move to the next record", which, when chosen, well, moves the parent + database form of the button to the next record.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::component::CommandButton +*/ +service ButtonNavigationHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl new file mode 100644 index 000000000000..46f789674bf9 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: CellBindingPropertyHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_inspection_CellBindingPropertyHandler_idl__ +#define __com_sun_star_form_inspection_CellBindingPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which is able to provide properties to bind a form component to a spreadsheet cell. + + <p>The handler expects a value named "ContextDocument" in the context in which it is created. + That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type> + interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s + to bind the inspected object to cells in this document.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::binding::BindableControlModel + @see com::sun::star::form::binding::ValueBinding + @see com::sun::star::table::CellValueBinding + @see com::sun::star::table::ListPositionCellBinding + @see com::sun::star::uno::XComponentContext::getValueByName +*/ +service CellBindingPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl new file mode 100644 index 000000000000..abd3c085b60d --- /dev/null +++ b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl @@ -0,0 +1,104 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: DefaultFormComponentInspectorModel.idl,v $ + * $Revision: 1.5 $ + * + * 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_form_DefaultFormComponentInspectorModel_idl__ +#define __com_sun_star_form_DefaultFormComponentInspectorModel_idl__ + +#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__ +#include <com/sun/star/inspection/XObjectInspectorModel.idl> +#endif +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for + inspecting form components, in particular all components implementing the <type>FormComponent</type> + service. + + <p>A <type>DefaultFormComponentInspectorModel</type> provides the following handlers by default: + <ul><li><type>ButtonNavigationHandler</type></li> + <li><type>CellBindingPropertyHandler</type></li> + <li><type>EditPropertyHandler</type></li> + <li><type>EventHandler</type></li> + <li><type>FormComponentPropertyHandler</type></li> + <li><type>SubmissionPropertyHandler</type></li> + <li><type>XMLFormsPropertyHandler</type></li> + <li><type>XSDValidationPropertyHandler</type></li> + </ul></p> + + @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories +*/ +service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel +{ + /** creates a default DefaultFormComponentInspectorModel, providing factories for all + handlers listed above. + + @since OOo 2.2.0 + */ + createDefault(); + + /** creates a default DefaultFormComponentInspectorModel, providing factories for all + handlers listed above, and describing an ObjectInspector which has a help section. + + @param minHelpTextLines + denotes the minimum number of lines of text to be reserved for the help + section. + + @param maxHelpTextLines + denotes the maximum number of lines of text to be reserved for the help + section. + + @throws ::com::sun::star::lang::IllegalArgumentException + if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative, + or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>. + + @see XObjectInspectorModel::HasHelpSection + @see XObjectInspectorModel::MinHelpTextLines + @see XObjectInspectorModel::MaxHelpTextLines + + @since OOo 2.2.0 + */ + createWithHelpSection( + [in] long minHelpTextLines, + [in] long maxHelpTextLines + ) + raises ( ::com::sun::star::lang::IllegalArgumentException ); +}; + +//============================================================================= + +}; }; }; }; }; + +#endif diff --git a/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl new file mode 100644 index 000000000000..97936b5d8c12 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl @@ -0,0 +1,72 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: EditPropertyHandler.idl,v $ + * $Revision: 1.4 $ + * + * 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_form_inspection_EditPropertyHandler_idl__ +#define __com_sun_star_form_inspection_EditPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which provides convinience wrappers for some properties existing at a form component + derived from <type scope="com::sun::star::awt">UnoControlEditModel</type>. + + <p>First, the handler supersedes the HScroll and the VScroll properties of a <type scope="com::sun::star::awt">UnoControlEditModel</type> + and puts them into one common property, allowing the user to choose whether she want to + have "no", a "vertical", a "horizontal", or "both" scrollbars.<p> + + <p>Second, if it detects a <type scope="com::sun::star::form::component">RichTextControl</type> to inspect, + it supersedes the <member scope="com::sun::star::form::component">RichTextControl::RichText</member> + and the <member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member> properties with a new + one which allows choosing the text type with one single action.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::awt::UnoControlEditModel + @see com::sun::star::form::component::RichTextControl + @see com::sun::star::form::component::TextField +*/ +service EditPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/EventHandler.idl b/offapi/com/sun/star/form/inspection/EventHandler.idl new file mode 100644 index 000000000000..170b5b641270 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/EventHandler.idl @@ -0,0 +1,66 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: EventHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_EventHandler_idl__ +#define __com_sun_star_form_EventHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which, for a <type scope="com::sun::star::form">FormComponent</type>, provides the script events + offered by this form component. + + <p>For this, the parent of the form component, which by definition supports the <type scope="com::sun::star::form">FormComponent</type> + service, is examined for the <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::component::CommandButton + @see com::sun::star::form::FormComponents + @see com::sun::star::script::XEventAttacherManager +*/ +service EventHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl new file mode 100644 index 000000000000..deac74eb4cbf --- /dev/null +++ b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl @@ -0,0 +1,59 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: FormComponentPropertyHandler.idl,v $ + * $Revision: 1.4 $ + * + * 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_form_inspection_FormComponentPropertyHandler_idl__ +#define __com_sun_star_form_inspection_FormComponentPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements the default property handler for all known types of <type scope="com::sun::star::form">FormComponent</type>s. + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::FormComponents +*/ +service FormComponentPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl new file mode 100644 index 000000000000..cb79caf34675 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl @@ -0,0 +1,70 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: SubmissionPropertyHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_inspection_SubmissionPropertyHandler_idl__ +#define __com_sun_star_form_inspection_SubmissionPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which provides properties for button controls which support submission of XML forms. + + <p>The handler expects a value named "ContextDocument" in the context in which it is created. + That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + interface), this document is used to examine the XML submissions which the button can be bound to.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::submission::XSubmission + @see com::sun::star::form::submission::XSubmissionProvider + @see com::sun::star::form::component::SubmitButton + @see com::sun::star::xforms::XSubmission + @see com::sun::star::uno::XComponentContext::getValueByName +*/ +service SubmissionPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl new file mode 100644 index 000000000000..2a1e7be67032 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl @@ -0,0 +1,76 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XMLFormsPropertyHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_inspection_XMLFormsPropertyHandler_idl__ +#define __com_sun_star_form_inspection_XMLFormsPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which provides properties related to binding form control models to XForm bindings. + + <p>The handler introduces new properties to choose an <type scope="com::sun::star::xforms">XModel</type> + and a <type scope="com::sun::star::xforms">Binding</type> within this model. Additionally, + it introduces properties which reflect the different facets of the binding (e.g. + <member scope="com::sun::star::xforms">Binding::BindingExpression</member>), so they can be changed + directly in the <type scope="com::sun::star::inspection">ObjectInspector</type> as if they were a + property of the form component which is being inspected.</p> + + <p>The handler expects a value named "ContextDocument" in the context in which it is created. + That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + interface), this document is used to do XML binding related work.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::binding::BindableControlModel + @see com::sun::star::form::binding::ValueBinding + @see com::sun::star::xforms::Binding + @see com::sun::star::uno::XComponentContext::getValueByName +*/ +service XMLFormsPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl new file mode 100644 index 000000000000..aa1972fed751 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl @@ -0,0 +1,80 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: XSDValidationPropertyHandler.idl,v $ + * $Revision: 1.3 $ + * + * 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_form_inspection_XSDValidationPropertyHandler_idl__ +#define __com_sun_star_form_inspection_XSDValidationPropertyHandler_idl__ + +#ifndef __com_sun_star_inspection_XPropertyHandler_idl__ +#include <com/sun/star/inspection/XPropertyHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module form { module inspection { + +//============================================================================= + +/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> + which provides properties related to binding form control models to XForm bindings and validating + the form control content. + + <p>By using an <type>XMLFormsPropertyHandler</type>, an <type scope="com::sun::star::inspection">ObjectInspector</type> + can be used to bind form components to <type scope="com::sun::star::xforms">Binding</type> instances. + Since those instances also support validating form control content (by supporting an + <type scope="com::sun::star::form::validation">XValidator</type> interface), it seems reasonable to + edit those validate-related properties (like the XSD data type to validate against) in the + <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an <type>XSDValidationPropertyHandler</type> + is good for.</p> + + <p>The handler expects a value named "ContextDocument" in the context in which it is created. + That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + interface), this document is used to do XML binding related work.</p> + + @see com::sun::star::inspection::XPropertyHandler + @see com::sun::star::form::binding::BindableControlModel + @see com::sun::star::form::binding::ValueBinding + @see com::sun::star::forms::validation::ValidatableControlModel + @see com::sun::star::xforms::Binding + @see com::sun::star::xsd::XDataType + @see com::sun::star::uno::XComponentContext::getValueByName +*/ +service XSDValidationPropertyHandler +{ + interface com::sun::star::inspection::XPropertyHandler; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/form/inspection/makefile.mk b/offapi/com/sun/star/form/inspection/makefile.mk new file mode 100644 index 000000000000..73ab994f7440 --- /dev/null +++ b/offapi/com/sun/star/form/inspection/makefile.mk @@ -0,0 +1,58 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2008 by Sun Microsystems, Inc. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# $RCSfile: makefile.mk,v $ +# +# $Revision: 1.4 $ +# +# 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=cssfinsp +PACKAGE=com$/sun$/star$/form$/inspection + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + ButtonNavigationHandler.idl \ + CellBindingPropertyHandler.idl \ + DefaultFormComponentInspectorModel.idl \ + EditPropertyHandler.idl \ + EventHandler.idl \ + FormComponentPropertyHandler.idl \ + SubmissionPropertyHandler.idl \ + XMLFormsPropertyHandler.idl \ + XSDValidationPropertyHandler.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |