summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/TableValidation.idl
blob: 41ddbba007d1daa4df6c66fb87754e1f34b47113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_sheet_TableValidation_idl__
#define __com_sun_star_sheet_TableValidation_idl__

#ifndef __com_sun_star_sheet_XSheetCondition_idl__
#include <com/sun/star/sheet/XSheetCondition.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_sheet_ValidationType_idl__
#include <com/sun/star/sheet/ValidationType.idl>
#endif

#ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__
#include <com/sun/star/sheet/ValidationAlertStyle.idl>
#endif

//=============================================================================

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 <member>TableValidation::ShowInputMessage</member>
        is set to <TRUE/>.</p>
     */
    [property] string InputTitle;

    //-------------------------------------------------------------------------

    /** specifies the text of the input message.

        <p>This is only used if <member>TableValidation::ShowInputMessage</member>
        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 <member>TableValidation::ShowErrorMessage</member>
        is set to <TRUE/>.</p>
     */
    [property] string ErrorTitle;

    //-------------------------------------------------------------------------

    /** specifies the text of the error message.

        <p>This is only used if <member>TableValidation::ShowErrorMessage</member>
        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 <member>TableValidation::ShowErrorMessage</member>
        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 <type>TableValidationVisibility</type>
     */
    [optional,property] short ShowList;

};

//=============================================================================

}; }; }; };

#endif