LibreOffice: com/sun/star/text/ContentControl.idl Source File

LibreOffice LibreOffice 24.8 SDK API Reference

Loading...
Searching...
No Matches
ContentControl.idl
Go to the documentation of this file.
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
10module com { module sun { module star { module text {
11
18service ContentControl
19{
20
23 interface com::sun::star::text::XTextContent;
24
27 [optional, property] boolean ShowingPlaceHolder;
28
31 [optional, property] boolean Checkbox;
32
35 [optional, property] boolean Checked;
36
39 [optional, property] string CheckedState;
40
43 [optional, property] string UncheckedState;
44
47 [optional, property] sequence< sequence< com::sun::star::beans::PropertyValue > > ListItems;
48
51 [optional, property] boolean Picture;
52
57 [optional, property] boolean Date;
58
61 [optional, property] string DateFormat;
62
65 [optional, property] string DateLanguage;
66
69 [optional, property] string CurrentDate;
70
73 [optional, property] boolean PlainText;
74
77 [optional, property] string PlaceholderDocPart;
78
81 [optional, property] string DataBindingPrefixMappings;
82
85 [optional, property] string DataBindingXpath;
86
89 [optional, property] string DataBindingStoreItemID;
90
93 [optional, property] string Color;
94
99 [optional, property] string Appearance;
100
105 [optional, property] boolean ComboBox;
106
111 [optional, property] boolean DropDown;
112
118 [optional, property] string Alias;
119
125 [optional, property] string Tag;
126
131 [optional, property, readonly] string DateString;
132
137 [optional, property] long Id;
138
143 [optional, property] unsigned long TabIndex;
144
149 [optional, property] string Lock;
150
155 [optional, property] string MultiLine;
156};
157
158
159}; }; }; };
160
161/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::text::XTextContent
enables objects to be inserted into a text and to provide their location in a text once they are inse...
Definition XTextContent.idl:29
com
Definition Ambiguous.idl:20
com::sun::star::text::ContentControl
This service specifies a content control with properties in a TextDocument.
Definition ContentControl.idl:19
com::sun::star::text::ContentControl::ComboBox
boolean ComboBox
Combo box that allows free-form text as well, i.e.
Definition ContentControl.idl:105
com::sun::star::text::ContentControl::Tag
string Tag
The tag: similar to Alias, but is meant to be machine-readable.
Definition ContentControl.idl:125
com::sun::star::text::ContentControl::PlainText
boolean PlainText
Plain text, i.e.
Definition ContentControl.idl:73
com::sun::star::text::ContentControl::DateLanguage
string DateLanguage
If Date is true, the date's BCP 47 language tag.
Definition ContentControl.idl:65
com::sun::star::text::ContentControl::TabIndex
unsigned long TabIndex
Describes the order in which keyboard navigation moves between controls.
Definition ContentControl.idl:143
com::sun::star::text::ContentControl::Date
boolean Date
Display the content control as a date.
Definition ContentControl.idl:57
com::sun::star::text::ContentControl::PlaceholderDocPart
string PlaceholderDocPart
The placeholder's doc part: just remembered.
Definition ContentControl.idl:77
com::sun::star::text::ContentControl::ShowingPlaceHolder
boolean ShowingPlaceHolder
Current content is placeholder text.
Definition ContentControl.idl:27
com::sun::star::text::ContentControl::DataBindingPrefixMappings
string DataBindingPrefixMappings
The data bindings's prefix mappings: just remembered.
Definition ContentControl.idl:81
com::sun::star::text::ContentControl::Color
string Color
The color: just remembered.
Definition ContentControl.idl:93
com::sun::star::text::ContentControl::Checked
boolean Checked
If Checkbox is true, is the checkbox checked?
Definition ContentControl.idl:35
com::sun::star::text::ContentControl::MultiLine
string MultiLine
Indicates if the control accepts soft breaks.
Definition ContentControl.idl:155
com::sun::star::text::ContentControl::CheckedState
string CheckedState
If Checkbox is true, the value of a checked checkbox.
Definition ContentControl.idl:39
com::sun::star::text::ContentControl::ListItems
sequence< sequence< com::sun::star::beans::PropertyValue > > ListItems
List items of a dropdown: DisplayText + Value pairs with string values for each item.
Definition ContentControl.idl:47
com::sun::star::text::ContentControl::Lock
string Lock
Describes whether the control itself and/or its data can be modified or deleted by the user.
Definition ContentControl.idl:149
com::sun::star::text::ContentControl::Appearance
string Appearance
The appearance: just remembered.
Definition ContentControl.idl:99
com::sun::star::text::ContentControl::DropDown
boolean DropDown
Drop-down that does not allow free-form text, i.e.
Definition ContentControl.idl:111
com::sun::star::text::ContentControl::CurrentDate
string CurrentDate
Date in YYYY-MM-DDT00:00:00Z format.
Definition ContentControl.idl:69
com::sun::star::text::ContentControl::Alias
string Alias
The alias: kind of a human-readable title / description, show up on the UI.
Definition ContentControl.idl:118
com::sun::star::text::ContentControl::DataBindingXpath
string DataBindingXpath
The data bindings's XPath: just remembered.
Definition ContentControl.idl:85
com::sun::star::text::ContentControl::DataBindingStoreItemID
string DataBindingStoreItemID
The data bindings's store item ID: just remembered.
Definition ContentControl.idl:89
com::sun::star::text::ContentControl::UncheckedState
string UncheckedState
If Checkbox is true, the value of an unchecked checkbox.
Definition ContentControl.idl:43
com::sun::star::text::ContentControl::DateString
string DateString
The formatted date string, based on DateFormat, DateLanguage and CurrentDate.
Definition ContentControl.idl:131
com::sun::star::text::ContentControl::Checkbox
boolean Checkbox
Display the content control as a checkbox.
Definition ContentControl.idl:31
com::sun::star::text::ContentControl::DateFormat
string DateFormat
If Date is true, the date format in a syntax accepted by the NumberFormatter.
Definition ContentControl.idl:61
com::sun::star::text::ContentControl::Id
long Id
A unique numeric id, used by macros to identify a specific control.
Definition ContentControl.idl:137
com::sun::star::text::ContentControl::Picture
boolean Picture
Display the content control as a picture.
Definition ContentControl.idl:51