xref: /trunk/main/offapi/com/sun/star/sheet/TableValidation.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_TableValidation_idl__
29#define __com_sun_star_sheet_TableValidation_idl__
30
31#ifndef __com_sun_star_sheet_XSheetCondition_idl__
32#include <com/sun/star/sheet/XSheetCondition.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39#ifndef __com_sun_star_sheet_ValidationType_idl__
40#include <com/sun/star/sheet/ValidationType.idl>
41#endif
42
43#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__
44#include <com/sun/star/sheet/ValidationAlertStyle.idl>
45#endif
46
47//=============================================================================
48
49module com {  module sun {  module star {  module sheet {
50
51//=============================================================================
52
53/** represents the data validation settings for a cell or cell range.
54 */
55published service TableValidation
56{
57
58    interface com::sun::star::beans::XPropertySet;
59
60    interface com::sun::star::sheet::XSheetCondition;
61
62    //=========================================================================
63
64    /** specifies the type of validation.
65     */
66    [property] com::sun::star::sheet::ValidationType Type;
67
68    //-------------------------------------------------------------------------
69
70    /** specifies if an input message is shown when the cursor is in a
71        cell with these validation settings.
72     */
73    [property] boolean ShowInputMessage;
74
75    //-------------------------------------------------------------------------
76
77    /** specifies the title of the window showing the input message.
78
79        <p>This is only used if <member>TableValidation::ShowInputMessage</member>
80        is set to <TRUE/>.</p>
81     */
82    [property] string InputTitle;
83
84    //-------------------------------------------------------------------------
85
86    /** specifies the text of the input message.
87
88        <p>This is only used if <member>TableValidation::ShowInputMessage</member>
89        is set to <TRUE/>.</p>
90     */
91    [property] string InputMessage;
92
93    //-------------------------------------------------------------------------
94
95    /** specifies if an error message is displayed when invalid data
96        is entered.
97     */
98    [property] boolean ShowErrorMessage;
99
100    //-------------------------------------------------------------------------
101
102    /** specifies the title of the window showing the error message.
103
104        <p>This is only used if <member>TableValidation::ShowErrorMessage</member>
105        is set to <TRUE/>.</p>
106     */
107    [property] string ErrorTitle;
108
109    //-------------------------------------------------------------------------
110
111    /** specifies the text of the error message.
112
113        <p>This is only used if <member>TableValidation::ShowErrorMessage</member>
114        is set to <TRUE/>.</p>
115     */
116    [property] string ErrorMessage;
117
118    //-------------------------------------------------------------------------
119
120    /** specifies if blank cells should be allowed.
121     */
122    [property] boolean IgnoreBlankCells;
123
124    //-------------------------------------------------------------------------
125
126    /** specifies the style of the error message.
127
128        <p>This is used only if <member>TableValidation::ShowErrorMessage</member>
129        is set to <TRUE/>.</p>
130     */
131    [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle;
132
133    //-------------------------------------------------------------------------
134
135    /** specifies if the list of possible values should be shown on the cell and how.
136
137        See also <type>TableValidationVisibility</type>
138     */
139    [optional,property] short ShowList;
140
141};
142
143//=============================================================================
144
145}; }; }; };
146
147#endif
148
149