/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at
http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at
http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module text { module textfield {
/** specifies service of a reference field.
@see com::sun::star::text::TextField
*/
published service GetReference
{
service com::sun::star::text::TextField;
/** contains the current content of the text field.
<p> This property is especially useful for import/export purposes. </p>
*/
[property] string CurrentPresentation;
/** contains the source of the reference.
@see com::sun::star::text::ReferenceFieldSource
*/
[property] short ReferenceFieldSource;
/** contains the name of the source.
<p> Depending on the property ReferenceFieldSource it may be the name of
a bookmark, a reference mark.</p>
*/
[property] string SourceName;
/** contains the type of the reference.
@see com::sun::star::text::ReferenceFieldPart
*/
[property] short ReferenceFieldPart;
/** contains the sequence number of a set expression field that is used as sequence field
or the value of the ReferenceId property of a footnote or endnote.
@see com::sun::star::text::Footnote
*/
[property] short SequenceNumber;
/** contains the language id of the alternative language-dependent references.
<p> Alternative language-dependent forms of reference types. </p>
@since LibreOffice 6.1
<p> The current set of supported languages is:
<ul>
<li>hu : Hungarian, reference with lowercase article "a" or "az"</li>
<li>Hu : Hungarian, reference with uppercase article "A" or "Az"</li>
</ul>
</p>
*/
[optional, property] string ReferenceFieldLanguage;
/** contains extra flags which can modify the behaviour of the field
@since LibreOffice 24.2
*/
[optional, property] short ReferenceFieldFlags;
};
}; }; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
