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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_TableValidation_idl__
  21 #define __com_sun_star_sheet_TableValidation_idl__
  22
  23 #include <com/sun/star/sheet/XSheetCondition.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/sheet/ValidationType.idl>
  26 #include <com/sun/star/sheet/ValidationAlertStyle.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** represents the data validation settings for a cell or cell range.
  33  */
  34 published service TableValidation
  35 {
  36
  37     interface com::sun::star::beans::XPropertySet;
  38
  39     interface com::sun::star::sheet::XSheetCondition;
  40
  41
  42     /** specifies the type of validation.
  43      */
  44     [property] com::sun::star::sheet::ValidationType Type;
  45
  46
  47     /** specifies if an input message is shown when the cursor is in a
  48         cell with these validation settings.
  49      */
  50     [property] boolean ShowInputMessage;
  51
  52
  53     /** specifies the title of the window showing the input message.
  54
  55         <p>This is only used if TableValidation::ShowInputMessage
  56         is set to `TRUE`.</p>
  57      */
  58     [property] string InputTitle;
  59
  60
  61     /** specifies the text of the input message.
  62
  63         <p>This is only used if TableValidation::ShowInputMessage
  64         is set to `TRUE`.</p>
  65      */
  66     [property] string InputMessage;
  67
  68
  69     /** specifies if an error message is displayed when invalid data
  70         is entered.
  71      */
  72     [property] boolean ShowErrorMessage;
  73
  74
  75     /** specifies the title of the window showing the error message.
  76
  77         <p>This is only used if TableValidation::ShowErrorMessage
  78         is set to `TRUE`.</p>
  79      */
  80     [property] string ErrorTitle;
  81
  82
  83     /** specifies the text of the error message.
  84
  85         <p>This is only used if TableValidation::ShowErrorMessage
  86         is set to `TRUE`.</p>
  87      */
  88     [property] string ErrorMessage;
  89
  90
  91     /** specifies if blank cells should be allowed.
  92      */
  93     [property] boolean IgnoreBlankCells;
  94
  95
  96     /** specifies the style of the error message.
  97
  98         <p>This is used only if TableValidation::ShowErrorMessage
  99         is set to `TRUE`.</p>
 100      */
 101     [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle;
 102
 103
 104     /** specifies if the list of possible values should be shown on the cell and how.
 105
 106         See also TableValidationVisibility
 107      */
 108     [optional,property] short ShowList;
 109
 110 };
 111
 112
 113 }; }; }; };
 114
 115 #endif
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */