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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents the data validation settings for a cell or cell range.
  25  */
  26 published service TableValidation
  27 {
  28
  29     interface com::sun::star::beans::XPropertySet;
  30
  31     interface com::sun::star::sheet::XSheetCondition;
  32
  33
  34     /** specifies the type of validation.
  35      */
  36     [property] com::sun::star::sheet::ValidationType Type;
  37
  38
  39     /** specifies if an input message is shown when the cursor is in a
  40         cell with these validation settings.
  41      */
  42     [property] boolean ShowInputMessage;
  43
  44
  45     /** specifies the title of the window showing the input message.
  46
  47         <p>This is only used if TableValidation::ShowInputMessage
  48         is set to `TRUE`.</p>
  49      */
  50     [property] string InputTitle;
  51
  52
  53     /** specifies the text of the input message.
  54
  55         <p>This is only used if TableValidation::ShowInputMessage
  56         is set to `TRUE`.</p>
  57      */
  58     [property] string InputMessage;
  59
  60
  61     /** specifies if an error message is displayed when invalid data
  62         is entered.
  63      */
  64     [property] boolean ShowErrorMessage;
  65
  66
  67     /** specifies the title of the window showing the error message.
  68
  69         <p>This is only used if TableValidation::ShowErrorMessage
  70         is set to `TRUE`.</p>
  71      */
  72     [property] string ErrorTitle;
  73
  74
  75     /** specifies the text of the error message.
  76
  77         <p>This is only used if TableValidation::ShowErrorMessage
  78         is set to `TRUE`.</p>
  79      */
  80     [property] string ErrorMessage;
  81
  82
  83     /** specifies if blank cells should be allowed.
  84      */
  85     [property] boolean IgnoreBlankCells;
  86
  87
  88     /** specifies the style of the error message.
  89
  90         <p>This is used only if TableValidation::ShowErrorMessage
  91         is set to `TRUE`.</p>
  92      */
  93     [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle;
  94
  95
  96     /** specifies if the list of possible values should be shown on the cell and how.
  97
  98         See also TableValidationVisibility
  99      */
 100     [optional,property] short ShowList;
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */