summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/inspection/XPropertyControlFactory.idl')
-rw-r--r--offapi/com/sun/star/inspection/XPropertyControlFactory.idl69
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
new file mode 100644
index 000000000..3429647b8
--- /dev/null
+++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl
@@ -0,0 +1,69 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_inspection_XPropertyControlFactory_idl__
+#define __com_sun_star_inspection_XPropertyControlFactory_idl__
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+module com { module sun { module star { module inspection {
+
+interface XPropertyControl;
+
+/** a factory for XPropertyControls
+
+ @since OOo 2.0.3
+*/
+interface XPropertyControlFactory
+{
+ /** creates a XPropertyControl
+
+ <p>A XPropertyControlFactory can create any of the control types denoted by
+ the PropertyControlType constants.</p>
+
+ @param ControlType
+ the type of the requested control
+
+ @param CreateReadOnly
+ determines whether the newly created control should be readonly.
+
+ <p>If this argument is `TRUE`, this does not necessarily mean that the property cannot be
+ changed at all in the ObjectInspector. Instead, an XPropertyHandler
+ can still decide that there is a dedicated UI for entering the property value,
+ which is usually triggered by a LineDescriptor::PrimaryButton.</p>
+
+ <p>Note that this parameter might be ignored if the XObjectInspectorModel::IsReadOnly
+ attribute is `TRUE`, in which case all created property controls must be readonly.</p>
+
+ @returns
+ a control of the given type.
+
+ @throws com::sun::star::lang::IllegalArgumentException
+ if the given ControlType is not a value PropertyControlType
+ */
+ XPropertyControl createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
+ raises ( com::sun::star::lang::IllegalArgumentException );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */