summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl')
-rw-r--r--offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl71
1 files changed, 71 insertions, 0 deletions
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
+