update dev300-m58
[ooovba.git] / offapi / com / sun / star / form / inspection / SubmissionPropertyHandler.idl
blobfcd07e05ee46cc407750f2d9f98aa83410b7849e
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: SubmissionPropertyHandler.idl,v $
10 * $Revision: 1.3 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_form_inspection_SubmissionPropertyHandler_idl__
32 #define __com_sun_star_form_inspection_SubmissionPropertyHandler_idl__
34 #ifndef __com_sun_star_inspection_XPropertyHandler_idl__
35 #include <com/sun/star/inspection/XPropertyHandler.idl>
36 #endif
38 //=============================================================================
40 module com { module sun { module star { module form { module inspection {
42 //=============================================================================
44 /** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
45 which provides properties for button controls which support submission of XML forms.
47 <p>The handler expects a value named "ContextDocument" in the context in which it is created.
48 That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the
49 <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this
50 value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type>
51 interface), this document is used to examine the XML submissions which the button can be bound to.</p>
53 @see com::sun::star::inspection::XPropertyHandler
54 @see com::sun::star::form::submission::XSubmission
55 @see com::sun::star::form::submission::XSubmissionProvider
56 @see com::sun::star::form::component::SubmitButton
57 @see com::sun::star::xforms::XSubmission
58 @see com::sun::star::uno::XComponentContext::getValueByName
60 service SubmissionPropertyHandler
62 interface com::sun::star::inspection::XPropertyHandler;
65 //=============================================================================
67 }; }; }; }; };
69 #endif