offapi/com/sun/star/text/ContentControl.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
  10 module com { module sun { module star { module text {
  11
  12 /** This service specifies a content control with properties in a TextDocument.
  13
  14     A content control wraps one or more text portions and controls the behavior of that content.
  15
  16     @since LibreOffice 7.4
  17 */
  18 service ContentControl
  19 {
  20
  21     /** Provides a way to insert the content control using insertTextContent().
  22     */
  23     interface com::sun::star::text::XTextContent;
  24
  25     /** Current content is placeholder text.
  26     */
  27     [optional, property] boolean ShowingPlaceHolder;
  28
  29     /** Display the content control as a checkbox.
  30     */
  31     [optional, property] boolean Checkbox;
  32
  33     /** If Checkbox is true, is the checkbox checked?
  34     */
  35     [optional, property] boolean Checked;
  36
  37     /** If Checkbox is true, the value of a checked checkbox.
  38     */
  39     [optional, property] string CheckedState;
  40
  41     /** If Checkbox is true, the value of an unchecked checkbox.
  42     */
  43     [optional, property] string UncheckedState;
  44
  45     /** List items of a dropdown: DisplayText + Value pairs with string values for each item.
  46     */
  47     [optional, property] sequence< sequence< com::sun::star::beans::PropertyValue > > ListItems;
  48
  49     /** Display the content control as a picture.
  50     */
  51     [optional, property] boolean Picture;
  52
  53     /** Display the content control as a date.
  54
  55         If true, a date picker is provided on the UI.
  56     */
  57     [optional, property] boolean Date;
  58
  59     /** If Date is true, the date format in a syntax accepted by the NumberFormatter.
  60     */
  61     [optional, property] string DateFormat;
  62
  63     /** If Date is true, the date's BCP 47 language tag.
  64     */
  65     [optional, property] string DateLanguage;
  66
  67     /** Date in YYYY-MM-DDT00:00:00Z format.
  68     */
  69     [optional, property] string CurrentDate;
  70
  71     /** Plain text, i.e. not rich text.
  72     */
  73     [optional, property] boolean PlainText;
  74
  75     /** The placeholder's doc part: just remembered.
  76     */
  77     [optional, property] string PlaceholderDocPart;
  78
  79     /** The data bindings's prefix mappings: just remembered.
  80     */
  81     [optional, property] string DataBindingPrefixMappings;
  82
  83     /** The data bindings's XPath: just remembered.
  84     */
  85     [optional, property] string DataBindingXpath;
  86
  87     /** The data bindings's store item ID: just remembered.
  88     */
  89     [optional, property] string DataBindingStoreItemID;
  90
  91     /** The color: just remembered.
  92     */
  93     [optional, property] string Color;
  94
  95     /** The appearance: just remembered.
  96
  97         @since LibreOffice 7.6
  98     */
  99     [optional, property] string Appearance;
 100
 101     /** Combo box that allows free-form text as well, i.e. not dropdown.
 102
 103         @since LibreOffice 7.5
 104     */
 105     [optional, property] boolean ComboBox;
 106
 107     /** Drop-down that does not allow free-form text, i.e. not combo box.
 108
 109         @since LibreOffice 7.5
 110     */
 111     [optional, property] boolean DropDown;
 112
 113     /** The alias: kind of a human-readable title / description, show up on the UI.
 114                    -also used by VBA to group controls into a smaller, indexed collection
 115
 116         @since LibreOffice 7.5
 117     */
 118     [optional, property] string Alias;
 119
 120     /** The tag: similar to Alias, but is meant to be machine-readable.
 121                  -also used by VBA to group controls into a smaller, indexed collection
 122
 123         @since LibreOffice 7.5
 124     */
 125     [optional, property] string Tag;
 126
 127     /** The formatted date string, based on DateFormat, DateLanguage and CurrentDate.
 128
 129         @since LibreOffice 7.5
 130     */
 131     [optional, property, readonly] string DateString;
 132
 133     /** A unique numeric id, used by macros to identify a specific control.
 134
 135         @since LibreOffice 7.5
 136     */
 137     [optional, property] long Id;
 138
 139     /** Describes the order in which keyboard navigation moves between controls
 140
 141         @since LibreOffice 7.6
 142     */
 143     [optional, property] unsigned long TabIndex;
 144
 145     /** Describes whether the control itself and/or its data can be modified or deleted by the user.
 146
 147         @since LibreOffice 7.6
 148     */
 149     [optional, property] string Lock;
 150
 151     /** Indicates if the control accepts soft breaks.
 152
 153         @since LibreOffice 24.2
 154     */
 155     [optional, property] string MultiLine;
 156 };
 157
 158
 159 }; }; }; };
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */