offapi/com/sun/star/sheet/TableValidation.idl

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