summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/TableValidation.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sheet/TableValidation.idl')
-rw-r--r--offapi/com/sun/star/sheet/TableValidation.idl117
1 files changed, 117 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl
new file mode 100644
index 000000000..6a2943f32
--- /dev/null
+++ b/offapi/com/sun/star/sheet/TableValidation.idl
@@ -0,0 +1,117 @@
+/* -*- 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_sheet_TableValidation_idl__
+#define __com_sun_star_sheet_TableValidation_idl__
+
+#include <com/sun/star/sheet/XSheetCondition.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/sheet/ValidationType.idl>
+#include <com/sun/star/sheet/ValidationAlertStyle.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** represents the data validation settings for a cell or cell range.
+ */
+published service TableValidation
+{
+
+ interface com::sun::star::beans::XPropertySet;
+
+ interface com::sun::star::sheet::XSheetCondition;
+
+
+ /** specifies the type of validation.
+ */
+ [property] com::sun::star::sheet::ValidationType Type;
+
+
+ /** specifies if an input message is shown when the cursor is in a
+ cell with these validation settings.
+ */
+ [property] boolean ShowInputMessage;
+
+
+ /** specifies the title of the window showing the input message.
+
+ <p>This is only used if TableValidation::ShowInputMessage
+ is set to `TRUE`.</p>
+ */
+ [property] string InputTitle;
+
+
+ /** specifies the text of the input message.
+
+ <p>This is only used if TableValidation::ShowInputMessage
+ is set to `TRUE`.</p>
+ */
+ [property] string InputMessage;
+
+
+ /** specifies if an error message is displayed when invalid data
+ is entered.
+ */
+ [property] boolean ShowErrorMessage;
+
+
+ /** specifies the title of the window showing the error message.
+
+ <p>This is only used if TableValidation::ShowErrorMessage
+ is set to `TRUE`.</p>
+ */
+ [property] string ErrorTitle;
+
+
+ /** specifies the text of the error message.
+
+ <p>This is only used if TableValidation::ShowErrorMessage
+ is set to `TRUE`.</p>
+ */
+ [property] string ErrorMessage;
+
+
+ /** specifies if blank cells should be allowed.
+ */
+ [property] boolean IgnoreBlankCells;
+
+
+ /** specifies the style of the error message.
+
+ <p>This is used only if TableValidation::ShowErrorMessage
+ is set to `TRUE`.</p>
+ */
+ [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle;
+
+
+ /** specifies if the list of possible values should be shown on the cell and how.
+
+ See also TableValidationVisibility
+ */
+ [optional,property] short ShowList;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */