1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_TableValidation_idl__
25#define __com_sun_star_sheet_TableValidation_idl__
26
27#ifndef __com_sun_star_sheet_XSheetCondition_idl__
28#include <com/sun/star/sheet/XSheetCondition.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XPropertySet_idl__
32#include <com/sun/star/beans/XPropertySet.idl>
33#endif
34
35#ifndef __com_sun_star_sheet_ValidationType_idl__
36#include <com/sun/star/sheet/ValidationType.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__
40#include <com/sun/star/sheet/ValidationAlertStyle.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module sheet {
46
47//=============================================================================
48
49/** represents the data validation settings for a cell or cell range.
50 */
51published service TableValidation
52{
53
54	interface com::sun::star::beans::XPropertySet;
55
56	interface com::sun::star::sheet::XSheetCondition;
57
58	//=========================================================================
59
60	/** specifies the type of validation.
61	 */
62	[property] com::sun::star::sheet::ValidationType Type;
63
64	//-------------------------------------------------------------------------
65
66	/** specifies if an input message is shown when the cursor is in a
67		cell with these validation settings.
68	 */
69	[property] boolean ShowInputMessage;
70
71	//-------------------------------------------------------------------------
72
73	/** specifies the title of the window showing the input message.
74
75		<p>This is only used if <member>TableValidation::ShowInputMessage</member>
76		is set to <TRUE/>.</p>
77	 */
78	[property] string InputTitle;
79
80	//-------------------------------------------------------------------------
81
82	/** specifies the text of the input message.
83
84		<p>This is only used if <member>TableValidation::ShowInputMessage</member>
85		is set to <TRUE/>.</p>
86	 */
87	[property] string InputMessage;
88
89	//-------------------------------------------------------------------------
90
91	/** specifies if an error message is displayed when invalid data
92		is entered.
93	 */
94	[property] boolean ShowErrorMessage;
95
96	//-------------------------------------------------------------------------
97
98	/** specifies the title of the window showing the error message.
99
100		<p>This is only used if <member>TableValidation::ShowErrorMessage</member>
101		is set to <TRUE/>.</p>
102	 */
103	[property] string ErrorTitle;
104
105	//-------------------------------------------------------------------------
106
107	/** specifies the text of the error message.
108
109		<p>This is only used if <member>TableValidation::ShowErrorMessage</member>
110		is set to <TRUE/>.</p>
111	 */
112	[property] string ErrorMessage;
113
114	//-------------------------------------------------------------------------
115
116	/** specifies if blank cells should be allowed.
117	 */
118	[property] boolean IgnoreBlankCells;
119
120	//-------------------------------------------------------------------------
121
122	/** specifies the style of the error message.
123
124		<p>This is used only if <member>TableValidation::ShowErrorMessage</member>
125		is set to <TRUE/>.</p>
126	 */
127	[property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle;
128
129	//-------------------------------------------------------------------------
130
131	/** specifies if the list of possible values should be shown on the cell and how.
132
133        See also <type>TableValidationVisibility</type>
134	 */
135	[optional,property] short ShowList;
136
137};
138
139//=============================================================================
140
141}; }; }; };
142
143#endif
144
145