diff options
Diffstat (limited to 'offapi/com/sun/star/text')
293 files changed, 21476 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/AccessibleEndnoteView.idl b/offapi/com/sun/star/text/AccessibleEndnoteView.idl new file mode 100644 index 000000000..dc6ac95e7 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleEndnoteView.idl @@ -0,0 +1,113 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleEndnoteView_idl__ +#define __com_sun_star_text_AccessibleEndnoteView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of endnotes. + @since OOo 1.1.2 + */ +service AccessibleEndnoteView +{ + /** This interface gives access to any paragraph fragment and table + fragment that is contained in an endnote and is at least + partially visible on the screen. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is either the accessible view of a text document, + a page of the accessible page preview of a text document, + or the accessible page preview of a spreadsheet document. + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns + an object that supports one of the following services. + <ul> + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this kind is returned for every paragraph + fragment that is contained in the document body and + is at least partially visible. A paragraph fragment is + the part of a paragraph that is displayed on a + certain page. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is returned for every table + fragment that is contained in the document body + and is at least partially visible. A table fragment is + the part of a table that is displayed on a certain page. + </ul> + <p>The logical order of paragraph and table fragments is never + changed. + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::END_NOTE + <li>The name is "endnote" (or the equivalent term + in application's language) with a number appended. + <li>The description is endnote" (or the equivalent term + in application's language) with the endnote number or + character appended in the format that is specified in the + endnote settings. + <li>There are no relations. <em>TODO: One might specify a relation + to the endnote anchor's paragraph.</em> + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that the + document window has been closed or the endnote is + not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>Depending of the application's region setting, the locale is + the western, Asian or complex default language of the document. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a + endnote. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleFootnoteView.idl b/offapi/com/sun/star/text/AccessibleFootnoteView.idl new file mode 100644 index 000000000..cf161e9f5 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleFootnoteView.idl @@ -0,0 +1,115 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleFootnoteView_idl__ +#define __com_sun_star_text_AccessibleFootnoteView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of footnotes. + + @since OOo 1.1.2 + + */ +service AccessibleFootnoteView +{ + /** This interface gives access to any paragraph fragment and table + fragment that is contained in a footnote and is at least + partially visible on the screen. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is either the accessible view of a text document, + a page of the accessible page preview of a text document, + or the accessible page preview of a spreadsheet document. + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns + an object that supports one of the following services. + <ul> + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this kind is returned for every paragraph + fragment that is contained in the document body and + is at least partially visible. A paragraph fragment is + the part of a paragraph that is displayed on a + certain page. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is returned for every table + fragment that is contained in the document body + and is at least partially visible. A table fragment is + the part of a table that is displayed on a certain page. + </ul> + <p>The logical order of paragraph and table fragments is never + changed. + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::FOOTNOTE + <li>The name is "footnote" (or the equivalent term + in application's language) with a number appended. + <li>The description is footnote" (or the equivalent term + in application's language) with the footnote number or + character appended in the format that is specified in the + footnote settings. + <li>There are no relations. <em>TODO: One might specify a relation + to the footnote anchor's paragraph.</em> + <li>The following states might be contained in the state set + returned by + com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the footnote is + not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>Depending of the application's region setting, the locale is + the western, Asian or complex default language of the document. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a + footnote. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleHeaderFooterView.idl b/offapi/com/sun/star/text/AccessibleHeaderFooterView.idl new file mode 100644 index 000000000..4f897e393 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleHeaderFooterView.idl @@ -0,0 +1,116 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleHeaderFooterView_idl__ +#define __com_sun_star_text_AccessibleHeaderFooterView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of headers and footers. + + @since OOo 1.1.2 + + */ +service AccessibleHeaderFooterView +{ + /** This interface gives access to any paragraph and table that is + contained in the header and footer and is at least partially visible + on the screen. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is either the accessible view of a text document, + a page of the accessible page preview of a text document, + or the accessible page preview of a spreadsheet document. + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns + an object that supports one of the following services. + <ul> + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this kind is returned for every paragraph + that is contained in the document body and + is at least partially visible. The child always + represents a whole paragraph (and not a fragment only), + because there are no page breaks within headers and + footers. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is returned for every table + that is contained in the document body + and is at least partially visible. The child always + represents a whole table (and not a fragment only), + because there are no page breaks within headers and + footers. + </ul> + <p>The logical order of paragraphs and tables is never changed. + <li>The role is either + ::com::sun::star::accessibility::AccessibleRole::HEADER or + ::com::sun::star::accessibility::AccessibleRole::FOOTER. + <li>The name is "header" or "footer" (or the equivalent term + in application's language) with a number appended. + <li>The description is "header" or "footer" (or the equivalent term + in application's language) with the page number appended in + the format that is specified in the page's style. + <li>There are no relations. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the header or + footer is not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>Depending of the application's region setting, the locale is + the western, Asian or complex default language of the document. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a header + or footer. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessiblePageView.idl b/offapi/com/sun/star/text/AccessiblePageView.idl new file mode 100644 index 000000000..505e24a77 --- /dev/null +++ b/offapi/com/sun/star/text/AccessiblePageView.idl @@ -0,0 +1,178 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessiblePageView_idl__ +#define __com_sun_star_text_AccessiblePageView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of pages. + + + @since OOo 1.1.2 + */ +service AccessiblePageView +{ + /** This interface gives access to any page that is visible in the + page preview of a text document. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is the accessible page preview of a text document. That is, the + object returned by + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + supports + ::com::sun::star::text::AccessibleTextDocumentPageView. + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns an object that supports one of the + following services. + <ul> + <li>::com::sun::star::text::AccessibleHeaderFooterView: + A child of this kind is returned for every header + and footer that is contained in the page. + <li>::com::sun::star::text::AccessibleFootnoteView: + A child of this kind is returned for every footnote + that is contained in the page. + <li>::com::sun::star::text::AccessibleEndnoteView: + A child of this kind is returned for every endnote + that is contained in the page. + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this kind is returned for every paragraph + fragment that is contained in the page. + A paragraph fragment is the part of a paragraph that + is displayed on a certain page. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is returned for every table + fragment that is contained in the page. + A table fragment is the part of a table that is + displayed on a certain page. + <li>::com::sun::star::text::AccessibleTextFrameView: + A child of this kind is returned for every text + frame that is contained in the page. These objects + are children of the AccessiblePageView + regardless whether they are bound to the page, a + paragraph, a frame, or a character. The only + exception are text frames that are bound as + character. They are children of the paragraph they + are contained in. + <li>::com::sun::star::text::AccessibleTextGraphicObject: + A child of this kind is returned for every graphic that + is contained in the page. These objects are + children of the AccessiblePageView + regardless whether they are bound to a page, paragraph, + a frame or a character. The only exception + are text frames that are bound as character. They are + children of the paragraph they are contained in. + <li>::com::sun::star::text::AccessibleTextEmbeddedObject: + A child of this kind is returned for every embedded + object that is contained in the page. + These objects are children of the + AccessibleTextDocumentView regardless + whether they are bound to a page, a paragraph, a frame, + or a character. They are children of the paragraph they + are contained in. + <li>::com::sun::star::drawing::AccessibleShape: + A child of this kind (or one of its derived + interfaces) is returned for every shape that is + contained in the page. These objects are children of + the AccessibleTextDocumentView + regardless whether they are bound to a page, a + paragraph, a frame or a character. + </ul> + <p>The following rules apply to the children order: + <ul> + <li>The logical order of paragraph and table fragments is + never changed. + <li>Headers appear immediately before the first paragraph or + table fragment of the header's page. + <li>Footnotes appear immediately after the last paragraph or + table fragment of the footnote's page. The logical order + of footnotes isn't changed. + <li>Endnotes appear immediately after the last footnote of + the endnote's page or after the last paragraph or + table fragment of this page if there are no footnotes. + The logical order of endnotes isn't changed. + <li>Footers appear immediately after the last endnote, + footnote, paragraph or table fragment of the footer's + page. + <li>Text frames, graphics, embedded objects and shapes that + are painted in the background appear before any other + children. Their order reflects the z order. + <li>Text frames, graphics, embedded objects and shapes + that are painted in the foreground appear behind any + other children. Their order reflects the z order, + with the exception of controls that appear really last, + but also keep the z order. + </ul> + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::PANEL + <li>The name is "page" (or the equivalent term + in application's language) with a number appended. + <li>The description is "page" (or the equivalent term + in application's language) with the page number or + character appended in the format that is specified in the + page style. + <li>There are no relations.</li> + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the endnote + is not existing any longer)</li> + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained)</li> + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>The locale is the application's locale. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a + endnote. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleParagraphView.idl b/offapi/com/sun/star/text/AccessibleParagraphView.idl new file mode 100644 index 000000000..5f9482739 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleParagraphView.idl @@ -0,0 +1,173 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleParagraphView_idl__ +#define __com_sun_star_text_AccessibleParagraphView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleEditableText.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> +#include <com/sun/star/accessibility/XAccessibleTextAttributes.idl> + + +module com { module sun { module star { module text { + + +/** The accessible view of a paragraph fragment. + + + @since OOo 1.1.2 + */ +service AccessibleParagraphView +{ + /** This interface gives access to a paragraph fragment that is at least + partially visible on the screen. A paragraph fragment is the portion + of a paragraph that is displayed on a single page or a in a single + column. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is the accessible view of a text document (in this case the + paragraph is contained in a page body) or the accessible + view of a header, footer, footnote, endnote, table cell, + text frame, page or shape.</li> + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + are the graphics, text boxes and OLE objects that are bound + <em>as</em> character within the paragraph. Graphics, text + boxes and OLE objects that are bound to the paragraph or + <em>to</em> a character within the paragraph are not + children of the paragraph fragment but of the document view + itself.</li> + <li>The role is either + ::com::sun::star::accessibility::AccessibleRole::PARAGRAPH or + ::com::sun::star::accessibility::AccessibleRole::HEADING. + The later one is returned + if the paragraph's style is contained in the chapter + numbering of a text document. + <li>The name is "paragraph" or "heading" (or the equivalent term + in application's language) with a number appended. + <li>The description contains the term "paragraph" (or the equivalent + term in application's language) and the first sentence of + the paragraph. + <li>There are no relations. + <li>The following states are supported by the + ::com::sun::star::accessibility::XAccessibleStateSet returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(). + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the paragraph + fragment is not existing any longer). + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_LINE + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED + </ul> + <li>Depending of the application's region setting, the locale is + the western, Asian or complex language of the paragraph. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a paragraph + fragment. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This interface gives access to a paragraph fragment's text. The text + contains the paragraph's editable text as well as generated text, + like chapter numbers, hyphens or fields. Characters of generated + text contribute to the text's character indexing. However, it is not + possible to set the caret or start a selection within generated text. + <p>For text frames, graphics, etc. that are bound as character some + text is generated that contains the objects description. + <p>The attributes (or properties) returned by + ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() + are a sub set of the properties described by the service + ::com::sun::star::style::CharacterProperties. For + properties that have Asian and complex counterparts, the value that + is visible is returned. This can be in fact the western, Asian or + complex value. It's not possible to change the value of any property + by using + ::com::sun::star::accessibility::XAccessibleEditableText::setAttributes(). + <p><em>TODO: If there is a demand, some attributes might be added that + tells whether the character at a certain index is editable or generated. + </em> + + */ + [optional] interface ::com::sun::star::accessibility::XAccessibleEditableText; + + /** This interface is a subset of + ::com::sun::star::accessibility::XAccessibleEditableText + and gives access to a paragraph + fragment's text in a read-only mode. The text contains the + paragraph's text (changeable as well as generated text, like chapter + numbers, hyphens or fields). Characters of generated text contribute + to the text's character indexing. + <p>For text frames, graphics, etc. that are bound as character + some text is generated that contains the objects description. + <p>The attributes (or properties) returned by + ::com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() + are a sub set of the properties described by the service + ::com::sun::star::style::CharacterProperties. For + properties that have Asian and complex counterparts, the value that + is visible is returned. This can be in fact the western, Asian or + complex value. + <p><em>TODO: If there is a demand, some attributes might be added + that tells whether the character at a certain index is changeable or + generated. + </em> + */ + interface ::com::sun::star::accessibility::XAccessibleText; + + /** This interface is for selecting the paragraph's children. Multi + selection is supported only for children that are multi selectable + in the GUI, too. + */ + [optional] interface ::com::sun::star::accessibility::XAccessibleSelection; + + /** This is the interface for listeners. + */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; + + /** This interface gives access to the default attributes of a paragraph + and to the run attributes of a certain character in a paragraph + + @since OOo 2.0.4 + */ + [optional] interface ::com::sun::star::accessibility::XAccessibleTextAttributes; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleTextDocumentPageView.idl b/offapi/com/sun/star/text/AccessibleTextDocumentPageView.idl new file mode 100644 index 000000000..5a6ace720 --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleTextDocumentPageView.idl @@ -0,0 +1,91 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleTextDocumentPageView_idl__ +#define __com_sun_star_text_AccessibleTextDocumentPageView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleSelection.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible page preview of a text document. + + @since OOo 1.1.2 + */ +service AccessibleTextDocumentPageView +{ + /** This interface gives access to page that are visible in the + page preview of a text document. + <ul> + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support + the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children + returns an object that supports one of the service + ::com::sun::star::text::AccessiblePageView. + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::DOCUMENT_TEXT. + <li>The name is "document view" (or the equivalent term + in application's language). + <li>The description also is "document view" (or the equivalent term + in application's language). + <li>There are no relation sets. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed) + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>The locale is the application's locale. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a text + document view. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners + */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleTextDocumentView.idl b/offapi/com/sun/star/text/AccessibleTextDocumentView.idl new file mode 100644 index 000000000..818b18eee --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleTextDocumentView.idl @@ -0,0 +1,182 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleTextDocumentView_idl__ +#define __com_sun_star_text_AccessibleTextDocumentView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleSelection.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of a text document. + + @since OOo 1.1.2 + */ +service AccessibleTextDocumentView +{ + /** This interface gives access to any text, table, graphic, embedded + object and drawing that is at least partially visible on the screen. + The tree that arises from the children of this object reflects the + structure of the document as it is displayed. + + <ul> + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns an object that supports one of the + following services. + <ul> + <li>::com::sun::star::text::AccessibleHeaderFooterView: + A child of this kind is returned for every header + and footer that is at least partially visible. + <li>::com::sun::star::text::AccessibleFootnoteView: + A child of this kind is returned for every footnote + that is at least partially visible. + <li>::com::sun::star::text::AccessibleEndnoteView: + A child of this kind is returned for every endnote + that is at least partially visible. + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this kind is returned for every paragraph + fragment that is contained in the document body and + is at least partially visible. A paragraph fragment is + the part of a paragraph that is displayed on a + certain page. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is returned for every table + fragment that is contained in the document body + and is at least partially visible. A table fragment is + the part of a table that is displayed on a certain page. + <li>::com::sun::star::text::AccessibleTextFrameView: + A child of this + kind is returned for every text frame that is at + least partially visible. These objects are children + of the + AccessibleTextDocumentView regardless + whether they are bound to a page, a paragraph, a + frame, or a character. The only exception are text + frames that are bound as character. They are children + of the paragraph they are contained in. + <li>::com::sun::star::text::AccessibleTextGraphicObject: + A child of this kind is returned for every graphic that + is at least partially visible. These objects are + children of the AccessibleTextDocumentView + regardless whether they are bound to a page, paragraph, + a frame or a character. The only exception + are text frames that are bound as character. They are + children of the paragraph they are contained in. + <li>::com::sun::star::text::AccessibleTextEmbeddedObject: + A child of this kind is returned for every embedded + object that is at least partially visible. + These objects are children of the + AccessibleTextDocumentView regardless + whether they are bound to a page, a paragraph, a frame, + or a character. They are children of the paragraph they + are contained in. + <li>::com::sun::star::drawing::AccessibleShape: + A child of this kind (or a + derived interface) is returned for every shape that + is at least partially visible. These objects are + children of the + AccessibleTextDocumentView regardless + whether they are bound to a page, a paragraph, a + frame or a character. + </ul> + <p>The following rules apply to the children order: + <ul> + <li>The logical order of paragraph and table fragments is + never changed. + <li>Headers appear immediately before the first paragraph or + table fragment of the header's page. + <li>Footnotes appear immediately after the last paragraph or + table fragment of the footnote's page. The logical order + of footnotes isn't changed. + <li>Endnotes appear immediately after the last footnote of + the endnote's page or after the last paragraph or + table fragment of this page if there are no footnotes. + The logical order of endnotes isn't changed. + <li>Footers appear immediately after the last endnote, + footnote, paragraph or table fragment of the footer's + page. + <li>Text frames, graphics, embedded objects and shapes that + are painted in the background appear before any other + children. Their order reflects the z order. + <li>Text frames, graphics, embedded objects and shapes + that are painted in the foreground appear behind any + other children. Their order reflects the z order, + with the exception of controls that appear really last, + but also keep the z order. + </ul> + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::DOCUMENT_TEXT. + <li>The name is "document view" (or the equivalent term + in application's language). + <li>The description also is "document view" (or the equivalent term + in application's language). + <li>There are no relation sets. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that the document window has been closed) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>Depending of the application's region setting, the locale is + the western, Asian or complex default language of the document. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a text + document view. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This interface is for selecting the document's children. Selectable + are any children with the exception of headers, footers, footnotes + and endnotes, where only the grandchildren might be selectable. + */ + interface ::com::sun::star::accessibility::XAccessibleSelection; + + /** This is the interface for listeners + */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleTextEmbeddedObject.idl b/offapi/com/sun/star/text/AccessibleTextEmbeddedObject.idl new file mode 100644 index 000000000..bf455397f --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleTextEmbeddedObject.idl @@ -0,0 +1,106 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleTextEmbeddedObject_idl__ +#define __com_sun_star_text_AccessibleTextEmbeddedObject_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleImage.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + + +module com { module sun { module star { module text { + + +/** The accessible view of an inactive embedded object. If an embedded + object gets active, the active document gets an accessible object + tree of its own. This tree is not a subtree of the object that supports + this service but of the document service itself. The tree exist only + until the object is deactivated. + + @since OOo 1.1.2 + */ +service AccessibleTextEmbeddedObject +{ + /** This interface comprises the basic accessibility of embedded objects. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is the accessible view of a paragraph if the embedded object is + bound as character, and the accessible view of the document + (or of a page in the page preview) in any other case. + <li>There are no children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + . See above. + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::EMBEDDED_OBJECT + <li>The name is the one assigned to the object in the text + document. This means that it is not internationalized. + <li>The description is the one assigned to the object in the text + document. This means that it is not internationalized. If no + description has been set, the description equals the name. + <li>There are no relations. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the graphic + is not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>The locale is the one the text document itself. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of an + embedded object. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This interface gives access to the object's size and its description. + */ + interface ::com::sun::star::accessibility::XAccessibleImage; + + /** This is the interface for listeners + */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleTextFrameView.idl b/offapi/com/sun/star/text/AccessibleTextFrameView.idl new file mode 100644 index 000000000..3d0dcdf6f --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleTextFrameView.idl @@ -0,0 +1,122 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleTextFrameView_idl__ +#define __com_sun_star_text_AccessibleTextFrameView_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> + + +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + +module com { module sun { module star { module text { + + +/** The accessible view of text frames. + + @since OOo 1.1.2 + */ +service AccessibleTextFrameView +{ + /** This interface gives access to any paragraph fragment and table + fragment that is contained in a text frame and at least + partially visible on the screen. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is the + accessible view of a paragraph if the text frame is bound as + character, and the accessible view (or of a page in the page + preview) of the document in any other case. + <li>The children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() + all support the interface XAccessible. Calling + ::com::sun::star::accessibility::XAccessible::getAccessibleContext() + for these children returns an object that supports one of the + following services. + <ul> + <li>::com::sun::star::text::AccessibleParagraphView: + A child of this + kind is returned for every paragraph fragment that + is contained in the document body and is at least + partially visible. A paragraph fragment is the part + of a paragraph that is displayed on a certain page + or a certain column. + <li>::com::sun::star::table::AccessibleTableView: + A child of this kind is + returned for every table fragment that is contained + in the document body and is at least partially + visible. A table fragment is the part of a table + that is displayed on a certain page or a certain + column. + </ul> + <p>The logical order of paragraph and table fragments is never + changed. + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::TEXT_FRAME + <li>The name is the one assigned to the text frame in the text + document. This means that it is not internationalized. + <li>The description is the one assigned to the text frame in the + text document. This means that it is not internationalized. If + no description has been set, the description equals the name. + <li>There are no relations. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the graphic + is not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>The locale is the one the text document itself. + <li>There are the two relations CONTENT_FLOWS_FROM and + CONTENT_FLOWS_TO supported. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a + text frame. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AccessibleTextGraphicObject.idl b/offapi/com/sun/star/text/AccessibleTextGraphicObject.idl new file mode 100644 index 000000000..6337dfb5b --- /dev/null +++ b/offapi/com/sun/star/text/AccessibleTextGraphicObject.idl @@ -0,0 +1,99 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AccessibleTextGraphicObject_idl__ +#define __com_sun_star_text_AccessibleTextGraphicObject_idl__ + +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#include <com/sun/star/accessibility/XAccessibleImage.idl> +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> + + + +module com { module sun { module star { module text { + + +/** The accessible view of graphics. + + @since OOo 1.1.2 + */ +service AccessibleTextGraphicObject +{ + /** This interface comprises the basic accessibility of text graphics. + + <ul> + <li>The parent returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() + is the accessible view of a paragraph if the graphic is bound as + character, and the accessible view of the document (or of a + page in the page preview) in any other case. + <li>There are no children returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild(). + <li>The role is + ::com::sun::star::accessibility::AccessibleRole::GRAPHIC + <li>The name is the one assigned to the graphic in the text + document. This means that it is not internationalized. + <li>The description is the one assigned to the graphic in the text + document. This means that it is not internationalized. If no + description has been set, the description equals the name. + <li>There are no relations. + <li>The following states might be contained in the state set + returned by + ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet(): + <ul> + <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC + (indicates that + the document window has been closed or the graphic + is not existing any longer) + <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE + <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED + (always contained) + <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE + <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE + <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED + <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING + <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE + </ul> + <li>The locale is the one the text document itself. + </ul> + + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** This interface describes the graphical representation of a + graphic. + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** This interface gives access to the image size and its description. + */ + interface ::com::sun::star::accessibility::XAccessibleImage; + + /** This is the interface for listeners */ + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AuthorDisplayFormat.idl b/offapi/com/sun/star/text/AuthorDisplayFormat.idl new file mode 100644 index 000000000..4587c5a78 --- /dev/null +++ b/offapi/com/sun/star/text/AuthorDisplayFormat.idl @@ -0,0 +1,59 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AuthorDisplayFormat_idl__ +#define __com_sun_star_text_AuthorDisplayFormat_idl__ + + + + module com { module sun { module star { module text { + + +/** These constants are used to specify which parts of an author name are displayed + in a field. + */ +published constants AuthorDisplayFormat +{ + + /** The full name of the author is displayed + */ + const short FULL = 0; + + + /** Only the last name of the author is displayed + */ + const short LAST_NAME = 1; + + + /** Only the first name of the author is displayed + */ + const short FIRST_NAME = 2; + + + /** The initials of the author are displayed + */ + const short INITIALS = 3; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AutoTextContainer.idl b/offapi/com/sun/star/text/AutoTextContainer.idl new file mode 100644 index 000000000..36644d094 --- /dev/null +++ b/offapi/com/sun/star/text/AutoTextContainer.idl @@ -0,0 +1,37 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AutoTextContainer_idl__ +#define __com_sun_star_text_AutoTextContainer_idl__ + +#include <com/sun/star/text/XAutoTextContainer2.idl> + + +module com { module sun { module star { module text { + + +/** provides access to groups of text blocks. + */ +published service AutoTextContainer : XAutoTextContainer2; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AutoTextEntry.idl b/offapi/com/sun/star/text/AutoTextEntry.idl new file mode 100644 index 000000000..eb72c0a72 --- /dev/null +++ b/offapi/com/sun/star/text/AutoTextEntry.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AutoTextEntry_idl__ +#define __com_sun_star_text_AutoTextEntry_idl__ + +#include <com/sun/star/text/XAutoTextEntry.idl> +#include <com/sun/star/text/XText.idl> + + + + module com { module sun { module star { module text { + +/** provides access to a text block in a group of + an AutoTextContainer. + @see com::sun::star::text::AutoTextContainer + @see com::sun::star::text::AutoTextGroup + */ +published service AutoTextEntry +{ + interface com::sun::star::text::XAutoTextEntry; + + /** provides access to the Text of this entry. + */ + interface com::sun::star::text::XText; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/AutoTextGroup.idl b/offapi/com/sun/star/text/AutoTextGroup.idl new file mode 100644 index 000000000..be9f1940a --- /dev/null +++ b/offapi/com/sun/star/text/AutoTextGroup.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_AutoTextGroup_idl__ +#define __com_sun_star_text_AutoTextGroup_idl__ + +#include <com/sun/star/text/XAutoTextGroup.idl> +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/XNamed.idl> + +module com { module sun { module star { module text { + +/** provides access to text blocks in a group. + @see com::sun::star::text::AutoTextContainer + */ +published service AutoTextGroup +{ + interface com::sun::star::text::XAutoTextGroup; + + interface com::sun::star::container::XIndexAccess; + + /** provides access to the name of the group. + */ + interface com::sun::star::container::XNamed; + + /** The path to the file containing the AutoTextEntry's in this group + */ + [property, readonly] string FilePath; + + /** The title of this AutoTextGroup + */ + [property] string Title; + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BaseFrame.idl b/offapi/com/sun/star/text/BaseFrame.idl new file mode 100644 index 000000000..e989abbc4 --- /dev/null +++ b/offapi/com/sun/star/text/BaseFrame.idl @@ -0,0 +1,83 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_BaseFrame_idl__ +#define __com_sun_star_text_BaseFrame_idl__ + +#include <com/sun/star/text/BaseFrameProperties.idl> +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/drawing/XShape.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/container/XNamed.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/table/BorderLine.idl> +#include <com/sun/star/table/ShadowFormat.idl> +#include <com/sun/star/text/XTextFrame.idl> + + + module com { module sun { module star { module text { + + +/** specifies the base service of text frames, graphic objects, and embedded objects + */ +published service BaseFrame +{ + service BaseFrameProperties; + service TextContent; + /** This interface specifies the access to the shape data (position + and size) of the text frame. + + <p>This interface is valid before the text frame is attached + to a surrounding text, but when attached the values can change + (e.g., due to a revised layout of the surrounding text). + + <p>The position is relative to the position of the anchor + [see XTextFrame::getAnchor()]. Size and position are + both measured in 100th mm. The size is not valid if the + size is relative and no layout exists or if the layout is invalid. + + <p>This interface is only for the layout. In particular, the + setting of values is only allowed for the layout component of the + owner text of this text component. + */ + [optional] interface com::sun::star::drawing::XShape; + /** This interface makes it possible to access the properties of + this text frame. + + <p>This interface is valid before the text frame is attached to + a surrounding text. + */ + interface com::sun::star::beans::XPropertySet; + /** This interface specifies the name of this text frame. + + <p>The name may be set automatically by the container if it is not + set when inserted. In this case a random, unique name is assigned. + */ + interface com::sun::star::container::XNamed; + /** contains the name of the frame style that is applied to this object. + */ + [property] string FrameStyleName; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BaseFrameProperties.idl b/offapi/com/sun/star/text/BaseFrameProperties.idl new file mode 100644 index 000000000..3741f0af2 --- /dev/null +++ b/offapi/com/sun/star/text/BaseFrameProperties.idl @@ -0,0 +1,388 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_BaseFrameProperties_idl__ +#define __com_sun_star_text_BaseFrameProperties_idl__ + +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/table/BorderLine.idl> +#include <com/sun/star/table/ShadowFormat.idl> +#include <com/sun/star/text/XTextFrame.idl> +#include <com/sun/star/text/WrapTextMode.idl> +#include <com/sun/star/awt/Size.idl> +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> +#include <com/sun/star/drawing/FillStyle.idl> +#include <com/sun/star/awt/Gradient.idl> +#include <com/sun/star/drawing/TextVerticalAdjust.hpp> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** specifies the properties that are provided by all text frames, graphic objects, embedded objects + and frame styles. + */ +published service BaseFrameProperties +{ + /** gives access to the UserDefinedAttributes property. + @since OOo 2.1 + */ + [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; + + /** contains the number of the page where the objects are anchored. + <p> The value is valid only if the + AnchorType is + TextContentAnchorType::AT_PAGE.</p> + */ + [property] short AnchorPageNo; + /** contains the text frame the current frame is anchored to. + <p> The value is valid only if the + AnchorType is TextContentAnchorType::AT_FRAME.</p> + */ + [property] com::sun::star::text::XTextFrame AnchorFrame; + + /** contains the color of the background of the object. + */ + [property] com::sun::star::util::Color BackColor; + + /** contains the URL for the background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the file filter for the background graphic. + */ + [property] string BackGraphicFilter; + + /** determines the position of the background graphic. + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + /** contains the left border of the object. + + @see BaseFrame::com::sun::star::table::BorderLine + */ + [property] com::sun::star::table::BorderLine LeftBorder; + + /** contains the right border of the object. + + @see BaseFrame::com::sun::star::table::BorderLine + */ + [property] com::sun::star::table::BorderLine RightBorder; + + /** contains the top border of the object. + + @see BaseFrame::com::sun::star::table::BorderLine + */ + [property] com::sun::star::table::BorderLine TopBorder; + + /** contains the bottom border of the object. + + @see BaseFrame::com::sun::star::table::BorderLine + */ + [property] com::sun::star::table::BorderLine BottomBorder; + + /** contains the distance from the border to the object. + */ + [property] long BorderDistance; + + /** contains the distance from the left border to the object. + */ + [property] long LeftBorderDistance; + + /** contains the distance from the right border to the object. + */ + [property] long RightBorderDistance; + + /** contains the distance from the top border to the object. + */ + [property] long TopBorderDistance; + + /** contains the distance from the bottom border to the object. + */ + [property] long BottomBorderDistance; + + /** If TRUE, the "BackColor" is ignored. + */ + [property] boolean BackTransparent; + + + /** determines if the content is protected. + */ + [property] boolean ContentProtected; + /** contains the left margin of the object. + */ + [property] long LeftMargin; + + /** contains the right margin of the object. + */ + [property] long RightMargin; + + + /** contains the top margin of the object. + */ + [property] long TopMargin; + + /** contains the bottom margin of the object. + */ + [property] long BottomMargin; + + /** contains the height of the object (1/100 mm). + <p>It is only valid if TextEmbeddedObject::RelativeHeight is zero.</p> + */ + [property] long Height; + + /** contains the width of the object (1/100 mm). + <p>It is only valid if TextEmbeddedObject::RelativeWidth is zero.</p> + */ + [property] long Width; + /** contains the relative height of the object. + <p> It is only valid if it is greater than zero.</p> + */ + [property] short RelativeHeight; + + /** contains the relative width of the object. + <p> It is only valid if it is greater than zero. </p> + */ + [property] short RelativeWidth; + /** determines whether the width follows the height. + */ + [property] boolean IsSyncWidthToHeight; + /** determines whether the height follows the width. + */ + [property] boolean IsSyncHeightToWidth; + /** determines the horizontal orientation of the object. + + @see BaseFrame::HoriOrientation + */ + [property] short HoriOrient; + /** contains the horizontal position of the object (1/100 mm). + <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p> + */ + [property] long HoriOrientPosition; + + /** determines the environment of the object to which the orientation + is related. + + @see BaseFrame::RelOrientation + */ + [property] short HoriOrientRelation; + + /** determines the vertical orientation of the object. + + @see BaseFrame::VertOrientation + */ + [property] short VertOrient; + + /** contains the vertical position of the object (1/100 mm). + + It is only valid if TextEmbeddedObject::VertOrient is + VertOrientation::NONE. + */ + [property] long VertOrientPosition; + + + /** determines the environment of the object to which the orientation is related. + + @see BaseFrame::RelOrientation + */ + [property] short VertOrientRelation; + + /** contains the URL of a hyperlink that is set at the object. + */ + [property] string HyperLinkURL; + + /** contains the name of the target for a hyperlink that is set at the object. + */ + [property] string HyperLinkTarget; + + /** contains the name of the hyperlink that is set at the object. + */ + [property] string HyperLinkName; + + /** determines if the object is opaque or transparent for text. + */ + [property] boolean Opaque; + + /** determines if the object is mirrored on even pages. + */ + [property] boolean PageToggle; + + /** determines if the position is protected. + */ + [property] boolean PositionProtected; + + /** determines if the object is included in printing. + */ + [property] boolean Print; + + /** contains the type of the shadow of the object. + */ + [property] com::sun::star::table::ShadowFormat ShadowFormat; + + /** determines if the object gets an image map from a server. + */ + [property] boolean ServerMap; + + /** contains the size of the object. + + @see BaseFrame::Height + @see BaseFrame::Width + */ + [property] com::sun::star::awt::Size Size; + + /** determines if the size is protected. + */ + [property] boolean SizeProtected; + /** determines the type of the surrounding text. + + @deprecated + */ + [property] com::sun::star::text::WrapTextMode Surround; + + /** determines if the text of the paragraph in which the object + is anchored, wraps around the object. + */ + [property] boolean SurroundAnchorOnly; + + /** determines the influence of the text wrap on the positioning of the + shape + + <p>The value of this property is only evaluated for the positioning + of the shape, if the text document setting ConsiderTextWrapOnObjPos + is `TRUE`. Valid values are given by #WrapInfluenceOnPosition</p> + + @since OOo 2.0 + */ + [optional, property] short WrapInfluenceOnPosition; + + /** returns the actual size of the object. + + <p>Since to obtain the correct actual size of the object not only + the layouting for the frame needs to be finished but the whole + document needs to be formatted as well. Thus if that was not done + previously it may take some while to retrieve this value.</p> + + @since OOo 2.0.4 + */ + [optional, property, maybevoid] com::sun::star::awt::Size LayoutSize; + + /** contains short title for the object + + <p>This short title is visible as an alternative tag in HTML format. + Accessibility tools can read this text.</p> + + @since OOo 3.2 + */ + [optional, property] string Title; + + /** contains description for the object + + <p>The long description text can be entered to describe an object in + more detail to users with screen reader software. The description is + visible as an alternative tag for accessibility tools.</p> + + @since OOo 3.2 + */ + [optional, property] string Description; + /** This enumeration selects the style the area will be filled with. + + <p>Currently only set for gradients.</p> + + @since LibreOffice 4.1 + */ + [optional, property] com::sun::star::drawing::FillStyle FillStyle; + /** If the property #FillStyle is set to + FillStyle::GRADIENT, this describes the gradient used. + + @since LibreOffice 4.1 + */ + [optional, property] com::sun::star::awt::Gradient FillGradient; + /** If the property #FillStyle is set to + FillStyle::GRADIENT, this is the name of the gradient used. + + @since LibreOffice 4.1 + */ + [optional, property] string FillGradientName; + + /** This defines the degree of transparence of the shadow in percent. + + <p>This is the same as setting the Color member of the + #ShadowFormat property to an ARGB color.</p> + + @since LibreOffice 4.2 + */ + [optional, property] short ShadowTransparence; + + /** Grab bag of frame properties, used as a string-any map for interim interop purposes. + + @since LibreOffice 4.2 + + <p>This property is intentionally not handled by the ODF filter. Any + member that should be handled there should be first moved out from this grab + bag to a separate property.</p> + */ + [optional, property] sequence<com::sun::star::beans::PropertyValue> FrameInteropGrabBag; + + /** contains the relation of the relative height of the object. + <p> It is only valid if RelativeHeight is greater than zero.</p> + + @see com::sun::star::text::RelOrientation + @since LibreOffice 4.3 + */ + [optional, property] short RelativeHeightRelation; + + /** contains the relation of the relative width of the object. + <p> It is only valid if RelativeWidth is greater than zero.</p> + + @see com::sun::star::text::RelOrientation + @since LibreOffice 4.3 + */ + [optional, property] short RelativeWidthRelation; + + /** contains the graphic for the background. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; + + /** This defines if the frame is allowed to overlap with other anchored objects. + @since LibreOffice 6.4 + */ + [optional, property] boolean AllowOverlap; + + /** Contains popup text for the frame, used to for tooltip purposes if it's non-empty. + + @since LibreOffice 7.4 + */ + [optional, property] string Tooltip; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BaseIndex.idl b/offapi/com/sun/star/text/BaseIndex.idl new file mode 100644 index 000000000..8ce9aa25c --- /dev/null +++ b/offapi/com/sun/star/text/BaseIndex.idl @@ -0,0 +1,135 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_BaseIndex_idl__ +#define __com_sun_star_text_BaseIndex_idl__ + +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/util/XRefreshable.idl> +#include <com/sun/star/text/XDocumentIndex.idl> +#include <com/sun/star/container/XIndexReplace.idl> +#include <com/sun/star/text/XTextColumns.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/lang/Locale.idl> +#include <com/sun/star/text/XTextSection.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex + @see com::sun::star::text::ContentIndex + @see com::sun::star::text::UserDefinedIndex + @see com::sun::star::text::IllustrationsIndex + @see com::sun::star::text::TableIndex + @see com::sun::star::text::ObjectIndex + */ +published service BaseIndex +{ + interface com::sun::star::text::XDocumentIndex; + + /** @since LibreOffice 4.0 */ + [optional] interface com::sun::star::util::XRefreshable; + + /** contains the title of the index.*/ + [property] string Title; + /** determines if the index is protected.*/ + [property] boolean IsProtected; + /** contains the name of the paragraph style that is applied to the heading.*/ + [property] string ParaStyleHeading; + /** contains the name of the paragraph style that is applied to the 1st level.*/ + [property] string ParaStyleLevel1; + /** contains the name of the paragraph style that is applied to the 2nd level.*/ + [optional, property] string ParaStyleLevel2; + /** contains the name of the paragraph style that is applied to the 3rd level.*/ + [optional, property] string ParaStyleLevel3; + /** contains the name of the paragraph style that is applied to the 4th level.*/ + [optional, property] string ParaStyleLevel4; + /** contains the name of the paragraph style that is applied to the 5th level.*/ + [optional, property] string ParaStyleLevel5; + /** contains the name of the paragraph style that is applied to the 6th level.*/ + [optional, property] string ParaStyleLevel6; + /** contains the name of the paragraph style that is applied to the 7th level.*/ + [optional, property] string ParaStyleLevel7; + /** contains the name of the paragraph style that is applied to the 8th level.*/ + [optional, property] string ParaStyleLevel8; + /** contains the name of the paragraph style that is applied to the 9th level.*/ + [optional, property] string ParaStyleLevel9; + /** contains the name of the paragraph style that is applied to the 10th level.*/ + [optional, property] string ParaStyleLevel10; + /** contains the name of the paragraph style that is applied to the separator level.*/ + [optional, property] string ParaStyleSeparator; + /** contains the column interface.*/ + [property] XTextColumns TextColumns; + + /** contains the URL of a graphic file that is displayed as background graphic + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the filter of the graphic file that is + displayed as background graphic*/ + [property] string BackGraphicFilter; + /** determines the position of the background graphic.@see GraphicLocation + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + /** specifies the color of the background. + */ + [property] com::sun::star::util::Color BackColor; + + /** If `TRUE`, the background color value in "BackColor" is not visible. + */ + [property] boolean BackTransparent; + + /** returns the interface of the level format of the index. + <p> + The description of the format of the levels depends on the type of the document index. + </p> + @see DocumentIndexLevelFormat + */ + [optional, property] com::sun::star::container::XIndexReplace LevelFormat; + /** determines if the content of the document index is created from the + complete document content or from the current chapter only. + <p> It is not available in the bibliography</p>*/ + [optional, property] boolean CreateFromChapter; + /** the text section containing the content of the index */ + [property] com::sun::star::text::XTextSection ContentSection; + /** the text section containing the header of the index */ + [property] com::sun::star::text::XTextSection HeaderSection; + + /** contains the graphic object that is displayed as background graphic. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; +}; + + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BaseIndexMark.idl b/offapi/com/sun/star/text/BaseIndexMark.idl new file mode 100644 index 000000000..5646d3e8b --- /dev/null +++ b/offapi/com/sun/star/text/BaseIndexMark.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_BaseIndexMark_idl__ +#define __com_sun_star_text_BaseIndexMark_idl__ + +#include <com/sun/star/text/TextContent.idl> + + + + module com { module sun { module star { module text { + + +/** is a TextRange which is explicitly marked + as an index entry. This is the base service of index marks for DocumentIndex, + ContentIndex, and UserIndex. + */ +published service BaseIndexMark +{ + service com::sun::star::text::TextContent; + + /** the string that will be inserted into the corresponding index. If AlternativeText is empty then + the string that is marked by the TextRange is inserted into the index. + */ + [property] string AlternativeText; +}; + + +}; }; }; }; +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Bibliography.idl b/offapi/com/sun/star/text/Bibliography.idl new file mode 100644 index 000000000..f5e6efedb --- /dev/null +++ b/offapi/com/sun/star/text/Bibliography.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_Bibliography_idl__ +#define __com_sun_star_text_Bibliography_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + + module com { module sun { module star { module text { + +/** specifies service of bibliography within a text document.@see com::sun::star::text::BaseIndex + */ +published service Bibliography +{ + service com::sun::star::text::BaseIndex; + /** contains the locale of the index. + */ + [property] com::sun::star::lang::Locale Locale; + /** contains the name of the sort algorithm that is used to sort the entries. + */ + [property] string SortAlgorithm; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BibliographyDataField.idl b/offapi/com/sun/star/text/BibliographyDataField.idl new file mode 100644 index 000000000..892322424 --- /dev/null +++ b/offapi/com/sun/star/text/BibliographyDataField.idl @@ -0,0 +1,138 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_BibliographyDataField_idl__ +#define __com_sun_star_text_BibliographyDataField_idl__ + + + module com { module sun { module star { module text { +/** These values define parts of bibliographic data. They are used to create a + bibliography in a text document. + <p> Depending on the type of the data some of the fields will usually be left empty. + </p> + */ +published constants BibliographyDataField +{ + /** This field contains a unique identifier for the bibliographic data. + */ + const short IDENTIFIER = 0; + /** This field contains the type of the bibliographic reference. It is of the + type BibliographyDataType. + @see BibliographyDataType + */ + const short BIBILIOGRAPHIC_TYPE = 1; + /** This field contains the address of the publisher. + */ + const short ADDRESS = 2; + /** This field contains an annotation. + */ + const short ANNOTE = 3; + /** This field contains the name(s) of the author(s) + */ + const short AUTHOR = 4; + /** This field contains the title of the book. + */ + const short BOOKTITLE = 5; + /** This field contains the name or number of the chapter. + */ + const short CHAPTER = 6; + /** This field contains the number or name of the edition. + */ + const short EDITION = 7; + /** This field contains the name(s) of the editor(s) + */ + const short EDITOR = 8; + /** This field contains a description of the type of the publishing. + */ + const short HOWPUBLISHED = 9; + /** This field contains the name of the institution where the publishing was created. + */ + const short INSTITUTION = 10; + /** This field contains the name of the journal. + */ + const short JOURNAL = 11; + /** This field contains number or name of the month of the publishing. + */ + const short MONTH = 12; + /** This field contains a note. + */ + const short NOTE = 13; + /** This field contains the number of the publishing. + */ + const short NUMBER = 14; + /** This field contains the name of the organizations where the publishing was created. + */ + const short ORGANIZATIONS = 15; + /** This field contains the number(s) of the page(s) of the reference into a publishing. + */ + const short PAGES = 16; + /** This field contains the name of the publisher. + */ + const short PUBLISHER = 17; + /** This field contains the name of the university or school where the publishing was created. + */ + const short SCHOOL = 18; + /** This field contains the series of the publishing. + */ + const short SERIES = 19; + /** This field contains the title of the publishing. + */ + const short TITLE = 20; + /** This field contains a description of the type of the report. + */ + const short REPORT_TYPE = 21; + /** This field contains the volume of the publishing. + */ + const short VOLUME = 22; + /** This field contains the year when the publishing was created. + */ + const short YEAR = 23; + /** This field contains URL of the publishing. + */ + const short URL = 24; + /** This field contains user defined data. + */ + const short CUSTOM1 = 25; + /** This field contains user defined data. + */ + const short CUSTOM2 = 26; + /** This field contains user defined data. + */ + const short CUSTOM3 = 27; + /** This field contains user defined data. + */ + const short CUSTOM4 = 28; + /** This field contains user defined data. + */ + const short CUSTOM5 = 29; + /** This field contains the ISBN data of the publishing. + */ + const short ISBN = 30; + /** This field contains a local copy of the publishing. + + @since LibreOffice 7.3 + */ + const short LOCAL_URL = 31; +}; + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/BibliographyDataType.idl b/offapi/com/sun/star/text/BibliographyDataType.idl new file mode 100644 index 000000000..9d2d690f0 --- /dev/null +++ b/offapi/com/sun/star/text/BibliographyDataType.idl @@ -0,0 +1,101 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_BibliographyDataType_idl__ +#define __com_sun_star_text_BibliographyDataType_idl__ + + + module com { module sun { module star { module text { +/** These values define the type of bibliographic data like book, journal, magazine, etc. + */ +published constants BibliographyDataType +{ + /** An article from a journal or magazine. + */ + const short ARTICLE = 0; + /** A book with an explicit publisher. + */ + const short BOOK = 1; + /** A work that is printed and bound, but without a named publisher or sponsoring institution. + */ + const short BOOKLET = 2; + /** An article in the proceedings of a conference. This entry is identical to the "inproceedings" + entry and is included for compatibility with BiBTex. + */ + const short CONFERENCE = 3; + /** A part of a book, which may be a chapter and/or a range of pages. + */ + const short INBOOK = 4; + /** A part of a book with its own title. + */ + const short INCOLLECTION = 5; + /** An article in the proceedings of a conference. + */ + const short INPROCEEDINGS = 6; + /** A journal or magazine. + */ + const short JOURNAL = 7; + /** Technical documentation. + */ + const short MANUAL = 8; + /** A Master's thesis. + */ + const short MASTERSTHESIS = 9; + /** This type is used when nothing else seems appropriate. + */ + const short MISC = 10; + /** A PhD thesis. + */ + const short PHDTHESIS = 11; + /** The proceedings of a conference. + */ + const short PROCEEDINGS = 12; + /** A report published by a school or other institution, usually numbered within a series. + */ + const short TECHREPORT = 13; + /** A document with an author and title, but not formally published. + */ + const short UNPUBLISHED = 14; + /** An eMail document + */ + const short EMAIL = 15; + /** A Web document + */ + const short WWW = 16; + /** A user defined document type + */ + const short CUSTOM1 = 17; + /** A user defined document type + */ + const short CUSTOM2 = 18; + /** A user defined document type + */ + const short CUSTOM3 = 19; + /** A user defined document type + */ + const short CUSTOM4 = 20; + /** A user defined document type + */ + const short CUSTOM5 = 21; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Bookmark.idl b/offapi/com/sun/star/text/Bookmark.idl new file mode 100644 index 000000000..fc73ca636 --- /dev/null +++ b/offapi/com/sun/star/text/Bookmark.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Bookmark_idl__ +#define __com_sun_star_text_Bookmark_idl__ + +#include <com/sun/star/text/TextContent.idl> + +#include <com/sun/star/container/XNamed.idl> + + + + module com { module sun { module star { module text { + +/** A bookmark is a TextContent, which is like a jump + target or a label. + */ +published service Bookmark +{ + service com::sun::star::text::TextContent; + + /** This interface specifies the name of the bookmark. + */ + interface com::sun::star::container::XNamed; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Bookmarks.idl b/offapi/com/sun/star/text/Bookmarks.idl new file mode 100644 index 000000000..b9bafdb30 --- /dev/null +++ b/offapi/com/sun/star/text/Bookmarks.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Bookmarks_idl__ +#define __com_sun_star_text_Bookmarks_idl__ + +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + +/** This service specifies a collection of Bookmarks. + */ +published service Bookmarks +{ + + /** makes it possible to access the bookmarks by their names. + + <p>All contents support the service Bookmark. + */ + interface com::sun::star::container::XNameAccess; + /** makes it possible to access the bookmarks by their index. + + <p>All contents support the service Bookmark. + */ + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Cell.idl b/offapi/com/sun/star/text/Cell.idl new file mode 100644 index 000000000..7051208e4 --- /dev/null +++ b/offapi/com/sun/star/text/Cell.idl @@ -0,0 +1,94 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_Cell_idl__ +#define __com_sun_star_text_Cell_idl__ + +#include <com/sun/star/text/CellProperties.idl> +#include <com/sun/star/table/CellProperties.idl> +#include <com/sun/star/table/XCell.idl> +#include <com/sun/star/text/XText.idl> + + +module com { module sun { module star { module text { + + +/** represents a single cell within a text table. + + @see com::sun::star::text::TextTable + */ +service Cell +{ + /** contains the properties of the text table cell. + */ + service com::sun::star::text::CellProperties; + + /** contains properties from table cells. + + <p>All of these properties are either already available in the + service + com::sun::star::text::CellProperties, + or get matched against one of those or are implemented + non-functional since they serve no purpose for text tables.</p> + + <p>The complete list is as follows:</p> + <ul> + <li>CellStyle: optional property, not implemented.</li> + <li>CellBackColor: matched to "BackColor".</li> + <li>IsCellBackgroundTransparent: matched to "BackTransparent".</li> + <li>HoriJustify: non-functional implementation.</li> + <li>VertJustify: non-functional implementation.</li> + <li>IsTextWrapped: non-functional implementation.</li> + <li>ParaIndent: non-functional implementation.</li> + <li>Orientation: non-functional implementation.</li> + <li>RotateAngle: non-functional implementation.</li> + <li>RotateReference: non-functional implementation.</li> + <li>AsianVerticalMode: optional property, not implemented.</li> + <li>TableBorder: non-functional implementation.</li> + <li>TopBorder: already available.</li> + <li>BottomBorder: already available.</li> + <li>LeftBorder: already available.</li> + <li>RightBorder: already available.</li> + <li>NumberFormat: already available.</li> + <li>ShadowFormat: non-functional implementation.</li> + <li>CellProtection: non-functional implementation.</li> + </ul> + + @since OOo 2.0 + */ + service com::sun::star::table::CellProperties; + + + /** provides access to the cell contents. + */ + interface com::sun::star::table::XCell; + + + /** provides access to formatted and unformatted text contents. + */ + interface com::sun::star::text::XText; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/CellProperties.idl b/offapi/com/sun/star/text/CellProperties.idl new file mode 100644 index 000000000..21bda1c22 --- /dev/null +++ b/offapi/com/sun/star/text/CellProperties.idl @@ -0,0 +1,151 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_CellProperties_idl__ +#define __com_sun_star_text_CellProperties_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/text/XTextSection.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/table/BorderLine.idl> +#include <com/sun/star/container/XNameContainer.idl> +#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** service that holds all cell properties of a text table cell in a text document. + + @see com::sun::star::text::Cell + */ +published service CellProperties +{ + /** contains user defined attributes. + + @see com::sun::star::xml::UserDefinedAttributesSupplier + */ + service com::sun::star::xml::UserDefinedAttributesSupplier; + + + /** gives access to the objects properties + */ + interface com::sun::star::beans::XPropertySet; + + /** contains the cell name, see SwXTextTable::getCellByName for more information + */ + [property] string CellName; + + /** contains the background color. + */ + [property] com::sun::star::util::Color BackColor; + + /** contains the URL to the background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the graphic filter of the background graphic. + */ + [property] string BackGraphicFilter; + + /** determines the position of the background graphic. + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + /** contains the number format. + */ + [property] long NumberFormat; + + /** determines whether the background is transparent. + */ + [property] boolean BackTransparent; + + /** contains the left border line. + */ + [property] com::sun::star::table::BorderLine LeftBorder; + + /** contains the right border line. + */ + [property] com::sun::star::table::BorderLine RightBorder; + + /** contains the top border line. + */ + [property] com::sun::star::table::BorderLine TopBorder; + + /** contains the bottom border line. + */ + [property] com::sun::star::table::BorderLine BottomBorder; + + /** contains the distance of the left border. + */ + [property] long LeftBorderDistance; + + /** contains the distance of the right border. + */ + [property] long RightBorderDistance; + + /** contains the distance of the top border. + */ + [property] long TopBorderDistance; + + /** contains the distance of the bottom border. + */ + [property] long BottomBorderDistance; + + /** contains the text section the text table is contained in if there is any. + */ + [readonly, property]com::sun::star::text::XTextSection TextSection; + + /** determines whether the cell is write protected or not. + */ + [property] boolean IsProtected; + + /** the vertical orientation of the text inside of the table cells in + this row.@see VertOrientation + */ + [property] short VertOrient; + + /** contains the graphic object that is displayed as background graphic. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; + + /** Parent text of this table cell. + + This might be a header text, body text, parent cell, etc. + + @since LibreOffice 6.3 + */ + [optional, readonly, property] com::sun::star::text::XText ParentText; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/CellRange.idl b/offapi/com/sun/star/text/CellRange.idl new file mode 100644 index 000000000..c2d73c7ad --- /dev/null +++ b/offapi/com/sun/star/text/CellRange.idl @@ -0,0 +1,124 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_CellRange_idl__ +#define __com_sun_star_text_CellRange_idl__ + +#include <com/sun/star/table/XCellRange.idl> +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/sheet/XCellRangeData.idl> +#include <com/sun/star/container/XNamed.idl> +#include <com/sun/star/style/ParagraphProperties.idl> +#include <com/sun/star/style/ParagraphPropertiesAsian.idl> +#include <com/sun/star/style/ParagraphPropertiesComplex.idl> +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#include <com/sun/star/style/CharacterProperties.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/chart/XChartDataArray.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** area of cells within a text table. + + @see com::sun::star::text::TextTable + */ +published service CellRange +{ + service com::sun::star::style::CharacterProperties; + + service com::sun::star::style::CharacterPropertiesAsian; + + service com::sun::star::style::CharacterPropertiesComplex; + + service com::sun::star::style::ParagraphProperties; + + [optional] service com::sun::star::style::ParagraphPropertiesAsian; + + [optional] service com::sun::star::style::ParagraphPropertiesComplex; + + interface com::sun::star::table::XCellRange; + + [optional] interface com::sun::star::sheet::XCellRangeData; + + [optional] interface com::sun::star::chart::XChartDataArray; + + + /** contains color of the background. + */ + [property] com::sun::star::util::Color BackColor; + + + /** contains the filter name of the background graphic. + */ + [property] string BackGraphicFilter; + + + /** determines the location of the background graphic. + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + + /** contains the URL of the background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** determines if the background color is transparent. + */ + [property] boolean BackTransparent; + + + /** determines if the first column of the table should be treated as + axis labels when a chart is to be created. + */ + [property] boolean ChartColumnAsLabel; + + + /** determines if the first row of the table should be treated as + axis labels when a chart is to be created. + */ + [property] boolean ChartRowAsLabel; + + + /** contains the number format. + */ + [property] long NumberFormat; + + /** contains the graphic of the background. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ChainedTextFrame.idl b/offapi/com/sun/star/text/ChainedTextFrame.idl new file mode 100644 index 000000000..1b8c8185b --- /dev/null +++ b/offapi/com/sun/star/text/ChainedTextFrame.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ChainedTextFrame_idl__ +#define __com_sun_star_text_ChainedTextFrame_idl__ + +#include <com/sun/star/text/TextFrame.idl> + +#include <com/sun/star/util/XChainable.idl> + + + + module com { module sun { module star { module text { + + +/** extends a TextFrame which shares the same Text + with other ChainedTextFrame instances that will make the text + flow through the chained frames. The text flows in the next frame if + there is no space left in the current frame. + */ +published service ChainedTextFrame +{ + service com::sun::star::text::TextFrame; + + /** name of the previous frame in the chain + + <p>An empty string indicates that there is no previous frame.</p> + */ + [property, maybevoid] string ChainNextName; + + /** name of the next frame in the chain + + <p>An empty string indicates that there is no next frame.</p> + */ + [property, maybevoid] string ChainPrevName; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ChapterFormat.idl b/offapi/com/sun/star/text/ChapterFormat.idl new file mode 100644 index 000000000..a0f135d0d --- /dev/null +++ b/offapi/com/sun/star/text/ChapterFormat.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ChapterFormat_idl__ +#define __com_sun_star_text_ChapterFormat_idl__ + + + + module com { module sun { module star { module text { + +/** These constants define the display format of the chapter number in a + chapter text field. + */ +published constants ChapterFormat +{ + /** The title of the chapter is displayed. + */ + const short NAME = 0; + + /** The number including prefix and suffix of the chapter is displayed. + */ + const short NUMBER = 1; + + /** The title and number including prefix and suffix of the chapter are displayed. + */ + const short NAME_NUMBER = 2; + + /** The name and number of the chapter are displayed. + */ + const short NO_PREFIX_SUFFIX = 3; + + /** The number of the chapter is displayed. + */ + const short DIGIT = 4; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ChapterNumberingRule.idl b/offapi/com/sun/star/text/ChapterNumberingRule.idl new file mode 100644 index 000000000..0071b0fe4 --- /dev/null +++ b/offapi/com/sun/star/text/ChapterNumberingRule.idl @@ -0,0 +1,70 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ChapterNumberingRule_idl__ +#define __com_sun_star_text_ChapterNumberingRule_idl__ + +#include <com/sun/star/style/NumberingRule.idl> + + + + module com { module sun { module star { module text { + +/** describes the rules for chapter numbering in a text document. + + + + <p>Some of the properties that are available in the interface are + ignored here. + + </p> + <p>The type of numbering can only be: + NUM_CHARS_UPPER_LETTER, NUM_CHARS_LOWER_LETTER, NUM_ROMAN_UPPER, + NUM_ROMAN_LOWER, NUM_ARABIC, or NUM_NUMBER_NONE + + </p> + <p>In the com::sun::star::style::NumberingAlignment only the field + com::sun::star::style::NumberingAlignment::Alignment is applied. + + </p> + <p>Depending on the numbering types, the parameters for bullets or bit maps + may be ignored. The character style name for the numbering symbol is + also ignored.</p> + */ +published service ChapterNumberingRule +{ + service com::sun::star::style::NumberingRule; + + /** contains the name of the paragraph style that marks this heading + level. + + + + <p>It is necessary that each style name appears only + once in the sequence of numbering rules.</p> + */ + [property] string HeadingStyleName; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/CharacterCompressionType.idl b/offapi/com/sun/star/text/CharacterCompressionType.idl new file mode 100644 index 000000000..16e6338b8 --- /dev/null +++ b/offapi/com/sun/star/text/CharacterCompressionType.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_CharacterCompressionType_idl__ +#define __com_sun_star_text_CharacterCompressionType_idl__ + + + + module com { module sun { module star { module text { + + +/** These constants define character compression in Asian text. + */ +published constants CharacterCompressionType +{ + /** the characters are uncompressed. + */ + const short NONE = 0; + + /** only punctuation is compressed. + */ + const short PUNCTUATION_ONLY = 1; + + /** punctuation and Japanese Kana are compressed. + */ + const short PUNCTUATION_AND_KANA = 2; + +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ColumnSeparatorStyle.idl b/offapi/com/sun/star/text/ColumnSeparatorStyle.idl new file mode 100644 index 000000000..70df14ffd --- /dev/null +++ b/offapi/com/sun/star/text/ColumnSeparatorStyle.idl @@ -0,0 +1,30 @@ +/* -*- 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/. + */ +#ifndef __com_sun_star_text_ColumnSeparatorStyle_idl__ +#define __com_sun_star_text_ColumnSeparatorStyle_idl__ + +module com { module sun { module star { module text { + +published constants ColumnSeparatorStyle +{ + const short NONE = 0; + + const short SOLID = 1; + + const short DOTTED = 2; + + const short DASHED = 3; +}; + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ContentIndex.idl b/offapi/com/sun/star/text/ContentIndex.idl new file mode 100644 index 000000000..9b7a53179 --- /dev/null +++ b/offapi/com/sun/star/text/ContentIndex.idl @@ -0,0 +1,62 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_ContentIndex_idl__ +#define __com_sun_star_text_ContentIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + +module com { module sun { module star { module text { + + +/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex + */ +published service ContentIndex +{ + service com::sun::star::text::BaseIndex; + + /** determines the depth of outline levels that are included into the content index.*/ + + [optional, property] short Level; + + /** determines if the document index is created from outlines. + */ + [optional, property] boolean CreateFromOutline; + + /** contains the interface to access the paragraph style names that are included + in this index. + @see DocumentIndexParagraphStyles + */ + [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; + + /** contains `TRUE` if the document index marks are included in this index. + */ + [optional, property] boolean CreateFromMarks; + + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ContentIndexMark.idl b/offapi/com/sun/star/text/ContentIndexMark.idl new file mode 100644 index 000000000..3a05f286b --- /dev/null +++ b/offapi/com/sun/star/text/ContentIndexMark.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ContentIndexMark_idl__ +#define __com_sun_star_text_ContentIndexMark_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/BaseIndexMark.idl> + + + + module com { module sun { module star { module text { + +/** is a TextRange which is explicitly marked + as an index entry for a ContentIndex. + */ +published service ContentIndexMark +{ + service com::sun::star::text::TextContent; + + service com::sun::star::text::BaseIndexMark; + + /** contains the level into which the index mark will be inserted into the content index. + */ + [property] short Level; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ControlCharacter.idl b/offapi/com/sun/star/text/ControlCharacter.idl new file mode 100644 index 000000000..702384a11 --- /dev/null +++ b/offapi/com/sun/star/text/ControlCharacter.idl @@ -0,0 +1,67 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ControlCharacter_idl__ +#define __com_sun_star_text_ControlCharacter_idl__ + + + + module com { module sun { module star { module text { + +/** These constants are the codes for inserting control characters + using XSimpleText::insertControlCharacter() interface. + */ +published constants ControlCharacter +{ + /** This control character starts a new paragraph. + */ + const short PARAGRAPH_BREAK = 0; + + /** This control character starts a new line in a paragraph. + */ + const short LINE_BREAK = 1; + + /** This control character equals a dash but prevents this + position from being hyphenated. + */ + const short HARD_HYPHEN = 2; + + /** This control character defines a special position as a + hyphenation point. If a word containing a soft hyphen + must be split at the end of a line, then this position + is preferred. + */ + const short SOFT_HYPHEN = 3; + + /** This control character is used to link two words and + prevents this concatenation from being hyphenated. + It is printed as a space. + */ + const short HARD_SPACE = 4; + + /** This control character appends a new paragraph. + */ + const short APPEND_PARAGRAPH = 5; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DateDisplayFormat.idl b/offapi/com/sun/star/text/DateDisplayFormat.idl new file mode 100644 index 000000000..ce314a877 --- /dev/null +++ b/offapi/com/sun/star/text/DateDisplayFormat.idl @@ -0,0 +1,80 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DateDisplayFormat_idl__ +#define __com_sun_star_text_DateDisplayFormat_idl__ + + + + module com { module sun { module star { module text { + + +/** This constants define how a date field is formatted before it is displayed. + The format may also depend on the system or document locale. The samples + are in German. + + @deprecated + */ +published constants DateDisplayFormat +{ + /** the shortest system standard + */ + const short STANDARD_SHORT = 0; + + + /** the longest system standard + */ + const short STANDARD_LONG = 1; + + + /** 22.11.73 + */ + const short MMDDYY = 2; + + + /** 22.11.1973 + */ + const short MMDDYYYY = 3; + + + /** 22. Nov 1973 + */ + const short DDMMMYYYY = 4; + + + /** 22. November 1973 + */ + const short DDMMMMYYYY = 5; + + + /** Do, 22. November 1973 + */ + const short NNDDMMMMYYYY = 6; + + + /** Donnerstag, 22. November 1973 + */ + const short NNNNDDMMMMYYYY = 7; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DefaultNumberingProvider.idl b/offapi/com/sun/star/text/DefaultNumberingProvider.idl new file mode 100644 index 000000000..00a9968e6 --- /dev/null +++ b/offapi/com/sun/star/text/DefaultNumberingProvider.idl @@ -0,0 +1,37 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_DefaultNumberingProvider_idl__ +#define __com_sun_star_text_DefaultNumberingProvider_idl__ + +#include <com/sun/star/text/XDefaultNumberingProvider.idl> + + + module com { module sun { module star { module text { + +/** provides access to language dependent numbering types and supports + formatting of those numberings. + */ +published service DefaultNumberingProvider : XDefaultNumberingProvider; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Defaults.idl b/offapi/com/sun/star/text/Defaults.idl new file mode 100644 index 000000000..2c117c2b9 --- /dev/null +++ b/offapi/com/sun/star/text/Defaults.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Defaults_idl__ +#define __com_sun_star_text_Defaults_idl__ + +#include <com/sun/star/style/CharacterProperties.idl> +#include <com/sun/star/style/ParagraphProperties.idl> +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#include <com/sun/star/style/ParagraphPropertiesAsian.idl> +#include <com/sun/star/style/ParagraphPropertiesComplex.idl> +#include <com/sun/star/beans/XPropertySet.idl> + + + module com { module sun { module star { module text { + + +/** provides default settings of a text component for paragraph and + character properties. + */ +published service Defaults +{ + service com::sun::star::style::CharacterProperties; + + service com::sun::star::style::ParagraphProperties; + + [optional] service com::sun::star::style::CharacterPropertiesAsian; + + [optional] service com::sun::star::style::CharacterPropertiesComplex; + + [optional] service com::sun::star::style::ParagraphPropertiesAsian; + + [optional] service com::sun::star::style::ParagraphPropertiesComplex; + + + interface com::sun::star::beans::XPropertySet; + + /** default tab-distance to be used. + */ + [property] long TabStopDistance; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DependentTextField.idl b/offapi/com/sun/star/text/DependentTextField.idl new file mode 100644 index 000000000..325cfaaf7 --- /dev/null +++ b/offapi/com/sun/star/text/DependentTextField.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DependentTextField_idl__ +#define __com_sun_star_text_DependentTextField_idl__ + +#include <com/sun/star/text/TextField.idl> + +#include <com/sun/star/text/XDependentTextField.idl> + + + + module com { module sun { module star { module text { + +/** is a TextField which is not specified by itself, + but dependent on a TextFieldMaster.@see TextFieldMaster + */ +published service DependentTextField +{ + service com::sun::star::text::TextField; + + /** This interface makes it possible to attach a + TextFieldMaster to this TextField. + */ + interface com::sun::star::text::XDependentTextField; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndex.idl b/offapi/com/sun/star/text/DocumentIndex.idl new file mode 100644 index 000000000..0d3a0bd8f --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndex.idl @@ -0,0 +1,89 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_DocumentIndex_idl__ +#define __com_sun_star_text_DocumentIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> +#include <com/sun/star/text/XDocumentIndexMark.idl> + + +module com { module sun { module star { module text { + + +/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex + */ +published service DocumentIndex +{ + service com::sun::star::text::BaseIndex; + + /** determines if alphabetical separators are generated. + */ + [optional, property] boolean UseAlphabeticalSeparators; + + /** determines if an index entry is generated for each primary/secondary key. + */ + [optional, property] boolean UseKeyAsEntry; + + /** determines if same entries on different pages are combined into one index entry. + */ + [optional, property] boolean UseCombinedEntries; + + /** determines if the similarity of index entries is checked case sensitively. + */ + [optional, property] boolean IsCaseSensitive; + + /** determines if following page numbers are displayed using a "pp.". + */ + [optional, property] boolean UsePP; + + /** determines if following page numbers are displayed using a dash. + */ + [optional, property] boolean UseDash; + + /** determines if all entries start with a capital letter. + */ + [optional, property] boolean UseUpperCase; + + /** determines the name of the character style that is applied to the number + of a page where main index entry is located. + */ + [optional, property] string MainEntryCharacterStyleName; + + /** + contains all index marks that are related to this index. + */ + [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks; + + /** contains the locale of the index. + */ + [property] com::sun::star::lang::Locale Locale; + + /** contains the name of the sort algorithm that is used to sort the entries. + */ + [property] string SortAlgorithm; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl new file mode 100644 index 000000000..50d68d8d6 --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl @@ -0,0 +1,140 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentIndexLevelFormat_idl__ +#define __com_sun_star_text_DocumentIndexLevelFormat_idl__ + +#include <com/sun/star/container/XIndexReplace.idl> + + + + module com { module sun { module star { module text { + +/** This service provides access to the structure of the levels of document indexes. + + + <p> + The element type is Sequence< PropertyValues >. Each element in this sequence represents + a member of an index line. The following properties are part of such an element. + </p> + <ul> + <li> + <p>TokenType</p> + <p>Values:</p> + <ul> + <li> + <p>TokenEntryNumber - chapter number, used in content indexes + only</p> + </li> + <li> + <p>TokenEntryText - text of the entry + </p> + </li> + <li> + <p>TokenTabStop - tab stop + </p> + </li> + <li> + <p>TokenText - user defined text + </p> + </li> + <li> + <p>TokenPageNumber - page number + </p> + </li> + <li> + <p>TokenChapterInfo - chapter info, in illustration indexes, + table indexes, user indexes, table of objects and alphabetical indexes + only</p> + </li> + <li> + <p>TokenHyperlinkStart - start of a hyperlink</p> + </li> + <li> + <p>TokenHyperlinkEnd - end of a hyperlink</p> + </li> + <li> + <p>TokenBibliographyDataField - bibliographic data field + </p> + </li> + </ul> + </li> + <li> + <p>CharacterStyleName</p> + <p>Name of the character style applied to the element. Invalid in tab stops.</p> + </li> + <li> + <p>TabStopRightAligned</p> + <p>Tab stop is right aligned. Only valid for tab stops.</p> + </li> + <li> + <p>TabStopPosition</p> + <p>Position of the tab stop. Only valid for tab stops.</p> + </li> + <li> + <p>TabStopFillCharacter</p> + <p>Fill character in tab stops. Only valid for tab stops.</p> + </li> + <li> + <p>WithTab</p> + <p>If true insert tab character.</p> + </li> + <li> + <p>Text</p> + <p>Text. Only valid in user defined text.</p> + </li> + <li> + <p>ChapterFormat</p> + <p>Valid in chapter info and entry number only. See ChapterFormat.</p> + <p>Other information.</p> + <ul> + <li> + <p>In chapter info only com.sun.star.text.ChapterFormat.NUMBER, com.sun.star.text.ChapterFormat.NAME, and + com.sun.star.text.ChapterFormat.NAME_NUMBER constants are allowed.</p> + </li> + <li> + <p>In entry number only com.sun.star.text.ChapterFormat.NUMBER and com.sun.star.text.ChapterFormat.DIGIT constants are allowed.</p> + </li> + </ul> + </li> + <li> + <p>ChapterLevel</p> + <p>Valid in chapter info and entry number only. Denotes the level up to which + the chapter information is given. Values permitted 1 to 10 inclusive.</p> + </li> + </ul> + */ +published service DocumentIndexLevelFormat +{ + interface com::sun::star::container::XIndexReplace; + + +}; + + +}; }; }; }; + +#endif + + + + + + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndexMark.idl b/offapi/com/sun/star/text/DocumentIndexMark.idl new file mode 100644 index 000000000..a62c9f33d --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexMark.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentIndexMark_idl__ +#define __com_sun_star_text_DocumentIndexMark_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/BaseIndexMark.idl> + + + + module com { module sun { module star { module text { + + +/** is a TextRange which is explicitly marked + as an index entry for a DocumentIndex. + */ +published service DocumentIndexMark +{ + service com::sun::star::text::TextContent; + + service com::sun::star::text::BaseIndexMark; + + /** contains the primary key of the index entry. + It is used to build a hierarchical document index. + */ + [property] string PrimaryKey; + /** contains the secondary key of the index entry. + It is used to build a hierarchical document index. + */ + [property] string SecondaryKey; + /** determines if this entry is a main entry. In a document index this entry will + be emphasized by assigning a character style to it. + */ + [property] boolean IsMainEntry; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl new file mode 100644 index 000000000..d8d89a0ea --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentIndexMarkAsian_idl__ +#define __com_sun_star_text_DocumentIndexMarkAsian_idl__ + + + + + module com { module sun { module star { module text { + + +/** is a TextRange which is explicitly marked + as an index entry for a DocumentIndex. + For Asian languages the user can provide an additional string + which is used for sorting. If the user does not provide these + strings, they are not considered for sorting. + + @since OOo 1.1.2 + */ +published service DocumentIndexMarkAsian +{ + /** contains the reading of the string which has been chosen for the + index entry. + */ + [property] string TextReading; + /** contains the reading of the primary key of the index entry. + It is used to build a hierarchical document index. + */ + [property] string PrimaryKeyReading; + /** contains the reading the secondary key of the index entry. + It is used to build a hierarchical document index. + */ + [property] string SecondaryKeyReading; +}; + + +}; }; }; }; +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndexParagraphStyles.idl b/offapi/com/sun/star/text/DocumentIndexParagraphStyles.idl new file mode 100644 index 000000000..46e44ea25 --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexParagraphStyles.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentIndexParagraphStyles_idl__ +#define __com_sun_star_text_DocumentIndexParagraphStyles_idl__ + +#include <com/sun/star/container/XIndexReplace.idl> + + + module com { module sun { module star { module text { + +/** provides access to the names of paragraph styles that are included + in content indexes of user defined indexes. The element type is sequence of string. + */ +published service DocumentIndexParagraphStyles +{ + interface com::sun::star::container::XIndexReplace; + +}; + + +}; }; }; }; + +#endif + + + + + + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentIndexes.idl b/offapi/com/sun/star/text/DocumentIndexes.idl new file mode 100644 index 000000000..09c51eb7a --- /dev/null +++ b/offapi/com/sun/star/text/DocumentIndexes.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentIndexes_idl__ +#define __com_sun_star_text_DocumentIndexes_idl__ + +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + + +/** provides access to all indexes in a document. + */ +published service DocumentIndexes +{ + /** This interface makes it possible to access all BaseIndex + instances within this context (e.g., a document) by its name. + + <p>The type of the interfaces returned by this collection is + always XDocumentIndex. + */ + interface com::sun::star::container::XNameAccess; + + /** This interface makes it possible to access all BaseIndex + instances within this context (e.g., a document) by its index. + + <p>The type of the interfaces returned by this collection is + always XDocumentIndex. + */ + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentSettings.idl b/offapi/com/sun/star/text/DocumentSettings.idl new file mode 100644 index 000000000..00e82c4d8 --- /dev/null +++ b/offapi/com/sun/star/text/DocumentSettings.idl @@ -0,0 +1,182 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentSettings_idl__ +#define __com_sun_star_text_DocumentSettings_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/document/Settings.idl> +#include <com/sun/star/text/PrintSettings.idl> + + +module com { module sun { module star { module text { + + +/** describes properties that apply to the whole text document. + */ +published service DocumentSettings +{ + service com::sun::star::document::Settings; + + [optional] service com::sun::star::text::PrintSettings; + + /** gives access to the properties implemented by this service. + */ + interface com::sun::star::beans::XPropertySet; + + + /** specifies if charts in text documents are updated automatically. + + This has no effect if "FieldAutoUpdate" is `FALSE`. + */ + [optional, property] boolean ChartAutoUpdate; + + /** specifies if spacing between paragraphs and tables is to be + added. + + <p>If between two paragraphs, two tables, or a paragraph and a + table, you have defined spacing above and below each object, + usually only the larger one of the two spaces is used. If the + spacing between the objects are to be added this property has + to be `TRUE`.</p> + */ + [optional, property] boolean AddParaTableSpacing; + + /** specifies if top paragraph spacing is applied to paragraphs + on the first page of text documents. + + <p>If `TRUE`, the paragraph or table spacing to the top will + also be effective at the beginning of a page or column if the + paragraph or table is positioned on the first page of the + document. The same applies for a page break.</p> + */ + [optional, property] boolean AddParaTableSpacingAtStart; + + /** specifies the alignment of tab stops in text documents. + + <p>If `TRUE` centered and right-aligned paragraphs containing + tabs are formatted as a whole in the center or aligned to the + right. If `FALSE`, only the text to the right of the last + tab, for example, is aligned to the right, while the text to + the left remains where it is.</p> + */ + [optional, property] boolean AlignTabStopPosition; + + /** specifies if the contents of links in the global document + are saved or not. + + <p>This property applies only for master documents.</p> + + <p><em>Note</em>: This name is a bit misleading, it should be + something like <code>SaveLinkedDocumentContent</code>.</p> + */ + [optional, property] boolean SaveGlobalDocumentLinks; + /** specifies if the document has been created as a label document. + + <p>This property indicates that the document contains multiple text frames + and that the content of one frame is duplicated into the other frames + by internally linked text sections.</p> + + */ + [optional, property] boolean IsLabelDocument; + /** specifies if the former (till OpenOffice.org 1.1) or the new + line spacing formatting is applied. + + <p>This property controls how a set line spacing at a paragraph + influences the formatting of the text lines and the spacing between + paragraphs. + If `TRUE`, the formatting till OpenOffice.org 1.1 is + applied. This means, that a proportional line spacing is applied + above and below a text line and that the maximum of the line spacing + value between two paragraphs is added respectively reckoned up with the + paragraph spacing (adding or reckoning up is controlled by document + option AddParaTableSpacing). + If `FALSE` (default for documents since OpenOffice.org 2.0), + a proportional line spacing is only applied below a text line and + it's always added to the paragraph spacing between two paragraphs.</p> + + @since OOo 2.0 + */ + [optional, property] boolean UseFormerLineSpacing; + /** specifies if paragraph and table spacing is added at the + bottom of table cells + + <p>This property controls, if the spacing of the last paragraph + respectively table of a table cell is added at the bottom of this + table cells + If `TRUE` (default for documents since OpenOffice.org 2.0), + the spacing of the last paragraph respectively table of a table + cell is added at the bottom of this table cell. + If `FALSE` (typically for documents till OpenOffice.org 1.1), + the spacing of the last paragraph respectively table of a table + cell isn't added at the bottom of this table cell.</p> + + @since OOo 2.0 + */ + [optional, property] boolean AddParaSpacingToTableCells; + /** specifies if the former (till OpenOffice.org 1.1) or the new + object positioning is applied. + + <p>This property controls how floating screen objects (Writer + fly frames and drawing objects are positioned. + If `TRUE`, the object positioning till OpenOffice.org 1.1 is + applied. This means, that the top of a paragraph, at which a + floating screen object orients its vertical position, includes + the lower spacing and the line spacing of the previous paragraph. + If `FALSE` (default for documents since OpenOffice.org 2.0), + the top of a paragraph, at which a floating screen object orients + its vertical position, doesn't include the lower spacing and the + line spacing of the previous paragraph.</p> + + @since OOo 2.0 + */ + [optional, property] boolean UseFormerObjectPositioning; + + /** specifies if the text wrap of floating screen objects are + considered in a specified way in the positioning algorithm. + + <p>This property controls how floating screen objects (Writer + fly frames and drawing objects) are positioned. + If `TRUE`, the object positioning algorithm will consider + the text wrap style, set at the floating screen object. + The attribute BaseFrameProperties::WrapInfluenceOnPosition + specifies how the text wrap is considered. + If `FALSE` (default value), the former object positioning + algorithm (known from OpenOffice.org 1.1) is applied.</p> + + @since OOo 2.0 + */ + [optional, property] boolean ConsiderTextWrapOnObjPos; + + /** specifies if Math objects should automatically vertically aligned to + match the baseline of the surrounding text. + + <p>If activated formula object that are anchored 'As Character' will be + vertically aligned to have their baseline match with the one from the text.</p> + + @since OOo 3.4 + */ + [optional, property] boolean MathBaselineAlignment; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/DocumentStatistic.idl b/offapi/com/sun/star/text/DocumentStatistic.idl new file mode 100644 index 000000000..8ab15a628 --- /dev/null +++ b/offapi/com/sun/star/text/DocumentStatistic.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_DocumentStatistic_idl__ +#define __com_sun_star_text_DocumentStatistic_idl__ + + + + module com { module sun { module star { module text { + +/** These constants are used to specify the type of a document statistic + field. + */ +published constants DocumentStatistic +{ + // The text field displays the number of pages of the document. + const short PAGES = 0; + + // The text field displays the number of paragraphs of the document. + const short PARAS = 1; + + // The text field words the number of paragraphs of the document. + const short WORDS = 2; + + // The text field characters the number of paragraphs of the document. + const short CHARS = 3; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Endnote.idl b/offapi/com/sun/star/text/Endnote.idl new file mode 100644 index 000000000..276c7cef2 --- /dev/null +++ b/offapi/com/sun/star/text/Endnote.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Endnote_idl__ +#define __com_sun_star_text_Endnote_idl__ + +#include <com/sun/star/text/Footnote.idl> + + + +module com { module sun { module star { module text { + +/** This service specifies an endnote in a + TextDocument. +*/ +published service Endnote +{ + service Footnote; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/EndnoteSettings.idl b/offapi/com/sun/star/text/EndnoteSettings.idl new file mode 100644 index 000000000..e653d1227 --- /dev/null +++ b/offapi/com/sun/star/text/EndnoteSettings.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_EndnoteSettings_idl__ +#define __com_sun_star_text_EndnoteSettings_idl__ + +#include <com/sun/star/text/FootnoteSettings.idl> + + + module com { module sun { module star { module text { + + +/** provides access to the settings of footnotes or endnotes in a + (text) document. + */ +published service EndnoteSettings +{ + service FootnoteSettings; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/FilenameDisplayFormat.idl b/offapi/com/sun/star/text/FilenameDisplayFormat.idl new file mode 100644 index 000000000..72b0041d5 --- /dev/null +++ b/offapi/com/sun/star/text/FilenameDisplayFormat.idl @@ -0,0 +1,54 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_FilenameDisplayFormat_idl__ +#define __com_sun_star_text_FilenameDisplayFormat_idl__ + + + + module com { module sun { module star { module text { + +/** These constants are used to specify which parts of a URL are displayed + in a field. + */ +published constants FilenameDisplayFormat +{ + /** The content of the URL is completely displayed. + */ + const short FULL = 0; + + /** Only the path of the file is displayed. + */ + const short PATH = 1; + + /** Only the name of the file without the file extension is displayed. + */ + const short NAME = 2; + + /** The file name including the file extension is displayed. + */ + const short NAME_AND_EXT = 3; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/FontEmphasis.idl b/offapi/com/sun/star/text/FontEmphasis.idl new file mode 100644 index 000000000..6c4da6cd1 --- /dev/null +++ b/offapi/com/sun/star/text/FontEmphasis.idl @@ -0,0 +1,66 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_FontEmphasis_idl__ +#define __com_sun_star_text_FontEmphasis_idl__ + + + + module com { module sun { module star { module text { + +/** Determines the type and position of an emphasis mark in Asian texts. + */ +published constants FontEmphasis +{ + /** no emphasis mark is used. + */ + const short NONE = 0; + + /** a dot is set above (or right from vertical text) the text. + */ + const short DOT_ABOVE = 1; + + /** a circle is set above (or right from vertical text) the text. + */ + const short CIRCLE_ABOVE = 2; + /** a disc is set above (or right from vertical text) the text. + */ + const short DISK_ABOVE = 3; + /** an accent is set above (or right from vertical text) the text. + */ + const short ACCENT_ABOVE = 4; + /** a dot is set below (or left from vertical text) the text. + */ + const short DOT_BELOW = 11; + /** a circle is set below (or left from vertical text) the text. + */ + const short CIRCLE_BELOW = 12; + /** a disk is set below (or left from vertical text) the text. + */ + const short DISK_BELOW = 13; + /** an accent is set below (or left from vertical text) the text. + */ + const short ACCENT_BELOW = 14; + +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/FontRelief.idl b/offapi/com/sun/star/text/FontRelief.idl new file mode 100644 index 000000000..59a42ee1a --- /dev/null +++ b/offapi/com/sun/star/text/FontRelief.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_FontRelief_idl__ +#define __com_sun_star_text_FontRelief_idl__ + + + + module com { module sun { module star { module text { + +/** Determines the relief type of a font. + */ +published constants FontRelief +{ + /** no relief is used. + */ + const short NONE = 0; + + /** the font relief is embossed. + */ + const short EMBOSSED = 1; + + /** the font relief is engraved. + */ + const short ENGRAVED = 2; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Footnote.idl b/offapi/com/sun/star/text/Footnote.idl new file mode 100644 index 000000000..611e94713 --- /dev/null +++ b/offapi/com/sun/star/text/Footnote.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Footnote_idl__ +#define __com_sun_star_text_Footnote_idl__ + +#include <com/sun/star/text/XFootnote.idl> +#include <com/sun/star/text/XText.idl> + + + +module com { module sun { module star { module text { + +/** This service specifies a footnote or an endnote in a + TextDocument. +*/ +published service Footnote +{ + + /** provides access to the footnote label, which is the + anchor text range. + + */ + interface com::sun::star::text::XFootnote; + + /** provides access to the text of the footnote (or + endnote). + + */ + interface com::sun::star::text::XText; + /** contains an internal identifier for the use as SequenceNumber property in reference fields. + @see com::sun::star::text::textfield::GetReference. + */ + [optional, readonly, property]short ReferenceId; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/FootnoteNumbering.idl b/offapi/com/sun/star/text/FootnoteNumbering.idl new file mode 100644 index 000000000..36a933afb --- /dev/null +++ b/offapi/com/sun/star/text/FootnoteNumbering.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_FootnoteNumbering_idl__ +#define __com_sun_star_text_FootnoteNumbering_idl__ + + + + module com { module sun { module star { module text { + +/** These constants are used to specify the footnote numbering. + */ +published constants FootnoteNumbering +{ + /** The counter of the automatic footnote numbering restarts each page. + */ + const short PER_PAGE = 0; + + /** The counter of the automatic footnote numbering restarts each + chapter. + */ + const short PER_CHAPTER = 1; + + /** The counter of the automatic footnote numbering does not restart. + */ + const short PER_DOCUMENT = 2; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/FootnoteSettings.idl b/offapi/com/sun/star/text/FootnoteSettings.idl new file mode 100644 index 000000000..6a7c03ad0 --- /dev/null +++ b/offapi/com/sun/star/text/FootnoteSettings.idl @@ -0,0 +1,118 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_FootnoteSettings_idl__ +#define __com_sun_star_text_FootnoteSettings_idl__ + + + + module com { module sun { module star { module text { + + +/** provides access to the settings of footnotes or endnotes in a + (text) document. + */ +published service FootnoteSettings +{ + + /** contains the name of the character style that is used + for the label in front of the footnote/endnote text. + */ + [property] string CharStyleName; + + + /** contains the numbering type for the numbering of the + footnotes/endnotes. + */ + [property] short NumberingType; + + + /** contains the page style that is used for the page that + contains the footnote/endnote texts + */ + [property] string PageStyleName; + + + /** contains the paragraph style that is used for the + footnote/endnote text. + */ + [property] string ParaStyleName; + + + /** contains the prefix for the footnote/endnote symbol. + */ + [property] string Prefix; + + + /** contains the first number of the automatic numbering + of footnotes/endnotes. + */ + [property] short StartAt; + + + /** contains the suffix for the footnote/endnote symbol. + */ + [property] string Suffix; + + + /** contains the string at the restart of the footnote + text after a break. + + <p>For footnotes only.</p> + */ + [optional, property] string BeginNotice; + + + /** contains the string at the end of a footnote part in + front of a break. + + <p>For footnotes only.</p> + */ + [optional, property] string EndNotice; + + + /** contains the type of the counting of the footnote numbers. + + <p>For footnotes only.</p> + @see FootnoteNumbering + */ + [optional, property] short FootnoteCounting; + + + /** If `TRUE`, the footnote text is shown at the end of the document. + + <p>For footnotes only.</p> + */ + [optional, property] boolean PositionEndOfDoc; + + + /** contains the name of the character style that is used + for footnote/endnote anchor in the text. + + @since OOo 2.0 + */ + [optional, property] string AnchorCharStyleName; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Footnotes.idl b/offapi/com/sun/star/text/Footnotes.idl new file mode 100644 index 000000000..f17540f52 --- /dev/null +++ b/offapi/com/sun/star/text/Footnotes.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Footnotes_idl__ +#define __com_sun_star_text_Footnotes_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the footnotes or endnotes of a (text) + document. + */ +published service Footnotes +{ + + /** provides access to the footnotes of the document. + */ + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/GenericTextDocument.idl b/offapi/com/sun/star/text/GenericTextDocument.idl new file mode 100644 index 000000000..f242f9979 --- /dev/null +++ b/offapi/com/sun/star/text/GenericTextDocument.idl @@ -0,0 +1,195 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_GenericTextDocument_idl__ +#define __com_sun_star_text_GenericTextDocument_idl__ + +#include <com/sun/star/document/OfficeDocument.idl> +#include <com/sun/star/text/XTextDocument.idl> +#include <com/sun/star/util/XSearchable.idl> +#include <com/sun/star/util/XRefreshable.idl> +#include <com/sun/star/tiledrendering/XTiledRenderable.idl> +#include <com/sun/star/text/XFootnotesSupplier.idl> +#include <com/sun/star/text/XEndnotesSupplier.idl> +#include <com/sun/star/util/XReplaceable.idl> +#include <com/sun/star/text/XPagePrintable.idl> +#include <com/sun/star/text/XReferenceMarksSupplier.idl> +#include <com/sun/star/text/XChapterNumberingSupplier.idl> +#include <com/sun/star/text/XTextGraphicObjectsSupplier.idl> +#include <com/sun/star/text/XTextEmbeddedObjectsSupplier.idl> +#include <com/sun/star/text/XTextTablesSupplier.idl> +#include <com/sun/star/style/XStyleFamiliesSupplier.idl> +#include <com/sun/star/util/XNumberFormatsSupplier.idl> +#include <com/sun/star/text/XBookmarksSupplier.idl> +#include <com/sun/star/text/XDocumentIndexesSupplier.idl> +#include <com/sun/star/text/XTextFieldsSupplier.idl> +#include <com/sun/star/text/XTextFramesSupplier.idl> +#include <com/sun/star/text/XTextSectionsSupplier.idl> +#include <com/sun/star/lang/XMultiServiceFactory.idl> +#include <com/sun/star/lang/Locale.idl> + + + module com { module sun { module star { module text { + + +/** A text document is a model component which contains text + structured by paragraphs. + + <p>Each paragraph and each portion of text can be fitted with + some attributes (technically properties).</p> + + <p>It's declared as generic text document, because its function is + needed by different derived services (TextDocument/WebDocument/GlobalDocument).</p> + + <p>In addition, all text objects can be searched.</p> + */ +published service GenericTextDocument +{ + service com::sun::star::document::OfficeDocument; + + /** provides methods to create instances of several text document + services. + A text document provides several services which need the context + of a text document and these text document dependent services are + created at the text document directly and not over the global service + manager. + */ + interface com::sun::star::lang::XMultiServiceFactory; + + interface com::sun::star::text::XTextDocument; + + interface com::sun::star::util::XSearchable; + + interface com::sun::star::util::XRefreshable; + + /** @since LibreOffice 5.0 */ + [optional] interface com::sun::star::tiledrendering::XTiledRenderable; + + [optional] interface com::sun::star::text::XFootnotesSupplier; + + [optional] interface com::sun::star::text::XEndnotesSupplier; + + [optional] interface com::sun::star::util::XReplaceable; + + [optional] interface com::sun::star::text::XPagePrintable; + + [optional] interface com::sun::star::text::XReferenceMarksSupplier; + + [optional] interface com::sun::star::text::XChapterNumberingSupplier; + + [optional] interface com::sun::star::beans::XPropertySet; + + [optional] interface com::sun::star::text::XTextGraphicObjectsSupplier; + + [optional] interface com::sun::star::text::XTextEmbeddedObjectsSupplier; + + [optional] interface com::sun::star::text::XTextTablesSupplier; + + [optional] interface com::sun::star::style::XStyleFamiliesSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::text::XBookmarksSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::text::XDocumentIndexesSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::text::XTextFieldsSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::text::XTextFramesSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::text::XTextSectionsSupplier; + + /** @since OOo 1.1.2 + */ + [optional] interface com::sun::star::util::XNumberFormatsSupplier; + + /** contains the identifier of the default locale of the document. + */ + [optional, property] com::sun::star::lang::Locale CharLocale; + + + /** contains the count of all characters in the document. + */ + [optional, readonly, property] long CharacterCount; + + + + /** contains the count of all paragraphs in the document. + */ + [optional, readonly, property] long ParagraphCount; + + + /** contains the count of all words in the document.@see WordSeparator + */ + [optional, readonly, property] long WordCount; + + + /** contains a string that consists of characters that mark the + separation of words in counting the words in a document. + + + + <p> I.e. slash and backslash. Whitespace (tab stop, + space, paragraph break, line break) always separate + words.</p>@see WordCount + */ + [optional, property] string WordSeparator; + + /** specifies the concordance file taken into account when + * creating an index. + * + * When no concordance file should be used the string is empty. + * Used for text documents only. + * + * @since OOo 1.1.2 + */ + [optional, property] string IndexAutoMarkFileURL; + + /** specifies if change recording is active. + * + * @since OOo 1.1.2 + */ + [optional, property] boolean RecordChanges; + + /** specifies the first 4 digit year to be used when years + * are given in 2 digits. + * + * Example: if set to 1930 + * Oct-12-29 will be interpreted as Oct-12-2029 + * Oct-12-30 will be interpreted as Oct-12-1930 + * Oct-12-02 will be interpreted as Oct-12-2002 + * + * @since OOo 1.1.2 + */ + [optional, property] short TwoDigitYear; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/GlobalDocument.idl b/offapi/com/sun/star/text/GlobalDocument.idl new file mode 100644 index 000000000..3befc5ec6 --- /dev/null +++ b/offapi/com/sun/star/text/GlobalDocument.idl @@ -0,0 +1,43 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_GlobalDocument_idl__ +#define __com_sun_star_text_GlobalDocument_idl__ + +#include <com/sun/star/text/GenericTextDocument.idl> + + + module com { module sun { module star { module text { + + +/** Specify the document service of the global text module. + + @deprecated + */ +service GlobalDocument +{ + /** Provides the functionality of such global document. */ + service GenericTextDocument; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/GlobalSettings.idl b/offapi/com/sun/star/text/GlobalSettings.idl new file mode 100644 index 000000000..f5613b3a0 --- /dev/null +++ b/offapi/com/sun/star/text/GlobalSettings.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_GlobalSettings_idl__ +#define __com_sun_star_text_GlobalSettings_idl__ + +#include <com/sun/star/view/XPrintSettingsSupplier.idl> +#include <com/sun/star/view/XViewSettingsSupplier.idl> + + + + + module com { module sun { module star { module text { + + +/** specifies a service that provides access to the settings of a text module. + */ +published service GlobalSettings +{ + /** This interface specifies the access to the print settings. + */ + interface com::sun::star::view::XPrintSettingsSupplier; + /** This interface specifies the access to the view settings. + */ + interface com::sun::star::view::XViewSettingsSupplier; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/GraphicCrop.idl b/offapi/com/sun/star/text/GraphicCrop.idl new file mode 100644 index 000000000..efd7cce55 --- /dev/null +++ b/offapi/com/sun/star/text/GraphicCrop.idl @@ -0,0 +1,67 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_GraphicCrop_idl__ +#define __com_sun_star_text_GraphicCrop_idl__ + + + + module com { module sun { module star { module text { + +/** describes the cropping of graphic objects. + Cropping means to show only parts of the object. + + + + <p>Negative values cut the visible area; positive values + extend the visible area by filling it with background color. + The absolute sum of top and bottom crop must be smaller + than the objects original height. The absolute sum of the left and + right crop must be smaller than the object's original width. + + </p> + <p>If this property is applied to a graphic object, then this object + will correct these values if necessary. + </p> + */ +published struct GraphicCrop +{ + /** contains the top value to cut (if negative) or to extend (if positive) + */ + long Top; + + /** contains the bottom value to cut (if negative) or to extend (if positive) + */ + long Bottom; + + /** contains the left value to cut (if negative) or to extend (if positive) + */ + long Left; + + /** contains the right value to cut (if negative) or to extend (if positive) + */ + long Right; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/HoriOrientation.idl b/offapi/com/sun/star/text/HoriOrientation.idl new file mode 100644 index 000000000..66c8b2211 --- /dev/null +++ b/offapi/com/sun/star/text/HoriOrientation.idl @@ -0,0 +1,77 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_HoriOrientation_idl__ +#define __com_sun_star_text_HoriOrientation_idl__ + + + + module com { module sun { module star { module text { + +/** These enumeration values specify the horizontal orientation. + */ +published constants HoriOrientation +{ + /** no hard alignment is applied. + + <p>For text tables this means that the tables position is + defined by the left and right margins. + + <p>For frame objects (text frames, graphics,...) this means + that the position is defined by a left offset. + */ + const short NONE = 0; + + /** The object is aligned at the right side. + */ + const short RIGHT = 1; + + /** The object is aligned at the middle. + */ + const short CENTER = 2; + + /** The object is aligned at the left side. + */ + const short LEFT = 3; + + /** TODO + */ + const short INSIDE = 4; + + /** TODO + */ + const short OUTSIDE = 5; + + /** The object uses the full space (for text tables only). + */ + const short FULL = 6; + + /** The left offset and the width of the object are defined. + <p> For text tables this means that the tables position is + defined by the left margin and the width. + */ + const short LEFT_AND_WIDTH = 7; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/HoriOrientationFormat.idl b/offapi/com/sun/star/text/HoriOrientationFormat.idl new file mode 100644 index 000000000..f6d345a17 --- /dev/null +++ b/offapi/com/sun/star/text/HoriOrientationFormat.idl @@ -0,0 +1,66 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_HoriOrientationFormat_idl__ +#define __com_sun_star_text_HoriOrientationFormat_idl__ + + + + module com { module sun { module star { module text { + +/** describes the horizontal orientation of an object. + + + + <p>If <code>HorizontalOrientation == HORI_NONE</code>, then the value + "XPos" describes the distance from the left border of the context. + Otherwise "XPos" is ignored. + + </p> + <p>The following flags are used to adapt the position of the object + to odd and even pages. If "PositionToggle" is set, then the + horizontal position is mirrored.</p> + */ +published struct HoriOrientationFormat +{ + /** contains the distance from the left border. Only valid if + the property HorizontalOrientation contains the value HORI_NONE. + */ + long XPos; + + /** determines the horizontal alignment of an object. + The values refer to com::sun::star::HoriOrientation. + */ + short HorizontalOrientation; + + /** determines the reference position of the horizontal alignment.@see com::sun::star::text::RelOrientation + */ + short HorizontalRelation; + + /** determines if the orientation toggles between left and right pages. + */ + boolean PositionToggle; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/HorizontalAdjust.idl b/offapi/com/sun/star/text/HorizontalAdjust.idl new file mode 100644 index 000000000..16867a283 --- /dev/null +++ b/offapi/com/sun/star/text/HorizontalAdjust.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_HorizontalAdjust_idl__ +#define __com_sun_star_text_HorizontalAdjust_idl__ + + + + module com { module sun { module star { module text { + +/** enumeration values define the horizontal adjustments of objects. + */ +published enum HorizontalAdjust +{ + /** the object is left adjusted. + */ + LEFT, + + /** the object is adjusted to the center. + */ + CENTER, + + /** the object is right adjusted. + */ + RIGHT + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/IllustrationsIndex.idl b/offapi/com/sun/star/text/IllustrationsIndex.idl new file mode 100644 index 000000000..4b8f6ac7f --- /dev/null +++ b/offapi/com/sun/star/text/IllustrationsIndex.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_IllustrationsIndex_idl__ +#define __com_sun_star_text_IllustrationsIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + +module com { module sun { module star { module text { + +/** specifies service of illustration indexes within a document. + @see com::sun::star::text::BaseIndex +*/ +published service IllustrationsIndex +{ + service com::sun::star::text::BaseIndex; + + /* determines if the name or the label of an object is used to create the index. + */ + [optional, property] boolean CreateFromLabels; //tables, illustrations + /* determines the name of the sequence field that is evaluated to create the index. + */ + [optional, property] string LabelCategory; //tables, illustrations + /* determines the way the paragraph containing a label is included in the index. + @see ChapterFormat*/ + [optional, property] short LabelDisplayType;//tables, illustrations +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/InContentMetadata.idl b/offapi/com/sun/star/text/InContentMetadata.idl new file mode 100644 index 000000000..4d8c0c1b3 --- /dev/null +++ b/offapi/com/sun/star/text/InContentMetadata.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_InContentMetadata_idl__ +#define __com_sun_star_text_InContentMetadata_idl__ + +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/container/XChild.idl> +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/rdf/XMetadatable.idl> + + + +module com { module sun { module star { module text { + + +/** is a TextContent that can be used to attach RDF metadata + to a range of text. + + @since OOo 3.2 + */ +service InContentMetadata +{ + /** None of the properties of TextContent are + supported. */ + service com::sun::star::text::TextContent; + + /** The InContentMetadata can have RDF metadata attached. */ + interface com::sun::star::rdf::XMetadatable; + + /** The TextContents that are contained in the + annotated range of text can be enumerated. */ + interface com::sun::star::container::XEnumerationAccess; + + /** The TextContent that is the parent of this text range. + @since OOo 3.3 + */ + interface com::sun::star::container::XChild; + +}; + + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/InvalidTextContentException.idl b/offapi/com/sun/star/text/InvalidTextContentException.idl new file mode 100644 index 000000000..c15e2b892 --- /dev/null +++ b/offapi/com/sun/star/text/InvalidTextContentException.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_InvalidTextContentException_idl__ +#define __com_sun_star_text_InvalidTextContentException_idl__ + +#include <com/sun/star/uno/Exception.idl> + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** is thrown whenever a method gets a TextContent + as an actual argument when the text content cannot be used for that + operation. + */ +published exception InvalidTextContentException: com::sun::star::uno::Exception +{ + /** contains the interface of the text content that caused the exception. + */ + com::sun::star::text::XTextContent TextContent; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/LabelFollow.idl b/offapi/com/sun/star/text/LabelFollow.idl new file mode 100644 index 000000000..24c944cbc --- /dev/null +++ b/offapi/com/sun/star/text/LabelFollow.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_LabelFollow_idl__ +#define __com_sun_star_text_LabelFollow_idl__ + + + + module com { module sun { module star { module text { + + +/** These enumeration values specify character following the list label + + @since OOo 3.0 + */ +published constants LabelFollow +{ + + /** list tab stop + */ + const short LISTTAB = 0; + + + /** space + */ + const short SPACE = 1; + + + /** nothing + */ + const short NOTHING = 2; + + /** new line + */ + const short NEWLINE = 3; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/LineNumberingProperties.idl b/offapi/com/sun/star/text/LineNumberingProperties.idl new file mode 100644 index 000000000..fe15d0c7c --- /dev/null +++ b/offapi/com/sun/star/text/LineNumberingProperties.idl @@ -0,0 +1,92 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_LineNumberingProperties_idl__ +#define __com_sun_star_text_LineNumberingProperties_idl__ + +#include <com/sun/star/text/XLineNumberingProperties.idl> + + + module com { module sun { module star { module text { + +/** provides access to the settings of the line numbering. + */ +published service LineNumberingProperties +{ + + /** If `TRUE`, line numbering is used. + */ + [property] boolean IsOn; + + + /** The name of the character style that is used for the line number. + */ + [property] string CharStyleName; + + + /** If `TRUE`, empty lines are counted. + */ + [property] boolean CountEmptyLines; + + /** If `TRUE`, lines in frames are included in counting. + */ + [property] boolean CountLinesInFrames; + + /** specifies the distance between the line number and the start or + end of the text area. + */ + [property] long Distance; + + /** Line numbers are shown on every <var>Interval</var>th line. + */ + [property] short Interval; + + /** specifies the string that is used for the line separator. + */ + [property] string SeparatorText; + + /** The line separator is shown every <var>SeparatorInterval</var>th line. + */ + [property] short SeparatorInterval; + + /** specifies the position of the line number (constant LineNumberPositions + left/right/inside/outside). + */ + [property] short NumberPosition; + + /** specifies the type of the numbering. + */ + [property] short NumberingType; + + /** specifies if the line numbering should start from the + beginning at each page. + + <p>If set to `FALSE` the line numbering will be continuous.</p> + + @since OOo 2.0 + */ + [optional, property] boolean RestartAtEachPage; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/MailMerge.idl b/offapi/com/sun/star/text/MailMerge.idl new file mode 100644 index 000000000..e7691c4b7 --- /dev/null +++ b/offapi/com/sun/star/text/MailMerge.idl @@ -0,0 +1,364 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_MailMerge_idl__ +#define __com_sun_star_text_MailMerge_idl__ + +#include <com/sun/star/task/XJob.idl> +#include <com/sun/star/sdbc/XResultSet.idl> +#include <com/sun/star/sdbc/XConnection.idl> +#include <com/sun/star/frame/XModel.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/text/XMailMergeBroadcaster.idl> +#include <com/sun/star/sdb/DataAccessDescriptor.idl> +#include <com/sun/star/util/XCancellable.idl> + + + module com { module sun { module star { module text { + + +/** Gives access to mail merge functionality. + + @since OOo 1.1.2 + */ +published service MailMerge +{ + /** interface to execute the mail merge action. + + <p>The com::sun::star::task::XJob::execute() + method of the interface accepts exactly the same properties + as provided by this service in its argument sequence.</p> + + <p>The default values for the properties to be used in the method + call are those given by this service. If a property is also listed + in the argument sequence that value will be used for the call. + The value of the property in this service will remain unchanged + by that.</p> + */ + interface com::sun::star::task::XJob; + + /** interface to cancel the current mail merge job. + + @since LibreOffice 4.3 + */ + [optional] interface com::sun::star::util::XCancellable; + + /** interface to access the services properties. + */ + interface com::sun::star::beans::XPropertySet; + + /** interface to notify mail merge listeners. + */ + [optional] interface com::sun::star::text::XMailMergeBroadcaster; + + + /* database properties */ + + /** allows to specify the data which the mail merge should be based on. + + <p>This service describe the interaction between all data access related properties, + namely #DataSourceName, #Command, #CommandType, + #ActiveConnection, #Selection, #ResultSet, + #Filter and #EscapeProcessing + */ + service com::sun::star::sdb::DataAccessDescriptor; + + /** contains the name of the data source that is to be used for merging. + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] string DataSourceName; + + + /** determines the type of the database command as + described in com::sun::star::sdb::CommandType + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] long CommandType; + + + /** contains the database command. + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] string Command; + + + /** provides access to a + com::sun::star::sdbc::XResultSet of + a com::sun::star::sdbc::ResultSet service. + + <p>Note that any superservices of com::sun::star::sdbc::ResultSet + are also allowed. Especially, this member can denote an instance of the + com::sun::star::sdb::RowSet, or an instance obtained + by calling com::sun::star::sdb::XResultSetAccess::createResultSet() + on such a com::sun::star::sdb::RowSet. This becomes important in + conjunction with the #Selection property.</p> + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] com::sun::star::sdbc::XResultSet ResultSet; + + + /** contains the connection to the database. + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] com::sun::star::sdbc::XConnection ActiveConnection; + + + /** contains a selection that refers to bookmarks of the ResultSet. + + <p>This property is relevant in conjunction with the #ResultSet + only. A single element of this array describes a bookmark relative to the result set.<br/> + Note that this implies that the #ResultSet needs to support the + com::sun::star::sdbcx::XRowLocate interface.</p> + + <p>If this array is empty, the whole result set, as described by #ResultSet + respectively the triple (#DataSourceName, #CommandType, + #Command).</p> + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] sequence< any > Selection; + + + /** returns if escape processing is on or off. + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] boolean EscapeProcessing; + + + /** contains a filter expression for an SQL statement. + + <p>For the interaction of this property with other data access relevant properties, see + the com::sun::star::sdb::DataAccessDescriptor service.</p> + */ + [property] string Filter; + + + /* input properties */ + + + /** contains the URL of a text document that is to be processed. + + <p>If this property is not set an empty document is created.</p> + */ + [property] string DocumentURL; + + + /** provides access to the model of the document to be processed. + + <p>This property will automatically be set to the documents model + if a document URL was set.</p> + */ + [property, readonly] com::sun::star::frame::XModel Model; + + + /* output properties */ + + + /** determines the destination of the mail merge action. + + @see com::sun::star::text::MailMergeType + */ + [property] short OutputType; + + + /** determines whether single print jobs will be generated per output document. + + <p>This property is only evaluated for printer output.</p> + */ + [property] boolean SinglePrintJobs; + + + /** contains the path where generated files are created. + + <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is + generated from the location or title of the source documents.</p> + + <p>This property is only evaluated for file output.</p> + */ + [property] string OutputURL; + + + /** determines whether file names of created files are generated using + the content of a database column. + + <p>This property is only evaluated for file output.</p> + */ + [property] boolean FileNameFromColumn; + + + /** contains the name of the column to generate the output file names. + + <p>If FileNameFromColumn is true the content of the related column + is added to the OutputURL.</p> + <p>If "OutputURL" or "FileNamePrefix" are empty the missing value is + generated from the location or title of the source documents.</p> + + <p>This property is only evaluated for file output.</p> + */ + [property] string FileNamePrefix; + + + /** Contains the password of the outgoing mail server. It is necessary to set this + if the password is not already stored in the configuration for security reasons. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string OutServerPassword; + + /** Contains the password of the incoming mail server. It is necessary to set this + if the mail server configuration is set to "SMTP after POP" authentication and + the password is not already stored in the configuration for security reasons. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string InServerPassword; + + /** contains the subject of the e-Mail message. + + <p>This property is only evaluated for e-Mail output.</p> + @since OOo 2.0 + */ + [property, optional] string Subject; + + + /** contains the name of the data base column that contains the e-Mail address + to the e-Mail to. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string AddressFromColumn; + + + /** determines that the created mail merge document is sent as body in HTML format. + This property is only valid if the property "SendAsAttachment" is set to `FALSE`. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] boolean SendAsHTML; + + + + /** determines that the created mail merge document is sent as attachment. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] boolean SendAsAttachment; + + + /** contains the text of the mail body. + This property is only valid if the property "SendAsAttachment" is set to `TRUE` + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string MailBody; + + + /** contains the name of the attachment. + This property is only valid if "SendAsAttachment" is set to `TRUE`. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string AttachmentName; + + + /** contains the name of the document filter to save the attached mail merge document. + This property is only valid if "SendAsAttachment" is set to `TRUE`. + + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] string AttachmentFilter; + + + /** contains a list of e-Mail addresses to + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] sequence< string > CopiesTo; + + + /** + <p>This property is only evaluated for e-Mail output.</p> + + @since OOo 2.0 + */ + [property, optional] sequence< string > BlindCopiesTo; + + + + /** determines that the output of the mail merge is saved in one single file. + <p>This property is only evaluated for file output.</p> + + @since OOo 2.0 + */ + [property, optional] boolean SaveAsSingleFile; + + + /** contains the name of the document filter to save the output file(s). + <p>This property is only evaluated for file output.</p> + + @since OOo 2.0 + */ + [property, optional] string SaveFilter; + + + /** contains the properties that are defined in <com::sun::star::view::PrintOptions>. + + <p>This property is only evaluated for printer output.</p> + + @since OOo 2.0 + */ + [property, optional] sequence< com::sun::star::beans::PropertyValue > PrintOptions; + +}; + + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/MailMergeEvent.idl b/offapi/com/sun/star/text/MailMergeEvent.idl new file mode 100644 index 000000000..c9764f51b --- /dev/null +++ b/offapi/com/sun/star/text/MailMergeEvent.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_MailMergeEvent_idl__ +#define __com_sun_star_text_MailMergeEvent_idl__ + + + +#include <com/sun/star/lang/EventObject.idl> +#include <com/sun/star/frame/XModel.idl> + + +module com { module sun { module star { module text { + +/** represents a mail merge event. + + <p>This type of event is being sent by the mail merge service + right before the merging of the next document to be processed. + This allows for example to modify the document specifically + before it gets merged.</p> + + @see com::sun::star::text::MailMerge + + @since OOo 1.1.2 +*/ +published struct MailMergeEvent : com::sun::star::lang::EventObject +{ + /** The model of the document to be processed next. + */ + com::sun::star::frame::XModel Model; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/MailMergeType.idl b/offapi/com/sun/star/text/MailMergeType.idl new file mode 100644 index 000000000..174a79c9e --- /dev/null +++ b/offapi/com/sun/star/text/MailMergeType.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_MailMergeType_idl__ +#define __com_sun_star_text_MailMergeType_idl__ + + + + module com { module sun { module star { module text { + + +/** Defines the possible output types/devices for mail merge. + + @since OOo 1.1.2 + */ +published constants MailMergeType +{ + + /** The output device is a printer. + */ + const short PRINTER = 1; + + + /** The output device is a file. + */ + const short FILE = 2; + + + /** The output is sent as e-Mail. + */ + const short MAIL = 3; + + + /** The output is a document shell. + + The successful mail merge returns a XTextDocument based component. + + @since LibreOffice 4.4 + */ + const short SHELL = 4; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ModuleDispatcher.idl b/offapi/com/sun/star/text/ModuleDispatcher.idl new file mode 100644 index 000000000..eec8b4a85 --- /dev/null +++ b/offapi/com/sun/star/text/ModuleDispatcher.idl @@ -0,0 +1,38 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ModuleDispatcher_idl__ +#define __com_sun_star_text_ModuleDispatcher_idl__ + +#include <com/sun/star/frame/XDispatchProvider.idl> + + + module com { module sun { module star { module text { + + +/** + @since LibreOffice 4.1 + */ +service ModuleDispatcher : com::sun::star::frame::XDispatchProvider; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/NotePrintMode.idl b/offapi/com/sun/star/text/NotePrintMode.idl new file mode 100644 index 000000000..7096d8209 --- /dev/null +++ b/offapi/com/sun/star/text/NotePrintMode.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_NotePrintMode_idl__ +#define __com_sun_star_text_NotePrintMode_idl__ + + + + module com { module sun { module star { module text { + +/** enumeration values are used to define the printing of notes in a + document. + */ +published enum NotePrintMode +{ + /** Notes are not printed. + */ + NOT, + + /** Only notes are printed. + */ + ONLY, + + /** Notes are collected at the end of the document. + */ + DOC_END, + + /** Notes are collected at the end of a page and printed on an inserted page. + */ + PAGE_END + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/NumberingLevel.idl b/offapi/com/sun/star/text/NumberingLevel.idl new file mode 100644 index 000000000..18d98aa5f --- /dev/null +++ b/offapi/com/sun/star/text/NumberingLevel.idl @@ -0,0 +1,244 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_NumberingLevel_idl__ +#define __com_sun_star_text_NumberingLevel_idl__ + +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/awt/Size.idl> +#include <com/sun/star/awt/FontDescriptor.idl> +#include <com/sun/star/awt/XBitmap.idl> + + + module com { module sun { module star { module text { + + +/** provides access to a numbering level as part of the Numbering Rules. + */ +published service NumberingLevel +{ + + /** adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER) + + <p> + </p> + */ + [property] short Adjust; + + + /** number of upper levels that are included in the current numbering symbol. + */ + [optional, property] short ParentNumbering; + + + /** the prefix of the numbering symbol. + */ + [property] string Prefix; + + + /** the suffix of the numbering symbol. + */ + [property] string Suffix; + + + /** Name of the character style that is used for the numbering symbol. + */ + [optional, property] string CharStyleName; + + + /** the ID of the symbol in the given font. This is only valid if the + numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL. + @deprecated + */ + [optional, property] short BulletId; + + /** contains the symbol in the given font. This is only valid if the + numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL. + */ + [property] string BulletChar; + + /** the name of the font for the symbol. This is only valid if the + numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL. + */ + [property] string BulletFontName; + + + /** the font used to paint the bullet. + */ + [optional, property] com::sun::star::awt::FontDescriptor BulletFont; + + + /** the URL of the graphic file that is used as the numbering symbol. + + <p> This is only valid if the numbering type is + com::sun::star::style::NumberingType::BITMAP.</p> + + @deprecated as of LibreOffice 6.1, use GraphicBitmap + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the bitmap and set the GraphicBitmap + property. + */ + [property] string GraphicURL; + + + /** the graphic file that is used as the numbering symbol. + + <p> This is only valid if the numbering type is + com::sun::star::style::NumberingType::BITMAP.</p> + */ + [optional, property] com::sun::star::awt::XBitmap GraphicBitmap; + + + /** size of the graphic that is used as bullet. + */ + [optional, property] com::sun::star::awt::Size GraphicSize; + + + /** contains the vertical orientation of a graphic. + + <p> It is set using com::sun::star::text::VertOrientation.</p> + */ + [optional, property] short VertOrient; + + /** specifies the start value for the numbering. + + <p>This property is only valid if the numbering type is not + com::sun::star::style::NumberingType::BITMAP or + com::sun::star::style::NumberingType::CHAR_SPECIAL.</p> + */ + [optional, property] short StartWith; + + + /** specifies the left margin of the numbering + */ + [property] long LeftMargin; + + + /** specifies the distance between the numbering symbol and the text of + the paragraph. + */ + [optional, property] long SymbolTextDistance; + + + /** specifies the offset between the beginning of the first line and + the beginning of the following lines of the paragraph. + */ + [property] long FirstLineOffset; + + + /** specifies the type of numbering. @see com::sun::star::style::NumberingType + */ + [property] short NumberingType; + + + /** contains the name of the paragraph style that is interpreted as the + header of this level. It is only contained in the levels of + chapter numbering rules. + */ + [property] string HeadingStyleName; + + /** contains the name of the paragraph style that should use this numbering. + This is ignored for chapter numbering rules, use HeadingStyleName. + + @since LibreOffice 3.6 + */ + [optional, property] string ParagraphStyleName; + + /** contains the color for the symbol. This is only valid if the + numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL. + */ + [optional, property] com::sun::star::util::Color BulletColor; + + /** contains the size of the symbol relative to the high of the paragraph. This is only valid if the + numbering type is com::sun::star::style::NumberingType::CHAR_SPECIAL. + */ + [optional, property] short BulletRelSize; + + /** position and space mode + + <p> + Specifies the position and space mode of the numbering level. + For valid values see com::sun::star::text::PositionAndSpaceMode. + If it equals LABEL_WIDTH_AND_POSITION, properties Adjust, + LeftMargin, SymbolTextDistance and FirstLineOffset are used. + If it equals LABEL_ALIGNMENT, properties Adjust, LabelFollowedBy, + ListtabStopPosition, FirstLineIndent, IndentAt are used. + </p> + + @since OOo 3.0 + */ + [optional, property] short PositionAndSpaceMode; + + /** character following the list label + + <p> + Specifies the character following the list label. + For valid values see com::sun::star::text::LabelFollow. + Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT. + </p> + + @since OOo 3.0 + */ + [optional, property] short LabelFollowedBy; + + /** list tab position + + <p> + Specifies the position of the list tab stop - only non-negative + values are allowed. + Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT + and LabelFollowedBy equal LABELFOLLOW_LISTTAB + </p> + + @since OOo 3.0 + */ + [optional, property] long ListtabStopPosition; + + /** additional line indent for the first text line + + <p> + Specifies the first line indent. + Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT. + </p> + + @since OOo 3.0 + */ + [optional, property] long FirstLineIndent; + + /** indentation of the text lines + + <p> + Specifies the indent of the text lines + Only of relevance, if PositionAndSpaceMode equals LABEL_ALIGNMENT. + </p> + + @since OOo 3.0 + */ + [optional, property] long IndentAt; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/NumberingRules.idl b/offapi/com/sun/star/text/NumberingRules.idl new file mode 100644 index 000000000..c92fe8a77 --- /dev/null +++ b/offapi/com/sun/star/text/NumberingRules.idl @@ -0,0 +1,83 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_NumberingRules_idl__ +#define __com_sun_star_text_NumberingRules_idl__ + +#include <com/sun/star/container/XIndexReplace.idl> +#include <com/sun/star/beans/XPropertySet.idl> + +module com { module sun { module star { module text { + +/** provides access to the numbering rules. + <p> Numbering rules may be set at a Paragraph object. The numbering rules are + levels of property values. Each level contains equal properties. + + </p> + */ +published service NumberingRules +{ + /** provides access to the levels of the numbering rule. + + <p>The numbering rules are levels of property values. Each + level contains equal properties.</p> + @see NumberingLevel;@see NumberingLevel; + */ + interface com::sun::star::container::XIndexReplace; + + [optional] interface com::sun::star::beans::XPropertySet; + + /** determines if the margins are absolute or relative + to the preceding numbering level. + */ + [optional, property] boolean IsAbsoluteMargins; + + /** determines if the numbering rules are automatically created + as opposed to numbering rules that are part of a numbering style. + */ + [optional, property] boolean IsAutomatic; + + /** determines if the numbering levels are counted continuously or if + each numbering level is counted separately. + */ + [optional, property] boolean IsContinuousNumbering; + + /** contains the name of the numbering rules. It is used to identify a certain + numbering rules property + */ + [optional, readonly, property] string Name; + + /** This numbering is used in the outline of the document (e.g. headings). + */ + [optional, property] boolean NumberingIsOutline; + + /** the type of numbering (Arabic, characters, roman numbers, etc.). + */ + [optional, property] short NumberingType; + + /** id of default list for the numbering rules instance + */ + [optional, readonly, property] string DefaultListId; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/NumberingStyle.idl b/offapi/com/sun/star/text/NumberingStyle.idl new file mode 100644 index 000000000..8d624e2e3 --- /dev/null +++ b/offapi/com/sun/star/text/NumberingStyle.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_NumberingStyle_idl__ +#define __com_sun_star_text_NumberingStyle_idl__ + +#include <com/sun/star/style/Style.idl> +#include <com/sun/star/text/NumberingRules.idl> + + +module com { module sun { module star { module text { + + +/** specifies a style sheet numberings within a + com::sun::star::text::Text. + */ +published service NumberingStyle +{ + /// specifies administrative properties. + service com::sun::star::style::Style; + service NumberingRules; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ObjectIndex.idl b/offapi/com/sun/star/text/ObjectIndex.idl new file mode 100644 index 000000000..a37282507 --- /dev/null +++ b/offapi/com/sun/star/text/ObjectIndex.idl @@ -0,0 +1,63 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_ObjectIndex_idl__ +#define __com_sun_star_text_ObjectIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + + module com { module sun { module star { module text { + +/** specifies service of object indexes within a document.@see com::sun::star::text::BaseIndex + */ +published service ObjectIndex +{ + service com::sun::star::text::BaseIndex; + + /** Determines if star office math objects are included in the office. + */ + [optional, property] boolean CreateFromStarMath;//objects + /** Determines if star office image objects are included in the office. + */ + [optional, property] boolean CreateFromStarImage;//objects + /** Determines if star office chart objects are included in the office. + */ + [optional, property] boolean CreateFromStarChart;//objects + /** Determines if star office calc objects are included in the office. + */ + [optional, property] boolean CreateFromStarCalc;//objects + /** Determines if star office draw objects are included in the office. + */ + [optional, property] boolean CreateFromStarDraw;//objects + /** Determines if external embedded objects are included in the office. + */ + [optional, property] boolean CreateFromOtherEmbeddedObjects;//objects +}; + + +}; }; }; }; + +#endif + + + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PageFootnoteInfo.idl b/offapi/com/sun/star/text/PageFootnoteInfo.idl new file mode 100644 index 000000000..ed25fa967 --- /dev/null +++ b/offapi/com/sun/star/text/PageFootnoteInfo.idl @@ -0,0 +1,72 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PageFootnoteInfo_idl__ +#define __com_sun_star_text_PageFootnoteInfo_idl__ + +#include <com/sun/star/text/HorizontalAdjust.idl> + + + + module com { module sun { module star { module text { + +/** specifies the properties of the footnote area of a page or a + page style. + */ +published service PageFootnoteInfo +{ + /** contains the maximum height of the footnote section. + + + + <p>If 0, the maximum is the height of the page.</p> + */ + [property] long FootnoteHeight; + + /** contains the relative width of the footnote separator line. + */ + [property] long FootnoteSeparatorLineWidth; + + /** contains the distance between the text and footnote section. + */ + [property] long FootnoteTopDistance; + + /** contains the distance between the separator line and the footnote section. + */ + [property] long FootnoteBottomDistance; + + /** contains the relative width of the footnote separator line. + */ + [property] short FootnoteSeparatorLineWidthPercent; + + /** contains the adjustment of the footnote separator line. + */ + [property] com::sun::star::text::HorizontalAdjust FootnoteSeparatorLineAdjust; + + /** contains the width of the pen for the footnote separator line. + */ + [property] short FootnoteSeparatorLinePenWidth; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PageNumberType.idl b/offapi/com/sun/star/text/PageNumberType.idl new file mode 100644 index 000000000..b1999315d --- /dev/null +++ b/offapi/com/sun/star/text/PageNumberType.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PageNumberType_idl__ +#define __com_sun_star_text_PageNumberType_idl__ + + + + module com { module sun { module star { module text { + +/** determines which page number is displayed in a page number text field. + */ +published enum PageNumberType +{ + /** The number of the previous page is displayed if there is any, otherwise the + field is empty. + */ + PREV, + + /** The number of the current page is displayed. + */ + CURRENT, + + /** The number of the next page is displayed if there is any, otherwise the + field is empty. + */ + NEXT + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PagePrintSettings.idl b/offapi/com/sun/star/text/PagePrintSettings.idl new file mode 100644 index 000000000..854d365cd --- /dev/null +++ b/offapi/com/sun/star/text/PagePrintSettings.idl @@ -0,0 +1,74 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PagePrintSettings_idl__ +#define __com_sun_star_text_PagePrintSettings_idl__ + + + + module com { module sun { module star { module text { + +/** These properties describe the way the XPagePrintable interface + prints the page on one printer page. + */ +published service PagePrintSettings +{ + /** contains the number of pages per printed column of pages. + */ + [property] short PageRows; + + /** contains the number of pages per printed row of pages. + */ + [property] short PageColumns; + + /** contains the left margin of the printer page. + */ + [property] long LeftMargin; + + /** contains the right margin of the printer page. + */ + [property] long RightMargin; + + /** contains the top margin of the printer page. + */ + [property] long TopMargin; + + /** contains the right margin of the printer page. + */ + [property] long BottomMargin; + + /** contains the margin between the rows of printed pages. + */ + [property] long HoriMargin; + + /** contains the margin between the columns of printed pages. + */ + [property] long VertMargin; + + /** defines if the printer page is used in landscape format. + */ + [property] boolean IsLandscape; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Paragraph.idl b/offapi/com/sun/star/text/Paragraph.idl new file mode 100644 index 000000000..2f84ec9fe --- /dev/null +++ b/offapi/com/sun/star/text/Paragraph.idl @@ -0,0 +1,104 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Paragraph_idl__ +#define __com_sun_star_text_Paragraph_idl__ + +#include <com/sun/star/style/ParagraphProperties.idl> +#include <com/sun/star/style/ParagraphPropertiesAsian.idl> +#include <com/sun/star/style/ParagraphPropertiesComplex.idl> +#include <com/sun/star/style/CharacterProperties.idl> +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/XTolerantMultiPropertySet.idl> +#include <com/sun/star/beans/XPropertyState.idl> +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/text/TextTable.idl> + + + + module com { module sun { module star { module text { + +/** is a piece of text which can take its own paragraph-specific + attributes (technically, properties). + */ +published service Paragraph +{ + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::ParagraphProperties; + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::ParagraphPropertiesAsian; + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::ParagraphPropertiesComplex; + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::CharacterProperties; + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::CharacterPropertiesAsian; + /** This service is present when the paragraph object refers + to a text range */ + [optional] service com::sun::star::style::CharacterPropertiesComplex; + /** This service is present when the paragraph object refers + to a text table */ + [optional] service com::sun::star::text::TextTable; + service com::sun::star::text::TextContent; + + /** This interface gives access to the properties of the paragraph + itself (or its style sheet). So this interface may show + property values which are not valid for any of the + text portions of the paragraph, if the text itself has its + own style properties set. + */ + interface com::sun::star::beans::XPropertySet; + + /** This interface gives access to the state of the property values + in these properties. So, it is possible to determine if a specific + properties value is defined in the paragraph or its style sheet. + */ + interface com::sun::star::beans::XPropertyState; + + /** This interface enumerates the text portions of this paragraph. + + <p>A text portion is defined as the largest possible TextRange + within a paragraph with the same property values and the same bound objects. + + <p>In general this interface is used for exporting into file + formats. + + @see com::sun::star::text::TextRange@see com::sun::star::text::TextRange + */ + interface com::sun::star::container::XEnumerationAccess; + + /** gives access to a sequence of properties. + @since OOo 2.0 + */ + [optional] interface ::com::sun::star::beans::XTolerantMultiPropertySet; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ParagraphEnumeration.idl b/offapi/com/sun/star/text/ParagraphEnumeration.idl new file mode 100644 index 000000000..afdc2f610 --- /dev/null +++ b/offapi/com/sun/star/text/ParagraphEnumeration.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ParagraphEnumeration_idl__ +#define __com_sun_star_text_ParagraphEnumeration_idl__ + +#include <com/sun/star/container/XEnumeration.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the paragraphs of an XText + interface. + */ +published service ParagraphEnumeration +{ + + /** provides access to the paragraph objects. + */ + interface com::sun::star::container::XEnumeration; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ParagraphVertAlign.idl b/offapi/com/sun/star/text/ParagraphVertAlign.idl new file mode 100644 index 000000000..d08599a6a --- /dev/null +++ b/offapi/com/sun/star/text/ParagraphVertAlign.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ParagraphVertAlign_idl__ +#define __com_sun_star_text_ParagraphVertAlign_idl__ + + + + module com { module sun { module star { module text { + + +/** These enumeration values are used to specify the vertical alignment of paragraphs. + */ +published constants ParagraphVertAlign +{ + /** In automatic mode, horizontal text is aligned to the baseline. The same applies to + text that is rotated 90°. Text that is rotated 270 ° is aligned to the center. + */ + const short AUTOMATIC = 0; + /** The text is aligned to the baseline. + */ + const short BASELINE = 1; + /** The text is aligned to the top. + */ + const short TOP = 2; + + /** The text is aligned to the center. + */ + const short CENTER = 3; + + /** The text is aligned to bottom. + */ + const short BOTTOM = 4; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PlaceholderType.idl b/offapi/com/sun/star/text/PlaceholderType.idl new file mode 100644 index 000000000..1a3473f07 --- /dev/null +++ b/offapi/com/sun/star/text/PlaceholderType.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PlaceholderType_idl__ +#define __com_sun_star_text_PlaceholderType_idl__ + + + + module com { module sun { module star { module text { + +/** These constants define how the place-holder text fields act in a document. + */ +published constants PlaceholderType +{ + /** The field represents a piece of text. + */ + const short TEXT = 0; + + /** The field initiates the insertion of a text table. + */ + const short TABLE = 1; + + /** The field initiates the insertion of a text frame. + */ + const short TEXTFRAME = 2; + + /** The field initiates the insertion of a graphic object. + */ + const short GRAPHIC = 3; + + /** The field initiates the insertion of an embedded object. + */ + const short OBJECT = 4; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PositionAndSpaceMode.idl b/offapi/com/sun/star/text/PositionAndSpaceMode.idl new file mode 100644 index 000000000..63c8fdcf1 --- /dev/null +++ b/offapi/com/sun/star/text/PositionAndSpaceMode.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PositionAndSpaceMode_idl__ +#define __com_sun_star_text_PositionAndSpaceMode_idl__ + + + + module com { module sun { module star { module text { + + +/** These enumeration values specify the position and space mode for a numbering level + + @since OOo 3.0 + */ +published constants PositionAndSpaceMode +{ + + /** positioning and spacing of list label via label width and position + */ + const short LABEL_WIDTH_AND_POSITION = 0; + + + /** positioning and spacing of list label via label alignment + */ + const short LABEL_ALIGNMENT = 1; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PositionLayoutDir.idl b/offapi/com/sun/star/text/PositionLayoutDir.idl new file mode 100644 index 000000000..cd15a3b19 --- /dev/null +++ b/offapi/com/sun/star/text/PositionLayoutDir.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PositionLayoutDir_idl__ +#define __com_sun_star_text_PositionLayoutDir_idl__ + + + + module com { module sun { module star { module text { + + +/** These values specify the layout direction, in which the position attributes + of a shape are given + + @since OOo 2.0 + */ +constants PositionLayoutDir +{ + + /** position attributes are given in horizontal left-to-right direction + */ + const short PositionInHoriL2R = 1; + + + /** position attributes are given in layout direction of the drawing + objects anchor + */ + const short PositionInLayoutDirOfAnchor = 2; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/PrintSettings.idl b/offapi/com/sun/star/text/PrintSettings.idl new file mode 100644 index 000000000..9e6bbd1b1 --- /dev/null +++ b/offapi/com/sun/star/text/PrintSettings.idl @@ -0,0 +1,101 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_PrintSettings_idl__ +#define __com_sun_star_text_PrintSettings_idl__ + +#include <com/sun/star/text/NotePrintMode.idl> + + + + module com { module sun { module star { module text { + +/** These properties describe the printing of the content of a text document. + */ +published service PrintSettings +{ + /** determines if graphic objects are printed + */ + [property] boolean PrintGraphics; + + /** determines if text tables are printed. + */ + [property] boolean PrintTables; + + /** determines if shapes are printed. + */ + [property] boolean PrintDrawings; + + /** determines if left pages are printed. + */ + [property] boolean PrintLeftPages; + + /** determines if right pages are printed. + */ + [property] boolean PrintRightPages; + + /** determines if control shapes are printed. + */ + [property] boolean PrintControls; + + /** determines if the pages are printed in the reverse order, starting with the last page. + */ + [property] boolean PrintReversed; + + /** specifies if the printer paper tray selection of the system + printer is used. + + + + <p>If com::sun::star::view::PrintSettings::PaperFromSetup is `FALSE`, + then the paper tray selection of the page styles is used.</p> + */ + [property] boolean PrintPaperFromSetup; + + /** contains the name of the fax. + */ + [property] string PrintFaxName; + + /** determines how notes are printed.@see NotePrintMode + */ + [property] com::sun::star::text::NotePrintMode PrintAnnotationMode; + + /** determines if prospect printing is used. + */ + [property] boolean PrintProspect; + + /** determines if the background color / background graphic of pages is printed. + */ + [property] boolean PrintPageBackground; + + /** determines if characters are always printed in black. + */ + [property] boolean PrintBlackFonts; + + + /** determines if automatically inserted empty pages are printed. + */ + [optional, property] boolean PrintEmptyPages; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/RedlinePortion.idl b/offapi/com/sun/star/text/RedlinePortion.idl new file mode 100644 index 000000000..34da4c99d --- /dev/null +++ b/offapi/com/sun/star/text/RedlinePortion.idl @@ -0,0 +1,82 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_RedlinePortion_idl__ +#define __com_sun_star_text_RedlinePortion_idl__ + +#include <com/sun/star/text/TextPortion.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/util/DateTime.idl> + + +module com { module sun { module star { module text { + +/** A RedlinePortion is a TextPortion that marks a change that has been recorded by +the change tracking. + +*/ +published service RedlinePortion +{ + service com::sun::star::text::TextPortion; + /** contains the name of the author of the change.*/ + [readonly, property] string RedlineAuthor; + /** contains the date and time of the change.*/ + [readonly, property] com::sun::star::util::DateTime RedlineDateTime; + /** contains a comment for the change.*/ + [readonly, property] string RedlineComment; + /** contains the type of the change + <p> Valid type names are:</p> + <UL> + <LI><P>Insert - marks an insertion</P> + <LI><P>Delete - marks a deletion</P> + <LI><P>Format - marks an attribute change</P> + <LI><P>TextTable - marks a text table</P> + <LI><P>Style - marks an applied style</P> + </UL> + */ + [readonly, property] string RedlineType; + /** contains the data of a second level redline data + <p> The elements of the sequence are:</p> + <UL> + <LI><P>string RedlineAuthor; </P> + <LI><P>com::sun::star::util::DateTime RedlineDateTime; </P> + <LI><P>string RedlineComment; </P> + <LI><P>string RedlineType; </P> + </UL> + */ + [readonly, property] com::sun::star::beans::PropertyValues RedlineSuccessorData; + /** contains a unique identifier for the redline. + This is necessary for file export filters to able to recognize redline portions + that point to the same redline.*/ + [readonly, property] string RedlineIdentifier; + /** determines whether the portion is member of a header or footer text.*/ + [readonly, property] boolean IsInHeaderFooter; + /** provides access to the text of the redline. This interface is only provided + if the change is not visible. The visibility depends on the redline display options that + are set at the documents property set (RedlineDisplayType).*/ + [readonly, property] com::sun::star::text::XText RedlineText; + /** determines whether the last paragraph of a redline text has to be merged with a + possible following text content (i.e. a text table)*/ + [readonly, property] boolean MergeLastPara; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ReferenceFieldPart.idl b/offapi/com/sun/star/text/ReferenceFieldPart.idl new file mode 100644 index 000000000..d7d4c0790 --- /dev/null +++ b/offapi/com/sun/star/text/ReferenceFieldPart.idl @@ -0,0 +1,116 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ReferenceFieldPart_idl__ +#define __com_sun_star_text_ReferenceFieldPart_idl__ + + + +module com { module sun { module star { module text { + +/** These constants define how the reference position is displayed in + reference text fields. + +*/ +published constants ReferenceFieldPart +{ + /** The page number is displayed using Arabic numbers. + */ + const short PAGE = 0; + + /** The number of the chapter is displayed. + */ + const short CHAPTER = 1; + + /** The reference text is displayed. + <p>If the source of the reference is a sequence field, then the complete text + of the paragraph is displayed. This is useful to reference to captions. </p> + */ + const short TEXT = 2; + + /** The reference is displayed as one of the (localized) words, "above" or "below". + */ + const short UP_DOWN = 3; + + /** The page number is displayed using the numbering type defined in + the page style of the reference position. + */ + const short PAGE_DESC = 4; + /** The category and the number of a caption is displayed. + <p>This option is only valid if the source of the reference is a sequence field.</p> + */ + const short CATEGORY_AND_NUMBER = 5; + /** The caption text of a caption is displayed. + <p>This option is only valid if the source of the reference is a sequence field.</p> + */ + const short ONLY_CAPTION = 6; + /** The number of a sequence field is displayed. + <p>This option is only valid if the source of the reference is a sequence field.</p> + */ + const short ONLY_SEQUENCE_NUMBER = 7; + /** The numbering label and depending of the reference field context numbering labels of + superior list levels of the reference are displayed. + + <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> + <p>The contents of the list label of the paragraph, at which the bookmark respectively the + set reference starts - named "referenced item" in the following - is displayed. To unambiguous + identify the referenced item at the document position of the reference text field, the content + of all needed superior levels are added in front. The needed superior levels of the referenced + item are the ones, which differ from the superior levels of the document position of the reference + text field. + Additional condition, which suppresses the addition of a superior level's list label content: + The list label of the referenced item can already contain numbers of a superior levels. Assume X + be the level of the most superior level, then no list label content of superior levels greater or + equal than X are added. + If the referenced item isn't numbered, nothing is displayed.</p> + + @since OOo 3.0 + */ + const short NUMBER = 8; + /** The numbering label of the reference is displayed. + + <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> + <p>The contents of the list label of the paragraph, at which the bookmark respectively the + set reference starts, is displayed. If this paragraph isn't numbered, nothing is displayed.</p> + + @since OOo 3.0 + */ + const short NUMBER_NO_CONTEXT = 9; + /** The numbering label and numbering labels of superior list levels of the reference are displayed. + + <p>This option is only valid, if the source of the reference is a bookmark or a set reference.</p> + <p>The contents of the list label of the paragraph, at which the bookmark respectively the + set reference starts - named "referenced item" in the following - is displayed and the contents + of all list labels of superior levels are added in front of it. + Additional condition, which suppresses the addition of a superior level's list label content: + The list label of the referenced item can already contain numbers of a superior levels. Assume X + be the level of the most superior level, then no list label content of superior levels greater or + equal than X are added. + If the referenced item is numbered nothing is displayed.</p> + + @since OOo 3.0 + */ + const short NUMBER_FULL_CONTEXT = 10; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ReferenceFieldSource.idl b/offapi/com/sun/star/text/ReferenceFieldSource.idl new file mode 100644 index 000000000..7f2439f5c --- /dev/null +++ b/offapi/com/sun/star/text/ReferenceFieldSource.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ReferenceFieldSource_idl__ +#define __com_sun_star_text_ReferenceFieldSource_idl__ + + + +module com { module sun { module star { module text { + +/** These constants define the type of the source of a reference field. +*/ +published constants ReferenceFieldSource +{ + /** The source is a reference mark. + */ + const short REFERENCE_MARK = 0; + + /** The source is a number sequence field. + */ + const short SEQUENCE_FIELD = 1; + + /** The source is a bookmark. + */ + const short BOOKMARK = 2; + + /** The source is a footnote. + */ + const short FOOTNOTE = 3; + + /** The source is an endnote. + */ + const short ENDNOTE = 4; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ReferenceMark.idl b/offapi/com/sun/star/text/ReferenceMark.idl new file mode 100644 index 000000000..beda59103 --- /dev/null +++ b/offapi/com/sun/star/text/ReferenceMark.idl @@ -0,0 +1,43 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ReferenceMark_idl__ +#define __com_sun_star_text_ReferenceMark_idl__ + +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/container/XNamed.idl> + + + +module com { module sun { module star { module text { + +/** is used for cross references in text documents. +*/ +published service ReferenceMark +{ + interface com::sun::star::text::XTextContent; + interface com::sun::star::container::XNamed; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ReferenceMarks.idl b/offapi/com/sun/star/text/ReferenceMarks.idl new file mode 100644 index 000000000..f04a4b4a7 --- /dev/null +++ b/offapi/com/sun/star/text/ReferenceMarks.idl @@ -0,0 +1,43 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ReferenceMarks_idl__ +#define __com_sun_star_text_ReferenceMarks_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/XNameAccess.idl> + + + +module com { module sun { module star { module text { + +/** provides access to the reference marks in a document. +*/ +published service ReferenceMarks +{ + interface com::sun::star::container::XIndexAccess; + interface com::sun::star::container::XNameAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/RelOrientation.idl b/offapi/com/sun/star/text/RelOrientation.idl new file mode 100644 index 000000000..3ce3160d4 --- /dev/null +++ b/offapi/com/sun/star/text/RelOrientation.idl @@ -0,0 +1,95 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_RelOrientation_idl__ +#define __com_sun_star_text_RelOrientation_idl__ + + + + module com { module sun { module star { module text { + +/** These values define the reference position of relative orientations. + */ +published constants RelOrientation +{ + /** paragraph, including margins + */ + const short FRAME = 0; + + /** paragraph, without margins + */ + const short PRINT_AREA = 1; + + /** at a character + */ + const short CHAR = 2; + + /** inside the left page margin + */ + const short PAGE_LEFT = 3; + + /** inside the right page margin + */ + const short PAGE_RIGHT = 4; + + /** inside the left paragraph margin + */ + const short FRAME_LEFT = 5; + + /** inside the right paragraph margin + */ + const short FRAME_RIGHT = 6; + + /** page includes margins for page-anchored frames identical with + RelOrientation::FRAME + */ + const short PAGE_FRAME = 7; + + /** page without borders (for page anchored frames identical with + RelOrientation::PRINT_AREA). + +<!-- JRH: does not make sense --> + */ + const short PAGE_PRINT_AREA = 8; + + /** at the top of the text line, only sensible for vertical orientation. + + @since OOo 2.0 + */ + const short TEXT_LINE = 9; + + /** Bottom page border (page area below PAGE_PRINT_AREA). + + @since LibreOffice 7.0 + */ + const short PAGE_PRINT_AREA_BOTTOM = 10; + + /** Top page border (page area above PAGE_PRINT_AREA). + + @since LibreOffice 7.1 + */ + const short PAGE_PRINT_AREA_TOP = 11; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/RubyAdjust.idl b/offapi/com/sun/star/text/RubyAdjust.idl new file mode 100644 index 000000000..6765963bc --- /dev/null +++ b/offapi/com/sun/star/text/RubyAdjust.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_RubyAdjust_idl__ +#define __com_sun_star_text_RubyAdjust_idl__ + + + + module com { module sun { module star { module text { + + +/** These enumeration values describe the adjustment of ruby text. + */ +published enum RubyAdjust +{ + /** adjusted to the left. + */ + LEFT, + /** centric adjusted. + */ + CENTER, + /** adjusted to the right. + */ + RIGHT, + /** adjusted to both borders / stretched + */ + BLOCK, + /** adjusted to both borders except for a small indent on both sides + */ + INDENT_BLOCK +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/RubyPosition.idl b/offapi/com/sun/star/text/RubyPosition.idl new file mode 100644 index 000000000..39258e5f8 --- /dev/null +++ b/offapi/com/sun/star/text/RubyPosition.idl @@ -0,0 +1,39 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */ +/* + * 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/. + */ +#ifndef __com_sun_star_text_RubyPosition_idl__ +#define __com_sun_star_text_RubyPosition_idl__ + + + + module com { module sun { module star { module text { + + +/** These constants define the position of ruby text. + @since LibreOffice 6.1 + */ +constants RubyPosition +{ + /** ruby text should be above or on the right side of base text. + */ + const short ABOVE = 0; + /** ruby text should be below or on the left side of base text. + */ + const short BELOW = 1; + /** Vertically aligned on right side of the base text in horizontal mode. + <P>This is the same as ABOVE in vertical writing mode.</P> + */ + const short INTER_CHARACTER = 2; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/offapi/com/sun/star/text/SectionFileLink.idl b/offapi/com/sun/star/text/SectionFileLink.idl new file mode 100644 index 000000000..aad3e2b5a --- /dev/null +++ b/offapi/com/sun/star/text/SectionFileLink.idl @@ -0,0 +1,61 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_SectionFileLink_idl__ +#define __com_sun_star_text_SectionFileLink_idl__ + + + + module com { module sun { module star { module text { + +/** describes the link for a text section. + + + + <p>If the URL is an empty string, then the section is not linked. + + </p> + <p>The bookmark of the URL (after the "#") is the name of a bookmark + or a section name in the linked document. If a bookmark or section + with this name exists in the document, then only this part is linked + into the given text section. + </p> + <p> + SectionFileLink::FilterName is the internal name of + the document filter. To use this struct, it is not necessary to set + SectionFileLink::FilterName. It will be automatically + assigned.</p> + */ +published struct SectionFileLink +{ + /** contains the URL of the linked file. + */ + string FileURL; + + /** contains the name of the file filter that is used to load the linked file. + */ + string FilterName; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/SetVariableType.idl b/offapi/com/sun/star/text/SetVariableType.idl new file mode 100644 index 000000000..b45af88c4 --- /dev/null +++ b/offapi/com/sun/star/text/SetVariableType.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_SetVariableType_idl__ +#define __com_sun_star_text_SetVariableType_idl__ + + + + module com { module sun { module star { module text { + +/** These constants define the type of a variable text field. + */ +published constants SetVariableType +{ + /** specifies a simple variable. + */ + const short VAR = 0; + /** specifies a number sequence field. + */ + const short SEQUENCE = 1; + /** specifies a formula field. + */ + const short FORMULA = 2; + /** specifies a string field. + */ + const short STRING = 3; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl new file mode 100644 index 000000000..7e8ba75a2 --- /dev/null +++ b/offapi/com/sun/star/text/Shape.idl @@ -0,0 +1,202 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Shape_idl__ +#define __com_sun_star_text_Shape_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/XTextFrame.idl> +#include <com/sun/star/text/XTextRange.idl> +#include <com/sun/star/drawing/Shape.idl> +#include <com/sun/star/text/TextContentAnchorType.idl> +#include <com/sun/star/text/WrapTextMode.idl> + + + module com { module sun { module star { module text { + + +/** specifies the service of shapes in a text document + */ +published service Shape +{ + service com::sun::star::drawing::Shape; + /** contains the number of the page where the objects are anchored. + <p> The value is valid only if the + AnchorType is + TextContentAnchorType::AT_PAGE.</p> + */ + [property] short AnchorPageNo; + /** contains the text frame the current frame is anchored to. + <p> The value is valid only if the + AnchorType is TextContentAnchorType::AT_FRAME.</p> + */ + [property] com::sun::star::text::XTextFrame AnchorFrame; + /** specifies how the text content is attached to its surrounding + Text. + */ + [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; + /** determines the horizontal orientation of the object. + + @see BaseFrame::HoriOrientation + */ + [property] short HoriOrient; + /** contains the horizontal position of the object (1/100 mm). + <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p> + */ + [property] long HoriOrientPosition; + + /** determines the environment of the object to which the orientation + is related. + + @see BaseFrame::RelOrientation + */ + [property] short HoriOrientRelation; + + /** determines the vertical orientation of the object. + + @see BaseFrame::VertOrientation + */ + [property] short VertOrient; + + /** contains the vertical position of the object (1/100 mm). + + It is only valid if TextEmbeddedObject::VertOrient is + VertOrientation::NONE. + */ + [property] long VertOrientPosition; + + + /** determines the environment of the object to which the orientation is related. + + @see BaseFrame::RelOrientation + */ + [property] short VertOrientRelation; + /** contains the left margin of the object. + */ + [property] long LeftMargin; + + /** contains the right margin of the object. + */ + [property] long RightMargin; + + /** contains the top margin of the object. + */ + [property] long TopMargin; + + /** contains the bottom margin of the object. + */ + [property] long BottomMargin; + /** determines the type of the surrounding text. + + @deprecated + */ + [property] com::sun::star::text::WrapTextMode Surround; + /** determines if the text of the paragraph in which the object + is anchored, wraps around the object. + */ + [property] boolean SurroundAnchorOnly; + + /** determines if the text wraps around the contour of the object. + */ + [property] boolean SurroundContour; + + /** the text flows only around the contour of the object. + */ + [property] boolean ContourOutside; + /** determines if the object is opaque or transparent for text. + */ + [property] boolean Opaque; + /** contains a text range where the shape should be anchored to. + <p>There are two different ways to get newly created shapes into the + text document. One of them is to use the insertTextContent() method of + the com::sun::star::text::XSimpleText. The other is to call the add() + method of the com::sun::star::drawing::XShapes interface. + To be able to determine an anchor position for shape that are anchored at a certain + text position the property TextRange is used.</p> + + <p>This property is used when the shape gets inserted/added + and becomes invalid after that.</p> + + */ + [property] com::sun::star::text::XTextRange TextRange; + + /** determines the influence of the text wrap on the positioning of the + shape + + <p>The value of this property is only evaluated for the positioning + of the shape, if the text document setting ConsiderTextWrapOnObjPos + is `TRUE`. Valid values are given by #WrapInfluenceOnPosition</p> + + @since OOo 2.0 + */ + [optional, property] short WrapInfluenceOnPosition; + + /** determines the transformation of the shape in horizontal left-to-right + layout + + <p>This property is needed for the export of the OASIS Open Office + file format to the OpenOffice.org file format. It provides the + transformation property of the included service com::sun::star::drawing::Shape + converted to the horizontal left-to-right layout.</p> + + @since OOo 2.0 + */ + [optional, readonly, property] com::sun::star::drawing::HomogenMatrix3 TransformationInHoriL2R; + /** determines layout direction the position attributes of the shape + is given + + <p>Valid values are given by #PositionLayoutDir</p> + + @since OOo 2.0 + */ + [optional, property] short PositionLayoutDir; + /** determines the start position of the shape in horizontal left-to-right + layout + + <p>This property is needed for the export of the OASIS Open Office + file format to the OpenOffice.org file format. It provides the + start position property of the included service com::sun::star::drawing::Shape + converted to the horizontal left-to-right layout.</p> + + @since OOo 2.0 + */ + [optional, readonly, property] com::sun::star::awt::Point StartPositionInHoriL2R; + /** determines the end position of the shape in horizontal left-to-right + layout + + <p>This property is needed for the export of the OASIS Open Office + file format to the OpenOffice.org file format. It provides the + end position property of the included service com::sun::star::drawing::Shape + converted to the horizontal left-to-right layout.</p> + + @since OOo 2.0 + */ + [optional, readonly, property] com::sun::star::awt::Point EndPositionInHoriL2R; + + /** This defines if the shape is allowed to overlap with other anchored objects. + @since LibreOffice 6.4 + */ + [optional, property] boolean AllowOverlap; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/SizeType.idl b/offapi/com/sun/star/text/SizeType.idl new file mode 100644 index 000000000..4849838a3 --- /dev/null +++ b/offapi/com/sun/star/text/SizeType.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_SizeType_idl__ +#define __com_sun_star_text_SizeType_idl__ + + + + module com { module sun { module star { module text { + +/** The height value of objects like text frames or table rows may + be interpreted in different ways. + + <p>The values may specify the absolute height (SIZETYPE_FIX), the + minimum height (SIZETYPE_MIN), or they are ignored (SIZETYPE_VAR), + in which case the real height depends on the content. This information + is contained in a property called "SizeType". + */ +published constants SizeType +{ + // The height of the object is determined by the content only. + const short VARIABLE = 0; + + // The height property determines the height of the object. + const short FIX = 1; + + /** The height property determines the minimum height of the object, but the + actual height will be increased if the content demands it. + */ + const short MIN = 2; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TableColumnSeparator.idl b/offapi/com/sun/star/text/TableColumnSeparator.idl new file mode 100644 index 000000000..7cf308091 --- /dev/null +++ b/offapi/com/sun/star/text/TableColumnSeparator.idl @@ -0,0 +1,76 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TableColumnSeparator_idl__ +#define __com_sun_star_text_TableColumnSeparator_idl__ + + + + module com { module sun { module star { module text { + + +/** The width of the cells of a text table is defined by the position + of the separator between neighboring cells. + + <p>If cells of the table are merged, this separator is not removed, but + it is hidden. + </p> + + <p>A text table or a text table row provides the separators in a + sequence of TableColumnSeparators. If the table only + consists of one column, then this sequence is empty. + + </p> + <p>The real width of a table depends on the environment (page style and + number of text columns at the table's position, alignment, and left and + right margins). For that reason, the table column separator does not + contain metric values for the column widths. The values are relative + to the value of the property TextTable::TableColumnRelativeSum. + + </p> + <p>A table provides this property only if all rows have the same structure. + If the table does not provide the property, then it cannot be set using. + </p> + + <p>The state of TableColumnSeparator::IsVisible and the + count of the sequence must be the same in as it was in. + Hidden separators cannot be moved and they cannot be overtaken by visible + separators.</p> + + @see com::sun::star::text::TextTable + */ +published struct TableColumnSeparator +{ + /** contains the position of the separator. + */ + short Position; + + + /** determines if the separator is visible. + */ + boolean IsVisible; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TableColumns.idl b/offapi/com/sun/star/text/TableColumns.idl new file mode 100644 index 000000000..c3d3b4900 --- /dev/null +++ b/offapi/com/sun/star/text/TableColumns.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TableColumns_idl__ +#define __com_sun_star_text_TableColumns_idl__ + +#include <com/sun/star/table/XTableColumns.idl> +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/XNameAccess.idl> + + +module com { module sun { module star { module text { + + +/** represents a collection of all columns of a table. + + @see com::sun::star::table::TableColumn + @see com::sun::star::text::TextTable + + @since OOo 1.1.2 + */ +published service TableColumns +{ + /** provides methods to insert and remove columns. + */ + interface com::sun::star::table::XTableColumns; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TableIndex.idl b/offapi/com/sun/star/text/TableIndex.idl new file mode 100644 index 000000000..420d57e1a --- /dev/null +++ b/offapi/com/sun/star/text/TableIndex.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_TableIndex_idl__ +#define __com_sun_star_text_TableIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + + module com { module sun { module star { module text { + + +/** specifies service of table indexes within a document. + @see com::sun::star::text::BaseIndex + */ +published service TableIndex +{ + service com::sun::star::text::BaseIndex; + + /** determines if the name or the label of an object is used to create the index. + */ + [optional, property] boolean CreateFromLabels; //tables, illustrations + + /** determines the name of the sequence field that is evaluated to create the index. + */ + [optional, property] string LabelCategory; //tables, illustrations + + /** determines the way the paragraph containing a label is included in the index. + @see ReferenceFieldPart allowed constant values: only TEXT, CATEGORY_AND_NUMBER and + ONLY_CAPTION + */ + [optional, property] short LabelDisplayType;//tables, illustrations +}; + + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TableRows.idl b/offapi/com/sun/star/text/TableRows.idl new file mode 100644 index 000000000..72c4986af --- /dev/null +++ b/offapi/com/sun/star/text/TableRows.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TableRows_idl__ +#define __com_sun_star_text_TableRows_idl__ + +#include <com/sun/star/table/XTableRows.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + +module com { module sun { module star { module text { + + +/** represents a collection of all rows of a text table. + + @see com::sun::star::table::TableRow + @see com::sun::star::text::TextTable + + @since OOo 1.1.2 + */ +published service TableRows +{ + /** provides methods to insert and remove rows. + */ + interface com::sun::star::table::XTableRows; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TemplateDisplayFormat.idl b/offapi/com/sun/star/text/TemplateDisplayFormat.idl new file mode 100644 index 000000000..853f05a56 --- /dev/null +++ b/offapi/com/sun/star/text/TemplateDisplayFormat.idl @@ -0,0 +1,62 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TemplateDisplayFormat_idl__ +#define __com_sun_star_text_TemplateDisplayFormat_idl__ + + + + module com { module sun { module star { module text { + +/** These constants are used to specify which information about a template is + displayed in a field. + */ +published constants TemplateDisplayFormat +{ + // The complete path of the file will be displayed. + const short FULL = 0; + + // Only the path of the template file will be displayed. + const short PATH = 1; + + /** Only the file name, without file extension, of the template + file will be displayed. + */ + const short NAME = 2; + + /** The file name and the file extension of the template + file will be displayed. + */ + const short NAME_AND_EXT = 3; + + /** The name of the template area is displayed. + */ + const short AREA = 4; + + /** The title of the template file is displayed. + */ + const short TITLE = 5; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/Text.idl b/offapi/com/sun/star/text/Text.idl new file mode 100644 index 000000000..0c0a7e58c --- /dev/null +++ b/offapi/com/sun/star/text/Text.idl @@ -0,0 +1,127 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_Text_idl__ +#define __com_sun_star_text_Text_idl__ + +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + + + module com { module sun { module star { module text { + + published interface XText; + published interface XTextRangeMover; + published interface XTextRangeCompare; + published interface XRelativeTextContentInsert; + +/** is an independent piece of text which consists of a + series of one or more paragraphs. + + <p>This service is used, for example, for the text of a TextDocument + or the text in a cell or TextFrame. + + @see com::sun::star::text::TextDocument + @see com::sun::star::text::TextFrame + @see com::sun::star::table::Cell + */ +published service Text +{ + /** This is the factory for an enumeration of the paragraphs in this text. + + <p>This interface is mainly useful for exporting the text to a + data format. + */ + interface com::sun::star::container::XEnumerationAccess; + + + /** provides a cursor factory and the possibility to insert and remove contents. + */ + interface XText; + + + /** optional interface to compare positions of TextRange + instances within this text. + */ + [optional] interface XTextRangeCompare; + + + /** makes it possible to change the position of paragraphs. + + */ + [optional] interface XTextRangeMover; + + + /** makes it possible to insert a new text content, before or + after existing text contents. + + @deprecated hack + */ + [optional] interface XRelativeTextContentInsert; + + + /** contains the properties of a redline at the start of the document.<br> + The sequence contains the following properties + <UL> + <LI><P>string RedlineAuthor </P></LI> + <LI><P>com::sun::star::util::DateTime RedlineDate_Time </P></LI> + <LI><P>string RedlineComment </P></LI> + <LI><P>string RedlineType </P></LI> + <LI><P>string RedlineIdentifier </P></LI> + <LI><P>boolean IsCollapsed </P></LI> + <LI><P>boolean IsStart </P></LI> + <LI><P>boolean MergeLastPara </P></LI> + <LI><P>[maybevoid] com::sun::star::text::XText RedlineText (maybevoid)</P></LI> + <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData + (contains the same properties except for the RedlineSuccessorData)</P></LI> + </UL> + @see EndRedline + */ + [optional, property] ::com::sun::star::beans::PropertyValues StartRedline; + + + /** contains the properties of a redline at the start of the document. + The sequence contains the following properties + <UL> + <LI><P>string RedlineAuthor </P></LI> + <LI><P>com::sun::star::util::DateTime RedlineDate_Time </P></LI> + <LI><P>string RedlineComment </P></LI> + <LI><P>string RedlineType </P></LI> + <LI><P>string RedlineIdentifier </P></LI> + <LI><P>boolean IsCollapsed </P></LI> + <LI><P>boolean IsStart </P></LI> + <LI><P>boolean MergeLastPara </P></LI> + <LI><P>[maybevoid] com::sun::star::text::XText RedlineText (maybevoid)</P></LI> + <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData + (contains the same properties except for the RedlineSuccessorData)</P></LI> + </UL> + @see StartRedline + */ + [optional, maybevoid, property] ::com::sun::star::beans::PropertyValues EndRedline; + + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextColumn.idl b/offapi/com/sun/star/text/TextColumn.idl new file mode 100644 index 000000000..0f501d6bf --- /dev/null +++ b/offapi/com/sun/star/text/TextColumn.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextColumn_idl__ +#define __com_sun_star_text_TextColumn_idl__ + + + + module com { module sun { module star { module text { + +/** defines a single text column. + */ +published struct TextColumn +{ + /** contains the relative width of the column, including both margins. + + + Width isn't a metric value, it's a relative value to the sum of the width of all columns. + */ + long Width; + + /** contains the left margin of the column. + + + + <p>This is a metric value.</p> + */ + long LeftMargin; + + /** contains the right margin of the column. + + + + <p>This is a metric value.</p> + */ + long RightMargin; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextColumnSequence.idl b/offapi/com/sun/star/text/TextColumnSequence.idl new file mode 100644 index 000000000..1b6d6e267 --- /dev/null +++ b/offapi/com/sun/star/text/TextColumnSequence.idl @@ -0,0 +1,34 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextColumnSequence_idl__ +#define __com_sun_star_text_TextColumnSequence_idl__ + +#include <com/sun/star/text/TextColumn.idl> + + +module com { module sun { module star { module text { + +published typedef sequence<TextColumn> TextColumnSequence; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextColumns.idl b/offapi/com/sun/star/text/TextColumns.idl new file mode 100644 index 000000000..52de4fef7 --- /dev/null +++ b/offapi/com/sun/star/text/TextColumns.idl @@ -0,0 +1,70 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextColumns_idl__ +#define __com_sun_star_text_TextColumns_idl__ + +#include <com/sun/star/text/XTextColumns.idl> +#include <com/sun/star/style/VerticalAlignment.idl> +#include <com/sun/star/util/Color.idl> + + + module com { module sun { module star { module text { + +/** provides access to columns in text (e.g., in TextFrames ). + */ +published service TextColumns +{ + interface com::sun::star::text::XTextColumns; + + /** determines whether the columns all have equal width. This flag is set if XTextColumns::setColumnCount() is called + and it is reset if XTextColumns::setColumns() is called. + */ + [readonly, property] boolean IsAutomatic; + /** contains the distance between the columns. It is valid if the property IsAutomatic is set. + <!-- The h -->Half of this distance is set to the left and right margins of all columns, + except for the left margin of the first column, and the right margin of the last column.*/ + [property] long AutomaticDistance; + /** determines the width of the separator lines between the columns. + */ + [property] long SeparatorLineWidth; + /** determines the color of the separator lines between the columns. + */ + [property] com::sun::star::util::Color SeparatorLineColor; + /** determines the relative height of the separator lines between the columns. + */ + [property] long SeparatorLineRelativeHeight; + /** determines the vertical alignment of the separator lines between the columns. + */ + [property] com::sun::star::style::VerticalAlignment SeparatorLineVerticalAlignment; + /** determines whether separator lines are on. + */ + [property] boolean SeparatorLineIsOn; + /** determines the style of the separator lines between the columns. + @see com::sun::star::text:ColumnSeparatorStyle + for the possible values. + */ + [property, optional] short SeparatorLineStyle; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextContent.idl b/offapi/com/sun/star/text/TextContent.idl new file mode 100644 index 000000000..50c494114 --- /dev/null +++ b/offapi/com/sun/star/text/TextContent.idl @@ -0,0 +1,78 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextContent_idl__ +#define __com_sun_star_text_TextContent_idl__ + +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/text/TextContentAnchorType.idl> +#include <com/sun/star/text/WrapTextMode.idl> + + + +module com { module sun { module star { module text { + +/** is an object which can be anchored in a text, like instances of + TextFrame or TextField. + + <p>If the concrete TextContent has a textual + representation which fades into the surrounding text, then + XTextField is used. + + <p>If the concrete TextContent has a "floating" object, + like a graphic, com::sun::star::drawing::XShape + is used. + + @see TextField + @see TextTable + @see TextFrame + @see TextSection + @see TextGraphicObject + @see TextEmbeddedObject +*/ +published service TextContent +{ + + /** This interface is used for the attachment of this text content + to the surrounding text. + */ + interface com::sun::star::text::XTextContent; + + /** specifies how the text content is attached to its surrounding + Text. + */ + [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; + + /** contains the anchor type of the text content. + @see com::sun::star::text::TextContentAnchorType + */ + [optional, readonly, property] sequence<com::sun::star::text::TextContentAnchorType> AnchorTypes; + + /** specifies if the text content is a shape + and how the text is wrapped around the shape. + */ + [optional, property] com::sun::star::text::WrapTextMode TextWrap; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextContentAnchorType.idl b/offapi/com/sun/star/text/TextContentAnchorType.idl new file mode 100644 index 000000000..247555293 --- /dev/null +++ b/offapi/com/sun/star/text/TextContentAnchorType.idl @@ -0,0 +1,72 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextContentAnchorType_idl__ +#define __com_sun_star_text_TextContentAnchorType_idl__ + + + + module com { module sun { module star { module text { + +/** specify how the text content is attached to its + surrounding text. + */ +published enum TextContentAnchorType +{ + /** The anchor of the object is set at the top left position of the paragraph. + */ + AT_PARAGRAPH, + + /** The object is anchored instead of a character. + + + + <p>The size of the object influences the height of the text line.</p> + */ + AS_CHARACTER, + + /** The object is anchored to the page. + + + + <p>The position does not change if the content of the document is changed.</p> + */ + AT_PAGE, + + /** The object is anchored to a text frame. + */ + AT_FRAME, + + /** The object is anchored to a character. + + + + <p>The position of the object changes if the position of this + character is changed. + </p> + */ + AT_CHARACTER + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextContentCollection.idl b/offapi/com/sun/star/text/TextContentCollection.idl new file mode 100644 index 000000000..b008f3edd --- /dev/null +++ b/offapi/com/sun/star/text/TextContentCollection.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextContentCollection_idl__ +#define __com_sun_star_text_TextContentCollection_idl__ + +#include <com/sun/star/container/XNameAccess.idl> + +#include <com/sun/star/container/XContainer.idl> + + + + module com { module sun { module star { module text { + +/** Objects of this type are collections of text contents of the same type.@see Text + */ +published service TextContentCollection +{ + + /** Each text content is accessible by its name, which is unique + within the collection. + */ + interface com::sun::star::container::XNameAccess; + + /** The insertion and removal of text contents of this type are + broadcasted via this interface. + */ + interface com::sun::star::container::XContainer; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextCursor.idl b/offapi/com/sun/star/text/TextCursor.idl new file mode 100644 index 000000000..864b12767 --- /dev/null +++ b/offapi/com/sun/star/text/TextCursor.idl @@ -0,0 +1,78 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextCursor_idl__ +#define __com_sun_star_text_TextCursor_idl__ + +#include <com/sun/star/text/TextRange.idl> +#include <com/sun/star/text/XTextCursor.idl> +#include <com/sun/star/text/XWordCursor.idl> +#include <com/sun/star/text/XSentenceCursor.idl> +#include <com/sun/star/text/XParagraphCursor.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/XPropertyState.idl> +#include <com/sun/star/beans/XMultiPropertyStates.idl> +#include <com/sun/star/document/XDocumentInsertable.idl> +#include <com/sun/star/util/XSortable.idl> + + + + module com { module sun { module star { module text { + +/** A TextCursor is a TextRange which can be moved + within a Text object. + @see TextRange + */ +published service TextCursor +{ + service com::sun::star::text::TextRange; + + interface com::sun::star::text::XTextCursor; + [optional] interface com::sun::star::text::XWordCursor; + [optional] interface com::sun::star::text::XSentenceCursor; + [optional] interface com::sun::star::text::XParagraphCursor; + + /** This interface gives access to the properties of the range that is + selected by the cursor. + */ + interface com::sun::star::beans::XPropertySet; + + /** This interface gives access to the state of the properties of the + range that is selected by the cursor. + */ + interface com::sun::star::beans::XPropertyState; + interface com::sun::star::beans::XMultiPropertyStates; + + /** This optional interface makes it possible to insert a document + from an external source at the cursor position. + */ + [optional] interface com::sun::star::document::XDocumentInsertable; + + /** This optional interface makes it possible to sort the contents at + the cursor position. + */ + [optional] interface com::sun::star::util::XSortable; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextDocument.idl b/offapi/com/sun/star/text/TextDocument.idl new file mode 100644 index 000000000..456b3e8f3 --- /dev/null +++ b/offapi/com/sun/star/text/TextDocument.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextDocument_idl__ +#define __com_sun_star_text_TextDocument_idl__ + +#include <com/sun/star/text/GenericTextDocument.idl> + + + module com { module sun { module star { module text { + + +/** Specify the document service of the text module. + */ +published service TextDocument +{ + /** Provides the functionality of such text document. */ + service GenericTextDocument; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextDocumentView.idl b/offapi/com/sun/star/text/TextDocumentView.idl new file mode 100644 index 000000000..220dc9ead --- /dev/null +++ b/offapi/com/sun/star/text/TextDocumentView.idl @@ -0,0 +1,98 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextDocumentView_idl__ +#define __com_sun_star_text_TextDocumentView_idl__ + +#include <com/sun/star/view/OfficeDocumentView.idl> + +#include <com/sun/star/view/XViewSettingsSupplier.idl> + +#include <com/sun/star/text/XTextViewCursorSupplier.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + + + module com { module sun { module star { module text { + + +/** specifies the view of a TextDocument. + */ +published service TextDocumentView +{ + service com::sun::star::view::OfficeDocumentView; + + + /** This interface permits access to the properties of the view. + */ + interface com::sun::star::view::XViewSettingsSupplier; + + + /** This interface makes it possible to access the cursor which belongs + to the view and can be visible for the user. + */ + interface com::sun::star::text::XTextViewCursorSupplier; + + + /** Gives access to the objects properties. + + @since OOo 2.0 + */ + [optional] interface com::sun::star::beans::XPropertySet; + + + /** returns the number of pages in the document + + <p>Since the document needs to be formatted to get the result + obtaining this value may take some time.</p> + + @since OOo 2.0 + */ + [optional, property, readonly] long PageCount; + + /** returns the number of lines in the document + + <p>Since the document needs to be formatted to get the result + obtaining this value may take some time.</p> + + <p>Empty paragraphs are not counted.</p> + + @since OOo 2.0 + */ + [optional, property, readonly] long LineCount; + + /** specifies if spell checking should be done while typing. + + @since OOo 2.0 + */ + [optional, property] boolean IsConstantSpellcheck; + + /** specifies if the marks for misspelled text should be displayed. + + @since OOo 2.0 + */ + [optional, property] boolean IsHideSpellMarks; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextEmbeddedObject.idl b/offapi/com/sun/star/text/TextEmbeddedObject.idl new file mode 100644 index 000000000..a6315e733 --- /dev/null +++ b/offapi/com/sun/star/text/TextEmbeddedObject.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextEmbeddedObject_idl__ +#define __com_sun_star_text_TextEmbeddedObject_idl__ + +#include <com/sun/star/document/XEmbeddedObjectSupplier.idl> +#include <com/sun/star/text/BaseFrame.idl> +#include <com/sun/star/frame/XModel.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the properties and methods of an embedded object. + */ +published service TextEmbeddedObject +{ + /** contains the definition of interfaces and properties that are supported by text frames, + graphic objects and embedded objects. + */ + service BaseFrame; + interface com::sun::star::document::XEmbeddedObjectSupplier; + /* If you get this property you get the CLSID of the OLE2 document stream + contained in this OLE2 shape. If you set it, an empty OLE2 document stream + with this CLSID is created within this OLE2 shape. + The property can only be set as long as the object is not inserted into the document. + */ + [property] string CLSID; + + /** This is the model for the OLE2 object. + <p>This property if void if the OLE2 is not an + Office component.</p> + + */ + [readonly, maybevoid, property] com::sun::star::frame::XModel Model; + + /** This is the component for the OLE2 object. + + */ + [readonly, maybevoid, property] com::sun::star::lang::XComponent Component; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextEmbeddedObjects.idl b/offapi/com/sun/star/text/TextEmbeddedObjects.idl new file mode 100644 index 000000000..a92093148 --- /dev/null +++ b/offapi/com/sun/star/text/TextEmbeddedObjects.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextEmbeddedObjects_idl__ +#define __com_sun_star_text_TextEmbeddedObjects_idl__ + +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + + +/** provides access to all embedded objects in a document. + */ +published service TextEmbeddedObjects +{ + /** This interface makes it possible to access all TextEmbeddedObject + instances within this context (e.g. a document) by its name. + + <p>The type of the interfaces returned by this collection is + always "XTextContent". + */ + interface com::sun::star::container::XNameAccess; + + /** This interface makes it possible to access all TextEmbeddedObject + instances within this context (e.g. a document) by its index. + + <p>The type of the interfaces returned by this collection is + always "XTextContent". + */ + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextField.idl b/offapi/com/sun/star/text/TextField.idl new file mode 100644 index 000000000..5499792b8 --- /dev/null +++ b/offapi/com/sun/star/text/TextField.idl @@ -0,0 +1,84 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextField_idl__ +#define __com_sun_star_text_TextField_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/XTextField.idl> + + + + module com { module sun { module star { module text { + + +/** A TextField is a TextContent which fades its + textual representation into the text range to which it is anchored. + */ +published service TextField +{ + service com::sun::star::text::TextContent; + + + /** This interface is used to access the textual representation of + this field. + */ + interface com::sun::star::text::XTextField; + + /** makes it possible to access the properties of the field, if any. + */ + [optional] interface com::sun::star::beans::XPropertySet; + + + /** specifies if the text field is actually used in the document. + + <p>Not all available text fields are used, for example fields + that are part of unused styles.</p> + + @since OOo 2.0.1 + */ + [optional, property, readonly] boolean IsFieldUsed; + + + /** specifies if the text field is actually displayed. + + <p>Not all available text fields are actually displayed + even when they are used. For example hidden fields or fields + in hidden text are used in the document but get not displayed.</p> + + @since OOo 2.0.1 + */ + [optional, property, readonly] boolean IsFieldDisplayed; + + /** Contains short title for the field, used to for tooltip purposes if it's non-empty. + + @since LibreOffice 7.4 + */ + [optional, property] string Title; + + +}; + + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFieldEnumeration.idl b/offapi/com/sun/star/text/TextFieldEnumeration.idl new file mode 100644 index 000000000..0daff6853 --- /dev/null +++ b/offapi/com/sun/star/text/TextFieldEnumeration.idl @@ -0,0 +1,43 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFieldEnumeration_idl__ +#define __com_sun_star_text_TextFieldEnumeration_idl__ + +#include <com/sun/star/container/XEnumeration.idl> + + + + module com { module sun { module star { module text { + + +/** This interface creates an enumeration of all text fields within a text document. + */ +published service TextFieldEnumeration +{ + /** This interface provides access to the text fields in a text document. + */ + interface ::com::sun::star::container::XEnumeration; +}; + + +}; }; }; }; +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFieldMaster.idl b/offapi/com/sun/star/text/TextFieldMaster.idl new file mode 100644 index 000000000..0de4c0ab5 --- /dev/null +++ b/offapi/com/sun/star/text/TextFieldMaster.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFieldMaster_idl__ +#define __com_sun_star_text_TextFieldMaster_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/text/XDependentTextField.idl> + + + module com { module sun { module star { module text { + + +/** A TextFieldMaster specifies important data for its + DependentTextFields. + */ +published service TextFieldMaster +{ + /** This optional interface makes it possible to access properties of + this field master, if any. + */ + [optional] interface com::sun::star::beans::XPropertySet; + /** determines the name of the field master. The name is void as long as the + instance is not member of the document structure. When the value is being set + the instance is inserted into the document and the name cannot be changed afterwards. + That does not apply to the Database text field master. + */ + [optional, property] string Name; + /** contains a sequence of all fields that depend on this master. + */ + [readonly, property] sequence< XDependentTextField> DependentTextFields; + /** contains the instance name as it is used in the + ::com::sun::star::text::XTextFieldsSupplier. + */ + [readonly, property] string InstanceName; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFieldMasters.idl b/offapi/com/sun/star/text/TextFieldMasters.idl new file mode 100644 index 000000000..b4491ca85 --- /dev/null +++ b/offapi/com/sun/star/text/TextFieldMasters.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFieldMasters_idl__ +#define __com_sun_star_text_TextFieldMasters_idl__ + +#include <com/sun/star/container/XNameAccess.idl> + + + module com { module sun { module star { module text { + +/** This is a collection of instances of TextFieldMaster, defined + in a context (e.g. in a document). + */ +published service TextFieldMasters +{ + + /** This interface makes it possible to access the instances of service + TextFieldMaster defined in this context (e.g. this + document). + + @see TextFieldMaster + */ + interface com::sun::star::container::XNameAccess; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFields.idl b/offapi/com/sun/star/text/TextFields.idl new file mode 100644 index 000000000..d16106cdc --- /dev/null +++ b/offapi/com/sun/star/text/TextFields.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFields_idl__ +#define __com_sun_star_text_TextFields_idl__ + +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/util/XRefreshable.idl> + + + module com { module sun { module star { module text { + +/** This is a collection of TextField instances. + */ +published service TextFields +{ + /** This interface makes it possible to create an enumeration through + all text fields in this container. + + <p>All elements are of type XTextField.</p> + */ + interface com::sun::star::container::XEnumerationAccess; + + + /** makes it possible to refresh (recalculate etc.) all fields. + */ + interface com::sun::star::util::XRefreshable; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFrame.idl b/offapi/com/sun/star/text/TextFrame.idl new file mode 100644 index 000000000..44f4139d9 --- /dev/null +++ b/offapi/com/sun/star/text/TextFrame.idl @@ -0,0 +1,160 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFrame_idl__ +#define __com_sun_star_text_TextFrame_idl__ + +#include <com/sun/star/text/XTextFrame.idl> +#include <com/sun/star/text/BaseFrame.idl> + + + module com { module sun { module star { module text { + + +/** specifies a rectangular shape which contains a Text object + and is attached to a piece of surrounding Text. + + @see Text + + <p>This example shows how to create a TextFrame and insert + it at the very beginning of Text component. The macro + is ready to run, if it is a script within a text document. </p> + + @code{.bas} + Sub Main + oFrame = ThisComponent.createInstance( "com.sun.star.text.TextFrame" ) + oFrame.Width = 6000 + ThisComponent.Text.insertTextContent( ThisComponent.Text.Start, oFrame, false ) + oFrame.Text.String = "Hello, this text is within the frame." + End Sub + @endcode + */ +published service TextFrame +{ + /** contains the definition of interfaces and properties that are supported by text frames, + graphic objects and embedded objects. + */ + service BaseFrame; + + /** This interface makes it possible to access the text within this + text frame. + */ + interface com::sun::star::text::XTextFrame; + /** contains the metric height value of the frame. + */ + [property] long FrameHeightAbsolute; + + /** contains the metric width value of the frame. + */ + [property] long FrameWidthAbsolute; + + + /** specifies a width relative to the width of the + surrounding text. + <p>If the value for "WidthPercent" is 0, the absolute value from + is used.</p> + */ + [property] byte FrameWidthPercent; + + /** specifies a width relative to the width of the + surrounding text. + + <p>If the value for "HeightPercent" is 0, the absolute value from + is used.</p> + */ + [property] byte FrameHeightPercent; + /** If "AutomaticHeight" is set, then the object grows if it is required + by the frame content. + */ + [property] boolean FrameIsAutomaticHeight; + /** determines the interpretation of the height and relative + height properties. + + @see SizeType + */ + [property] short SizeType; + /** determines if the text frame should be editable in a read-only document. + (This is usually used in forms.) + + */ + [optional, property] boolean EditInReadonly; + + /** determines the interpretation of the width and relative + width properties. + + @see SizeType + @since OOo 2.4 + */ + [optional, property] short WidthType; + + /** contains the writing direction, as represented by the + com::sun::star::text::WritingMode2 constants + */ + [optional, property] short WritingMode; + + /** controls, if the frame follows the text flow or can leave its layout environment + + <p>If set, the frame follows the text flow and doesn't leaves the layout + environment, which is given by its anchor, above and below. + E.g.: Anchor resides in the document body then the frame doesn't leave + the document body above and below and follows the text flow through + the document bodies of the different pages. + + If not set, the frame doesn't follow the text flow and stays on the page, + on which its anchor is found, but it may leave the layout environment, + which is given by its anchor. + E.g.: Anchor resides in the document body then the frame stays on page, + where this document body is, but it could leave the document body above + and below, e.g. overlapping with the page header. + + Note: The areas for the vertical orientation relation at page areas are + interpreted in dependence to this property (@see BaseFrameProperties.VertOrientRelation). + If property is set, the page area is interpreted as the layout environment, + given by its anchor. E.g.: Anchor resides in the page header then the + page header determines the page area. If property isn't set, the page area is + determined by the document page, the anchor is on. E.g.: Anchor resides + in the page header then the document page, the page header is on, determines + the page area. + An exception of this interpretation rule is applied, if the anchor resides + in a table cell. In this situation the page area is always determined by + the table cell.</p> + */ + [optional, property] boolean IsFollowingTextFlow; + + /** adjusts the vertical position of the text inside of the frame. + + @see com::sun::star::drawing::TextVerticalAdjust + @since LibreOffice 4.3 + */ + [optional, property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust; + + /** Parent text of this text frame. + + This might be a header text, body text, etc. + + @since LibreOffice 6.3 + */ + [optional, readonly, property] com::sun::star::text::XText ParentText; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextFrames.idl b/offapi/com/sun/star/text/TextFrames.idl new file mode 100644 index 000000000..cce2b872d --- /dev/null +++ b/offapi/com/sun/star/text/TextFrames.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextFrames_idl__ +#define __com_sun_star_text_TextFrames_idl__ + +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/XContainer.idl> + + + + module com { module sun { module star { module text { + +/** This is the collection of all TextFrame instances within a + context (e.g. a document). + */ +published service TextFrames +{ + + /** This interface makes it possible to access all TextFrame + instances within this context (e.g. a document) by its name. + + <p>The type of the interfaces returned by this collection is + always "XTextFrame". + */ + interface com::sun::star::container::XNameAccess; + /** This interface makes it possible to access all TextFrame + instances within this context (e.g. a document) by its index. + + <p>The type of the interfaces returned by this collection is + always "XTextFrame". + */ + interface com::sun::star::container::XIndexAccess; + + /** This optional interface makes it possible to register for events + which occur upon insertion and removal of TextFrame + instances. + */ + [optional] interface com::sun::star::container::XContainer; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextGraphicObject.idl b/offapi/com/sun/star/text/TextGraphicObject.idl new file mode 100644 index 000000000..02f9c3060 --- /dev/null +++ b/offapi/com/sun/star/text/TextGraphicObject.idl @@ -0,0 +1,142 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextGraphicObject_idl__ +#define __com_sun_star_text_TextGraphicObject_idl__ + +#include <com/sun/star/text/BaseFrame.idl> +#include <com/sun/star/text/GraphicCrop.idl> +#include <com/sun/star/drawing/PointSequenceSequence.idl> +#include <com/sun/star/drawing/ColorMode.idl> +#include <com/sun/star/container/XIndexContainer.idl> +#include <com/sun/star/graphic/XGraphic.idl> + + + module com { module sun { module star { module text { + + +/** specifies a graphic which can be embedded in Text. + */ +published service TextGraphicObject +{ + /** contains the definition of interfaces and properties that are supported by text frames, + graphic objects and embedded objects. + */ + service BaseFrame; + /** returns the client-side image map if one is assigned to the object. + */ + [property] com::sun::star::container::XIndexContainer ImageMap; + + + /** determines if the content is protected against changes from the user interface. + */ + [property] boolean ContentProtected; + + + /** determines if the text wraps around the contour of the object. + */ + [property] boolean SurroundContour; + + /** the text flows only around the contour of the object. + */ + [property] boolean ContourOutside; + /** contains the contour of the object as PolyPolygon. + */ + [optional, property] com::sun::star::drawing::PointSequenceSequence ContourPolyPolygon; + + /** contains the cropping of the object.@see GraphicCrop + */ + [property] com::sun::star::text::GraphicCrop GraphicCrop; + + /** determines if the object is horizontally mirrored on even pages. + */ + [property] boolean HoriMirroredOnEvenPages; + /** determines if the object is horizontally mirrored on odd pages. + */ + [property] boolean HoriMirroredOnOddPages; + /** determines if the object is mirrored vertically. + */ + [property] boolean VertMirrored; + + /** contains the URL of the background graphic of the object + + @deprecated as of LibreOffice 6.1 - use Graphic instead + + Note the new behaviour since it was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When a + URL is set, then it will load the image and set the Graphic + property. + */ + [property] string GraphicURL; + + + /** contains the name of the filter of the background graphic of the object. + */ + [property] string GraphicFilter; + + /** contains the original size of the bitmap in the graphic object. + */ + [property] com::sun::star::awt::Size ActualSize; + /** changes the display of the luminance. + It contains percentage values between -100 and +100. + */ + [property] short AdjustLuminance; + /** changes the display of contrast. + It contains percentage values between -100 and +100. + */ + [property] short AdjustContrast; + /** changes the display of the red color channel. + It contains percentage values between -100 and +100. + */ + [property] short AdjustRed; + /** changes the display of the green color channel. + It contains percentage values between -100 and +100. + */ + [property] short AdjustGreen; + /** changes the display of the blue color channel. + It contains percentage values between -100 and +100. + */ + [property] short AdjustBlue; + /** determines the gamma value of the graphic. + */ + [property] double Gamma; + /** determines if the graphic is display in inverted colors. + It contains percentage values between -100 and +100. + */ + [property] boolean GraphicIsInverted; + + /** contains percentage values between -100 and +100. + */ + [property] short Transparency; + /** contains the ColorMode as com::sun::star::drawing::ColorMode. + */ + [property] com::sun::star::drawing::ColorMode GraphicColorMode; + + /** contains the background graphic of the object. + */ + [optional, property] com::sun::star::graphic::XGraphic Graphic; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextGraphicObjects.idl b/offapi/com/sun/star/text/TextGraphicObjects.idl new file mode 100644 index 000000000..4a153c58d --- /dev/null +++ b/offapi/com/sun/star/text/TextGraphicObjects.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextGraphicObjects_idl__ +#define __com_sun_star_text_TextGraphicObjects_idl__ + +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + + +/** This is the collection of all TextGraphicObject instances within a + context (e.g. a document). + */ +published service TextGraphicObjects +{ + + + /** This interface makes it possible to access all TextGraphicObject + instances within this context (e.g. a document) by its name. + + <p>The type of the interfaces returned by this collection is + always "XTextContent". + */ + interface com::sun::star::container::XNameAccess; + /** This interface makes it possible to access all TextGraphicObject + instances within this context (e.g. a document) by its index. + + <p>The type of the interfaces returned by this collection is + always "XTextContent". + */ + interface com::sun::star::container::XIndexAccess; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextGridMode.idl b/offapi/com/sun/star/text/TextGridMode.idl new file mode 100644 index 000000000..b73c65b36 --- /dev/null +++ b/offapi/com/sun/star/text/TextGridMode.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextGridMode_idl__ +#define __com_sun_star_text_TextGridMode_idl__ + + + + module com { module sun { module star { module text { + + +/** this set of constants describes different modes for text grids + */ +published constants TextGridMode +{ + + /** no text grid */ + const short NONE = 0; + + + /** line positions will be determined by the grid */ + const short LINES = 1; + + + /** character and line positions will be determined by the grid */ + const short LINES_AND_CHARS = 2; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextLayoutCursor.idl b/offapi/com/sun/star/text/TextLayoutCursor.idl new file mode 100644 index 000000000..7171b4db6 --- /dev/null +++ b/offapi/com/sun/star/text/TextLayoutCursor.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextLayoutCursor_idl__ +#define __com_sun_star_text_TextLayoutCursor_idl__ + +#include <com/sun/star/text/TextCursor.idl> +#include <com/sun/star/text/XPageCursor.idl> + + + + module com { module sun { module star { module text { + +/** A TextLayoutCursor is a TextRange which can + travel within a layout of a Text object. + */ +published service TextLayoutCursor +{ + service com::sun::star::text::TextCursor; + interface com::sun::star::text::XPageCursor; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextMarkupDescriptor.idl b/offapi/com/sun/star/text/TextMarkupDescriptor.idl new file mode 100644 index 000000000..2afd054a7 --- /dev/null +++ b/offapi/com/sun/star/text/TextMarkupDescriptor.idl @@ -0,0 +1,67 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TextMarkupDescriptor_idl__ +#define __com_sun_star_text_TextMarkupDescriptor_idl__ + +#include <com/sun/star/container/XStringKeyMap.idl> +#include <com/sun/star/text/TextMarkupType.idl> + + + +module com { module sun { module star { module text { + + +/** A descriptor for a single text markup. + + @since OOo 3.0.1 + */ + +struct TextMarkupDescriptor +{ + /// Type of text markup see TextMarkupType + long nType; + + /// A string used to identify the caller + string aIdentifier; + + /// Start of the markup range + long nOffset; + + /// Length of the markup range + long nLength; + + /** contains additional information about the markup + + Supported properties: + + nType | aKey + ------------------------- | ------------- + PROOFREADING or SMARTTAG | "LineColor": changes the markup color from default to RGB aValue (int32) + PROOFREADING or SMARTTAG | "LineType": changes the underlining style to aValue (short): WAVE, DASH + | @since 6.3: BOLDWAVE, BOLD + | See: com::sun::star::awt::FontUnderline + */ + com::sun::star::container::XStringKeyMap xMarkupInfoContainer; +}; + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextMarkupType.idl b/offapi/com/sun/star/text/TextMarkupType.idl new file mode 100644 index 000000000..18ba4e698 --- /dev/null +++ b/offapi/com/sun/star/text/TextMarkupType.idl @@ -0,0 +1,67 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TextMarkupType_idl__ +#define __com_sun_star_text_TextMarkupType_idl__ + + +module com { module sun { module star { module text { + + +/** Constants to specify the type of text markup. + + <p>These constants are used with + XTextMarkup::commitTextMarkup()</p> + + @since OOo 2.3 + */ + +constants TextMarkupType +{ + /** Markup originates from spell checking. + */ + const long SPELLCHECK = 1; + + /** Markup originates from proofreading + @since OOo 3.0.1 + */ + const long PROOFREADING = 2; + + /** Markup originates from smart tag checking. + */ + const long SMARTTAG = 3; + + /** Markup originates from proofreading + An invisible markup type used in proofreading API calls. + @since OOo 3.0.1 + */ + const long SENTENCE = 4; + + /** Markups originates from change tracking. + @since OOo 3.3 + */ + const long TRACK_CHANGE_INSERTION = 5; + const long TRACK_CHANGE_DELETION = 6; + const long TRACK_CHANGE_FORMATCHANGE = 7; +}; + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextPageStyle.idl b/offapi/com/sun/star/text/TextPageStyle.idl new file mode 100644 index 000000000..de53e775b --- /dev/null +++ b/offapi/com/sun/star/text/TextPageStyle.idl @@ -0,0 +1,173 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TextPageStyle_idl__ +#define __com_sun_star_text_TextPageStyle_idl__ + +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/table/ShadowFormat.idl> +#include <com/sun/star/table/BorderLine.idl> +#include <com/sun/star/style/PageStyleLayout.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/awt/Size.idl> +#include <com/sun/star/text/XText.idl> +#include <com/sun/star/text/XTextColumns.idl> +#include <com/sun/star/container/XNameContainer.idl> + + +module com { module sun { module star { module text { + + +/** represents a page style for a text document. + + <p>This service extends the service + com::sun::star::style::PageStyle with specific + properties for text documents.</p> + */ +published service TextPageStyle +{ + + /** determines whether the register mode is active on that page. + */ + [property] boolean RegisterModeActive; + + + /** contains the name of the paragraph style that is used as + reference of the register mode. + */ + [property] string RegisterParagraphStyle; + + + /** contains the column settings of the page. + */ + [property] com::sun::star::text::XTextColumns TextColumns; + + + /** contains the interface to the text of the header. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderText; + + + /** contains the interface to the text of the header of left pages. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderTextLeft; + + + /** contains the interface to the text of the header of right pages. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderTextRight; + + + /** contains the interface to the text of the header of first pages. + + @see com::sun::star::text::Text + + @since LibreOffice 4.0 + */ + [optional, property] com::sun::star::text::XText HeaderTextFirst; + + + /** contains the interface to the text of the footer. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterText; + + + /** contains the interface to the text of the footer of a left page. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterTextLeft; + + + /** contains the interface to the text of the footer of a right page. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterTextRight; + + + /** contains the interface to the text of the footer of a first page. + + @see com::sun::star::text::Text + + @since LibreOffice 4.0 + */ + [optional, property] com::sun::star::text::XText FooterTextFirst; + + + /** contains the maximum height of the footnote area (in 1/100 mm). + + <p>If set to zero, the height of the current page is used as limit.</p> + */ + [property] long FootnoteHeight; + + + /** contains the weight of the separator line between the text and + the footnote area (in 1/100 mm). + */ + [property] short FootnoteLineWeight; + + + /** contains the color of the separator line between the text and + the footnote area. + */ + [property] com::sun::star::util::Color FootnoteLineColor; + + + /** contains the relative width of the separator line between the + text and the footnote area (in percent). + */ + [property] byte FootnoteLineRelativeWidth; + + + /** contains the adjustment of the separator line between the text + and the footnote area. + + @see com::sun::star::text::HorizontalAdjust + */ + [property] short FootnoteLineAdjust; + + + /** contains the distance between the text and the separator line + between the text and the footnote area (in 1/100 mm). + */ + [property] long FootnoteLineTextDistance; + + + /** contains the distance between the footnote area and the separator + line between the text and the footnote area (in 1/100 mm). + */ + [property] long FootnoteLineDistance; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextPortion.idl b/offapi/com/sun/star/text/TextPortion.idl new file mode 100644 index 000000000..3d490c3de --- /dev/null +++ b/offapi/com/sun/star/text/TextPortion.idl @@ -0,0 +1,139 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextPortion_idl__ +#define __com_sun_star_text_TextPortion_idl__ + + +#include <com/sun/star/beans/XTolerantMultiPropertySet.idl> +#include <com/sun/star/container/XContentEnumerationAccess.idl> +#include <com/sun/star/text/TextRange.idl> +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/text/XTextField.idl> +#include <com/sun/star/text/XFootnote.idl> + + + +module com { module sun { module star { module text { + +/** A TextPortion is a piece of text within a paragraph that does not + contain changes of its attributes inside. + + <p> + It is created by an enumeration implemented in a paragraph service. + It may be used to export the content of the paragraph to an external + document format. + </p> + + @see com::sun::star::text::TextPortionEnumeration + @see com::sun::star::text::XTextPortionEnumeration +*/ +published service TextPortion +{ + service ::com::sun::star::text::TextRange; + + /** contains text frames, graphic objects, embedded objects or + shapes that are anchored at or as character. + @see com::sun::star::text::TextFrame + @see com::sun::star::text::TextGraphicObject + */ + [optional] + interface ::com::sun::star::container::XContentEnumerationAccess; + + /** gives access to a sequence of properties. + @since OOo 2.0 + */ + [optional] + interface ::com::sun::star::beans::XTolerantMultiPropertySet; + + /** contains the type of the text portion. + + <p> Valid content type names are:</p> + <dl> + <dt>Text</dt><dd>string content</dd> + <dt>TextField</dt><dd>a text field</dd> + <dt>TextContent</dt><dd>text content - supplied via the + interface com::sun::star::container::XContentEnumerationAccess</dd> + <dt>ControlCharacter</dt><dd>a control character</dd> + <dt>Footnote</dt><dd>a footnote or an endnote</dd> + <dt>ReferenceMark</dt><dd>a reference mark</dd> + <dt>DocumentIndexMark</dt><dd>a document index mark</dd> + <dt>Bookmark</dt><dd>a bookmark</dd> + <dt>Redline</dt><dd>a redline portion which is a result + of the change tracking feature</dd> + <dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd> + <dt>Frame</dt><dd>a frame</dd> + <dt>SoftPageBreak</dt><dd>a soft page break</dd> + <dt>InContentMetadata</dt><dd>a text range with attached metadata</dd> + </dl> + <p>For Reference marks, document index marks, etc., 2 text portions + will be generated, one for the start position and one for the + end position.</p> + */ + [readonly, property] string TextPortionType; + + /** contains the control character of a text portion of type + ControlCharacter. + @deprecated type ControlCharacter no longer implemented + */ + [readonly, property] short ControlCharacter; + + /** contains the bookmark of a text portion of type Bookmark. */ + [optional, readonly, property] + ::com::sun::star::text::XTextContent Bookmark; + + /** contains the document index mark of a text portion of type + DocumentIndexMark. */ + [optional, readonly, property] + ::com::sun::star::text::XTextContent DocumentIndexMark; + + /** contains the bookmark of a text portion of type ReferenceMark. */ + [optional, readonly, property] + ::com::sun::star::text::XTextContent ReferenceMark; + + /** contains the footnote of a text portion of type Footnote. */ + [optional, readonly, property] + ::com::sun::star::text::XFootnote Footnote; + + /** contains the text field of a text portion of type TextField. */ + [optional, readonly, property] + ::com::sun::star::text::XTextField TextField; + + /** contains the text range of a text portion of type InContentMetadata. + @since OOo 3.2 + */ + [optional, readonly, property] + ::com::sun::star::text::XTextContent InContentMetadata; + + /** contains whether the portion is a point only. */ + [optional, readonly, property] boolean IsCollapsed; + + /** contains whether the portion is the start of the portion. + + <p>This is used for portions which are represented by + 2 TextPortion objects (e.g., DocmentIndexMark).</p> + */ + [optional, readonly, property] boolean IsStart; + +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextPortionEnumeration.idl b/offapi/com/sun/star/text/TextPortionEnumeration.idl new file mode 100644 index 000000000..d7c934b1d --- /dev/null +++ b/offapi/com/sun/star/text/TextPortionEnumeration.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextPortionEnumeration_idl__ +#define __com_sun_star_text_TextPortionEnumeration_idl__ + +#include <com/sun/star/container/XEnumeration.idl> + + + + module com { module sun { module star { module text { + + +/** This interface creates an enumeration of paragraph within a text document. + The elements created by this enumeration contains either parts of text with + equal properties or text content elements like text fields, reference marks or bookmarks. + */ +published service TextPortionEnumeration +{ + /** This interface provides access to the elements of a paragraph in a text document. + */ + interface ::com::sun::star::container::XEnumeration; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextPosition.idl b/offapi/com/sun/star/text/TextPosition.idl new file mode 100644 index 000000000..deba3b67c --- /dev/null +++ b/offapi/com/sun/star/text/TextPosition.idl @@ -0,0 +1,26 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_text_TextPosition_idl__ +#define __com_sun_star_text_TextPosition_idl__ + +module com { module sun { module star { module text { + +struct TextPosition +{ + long Paragraph; + + long PositionInParagraph; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextRange.idl b/offapi/com/sun/star/text/TextRange.idl new file mode 100644 index 000000000..7619fa756 --- /dev/null +++ b/offapi/com/sun/star/text/TextRange.idl @@ -0,0 +1,79 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextRange_idl__ +#define __com_sun_star_text_TextRange_idl__ + +#include <com/sun/star/text/XTextRange.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/XPropertyState.idl> +#include <com/sun/star/style/CharacterProperties.idl> +#include <com/sun/star/style/ParagraphProperties.idl> +#include <com/sun/star/style/ParagraphPropertiesAsian.idl> +#include <com/sun/star/style/ParagraphPropertiesComplex.idl> +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#include <com/sun/star/container/XContentEnumerationAccess.idl> + + +module com { module sun { module star { module text { + + +/** points to a sequence of characters within a Text. + + <p>The service provides access to the string content and the properties + of this range of text and the TextContent instances which + are bound to this text range. </p> + + <p>A TextRange is also used for a <i>text portion</i> which is + returned by the com::sun::star::container::XEnumeration + for a single paragraph. Because this is the mechanism to use to export + data, all formatting attributes and contents bound to this range have + to be available from implementations of this service. </p> + + @see Text + */ +published service TextRange +{ + interface com::sun::star::text::XTextRange; + + interface com::sun::star::beans::XPropertySet; + + interface com::sun::star::beans::XPropertyState; + + [optional] interface com::sun::star::container::XContentEnumerationAccess; + + service com::sun::star::style::CharacterProperties; + + [optional] service com::sun::star::style::CharacterPropertiesAsian; + + [optional] service com::sun::star::style::CharacterPropertiesComplex; + + service com::sun::star::style::ParagraphProperties; + + [optional] service com::sun::star::style::ParagraphPropertiesAsian; + + [optional] service com::sun::star::style::ParagraphPropertiesComplex; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextRangeContentProperties.idl b/offapi/com/sun/star/text/TextRangeContentProperties.idl new file mode 100644 index 000000000..d79d1dfcf --- /dev/null +++ b/offapi/com/sun/star/text/TextRangeContentProperties.idl @@ -0,0 +1,97 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TextRangeContentProperties_idl__ +#define __com_sun_star_text_TextRangeContentProperties_idl__ + +#include <com/sun/star/table/XCell.idl> +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/text/XDocumentIndex.idl> +#include <com/sun/star/text/XTextTable.idl> +#include <com/sun/star/text/XTextFrame.idl> +#include <com/sun/star/text/XTextSection.idl> +#include <com/sun/star/text/XDocumentIndexMark.idl> +#include <com/sun/star/text/XFootnote.idl> + + + +module com { module sun { module star { module text { + + +/** describes the structural properties to retrieve text contents. + + @since OOo 3.3 + */ +service TextRangeContentProperties +{ + /** may contain a document index. */ + [optional, readonly, property] com::sun::star::text::XDocumentIndex + DocumentIndex; + + /** may contain a text table. */ + [optional, readonly, property] com::sun::star::text::XTextTable + TextTable; + + /** may contain a table cell. */ + [optional, readonly, property] com::sun::star::table::XCell Cell; + + /** may contain a text frame. */ + [optional, readonly, property] com::sun::star::text::XTextFrame + TextFrame; + + /** may contain a text section. */ + [optional, readonly, property] com::sun::star::text::XTextSection + TextSection; + + /** may contain a document index mark. */ + [optional, readonly, property] com::sun::star::text::XDocumentIndexMark + DocumentIndexMark; + + /** may contain a reference mark. */ + [optional, readonly, property] com::sun::star::text::XTextContent + ReferenceMark; + + /** may contain a footnote. */ + [optional, readonly, property] com::sun::star::text::XFootnote Footnote; + + /** may contain an endnote. */ + [optional, readonly, property] com::sun::star::text::XFootnote Endnote; + + /** may contain a nested text content. + + For example, may contain an InContentMetadata or a + com::sun::star::text::textfield::MetadataField. + */ + [optional, readonly, property] com::sun::star::text::XTextContent + NestedTextContent; + + /** Paragraph for the start of this range. + + @since LibreOffice 6.0 + */ + [optional, readonly, property] com::sun::star::text::XTextContent TextParagraph; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextRangeSelection.idl b/offapi/com/sun/star/text/TextRangeSelection.idl new file mode 100644 index 000000000..44464f48d --- /dev/null +++ b/offapi/com/sun/star/text/TextRangeSelection.idl @@ -0,0 +1,28 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_text_TextRangeSelection_idl__ +#define __com_sun_star_text_TextRangeSelection_idl__ + +#include <com/sun/star/text/TextPosition.idl> + +module com { module sun { module star { module text { + +struct TextRangeSelection +{ + TextPosition Start; + + TextPosition End; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextRanges.idl b/offapi/com/sun/star/text/TextRanges.idl new file mode 100644 index 000000000..bbba659c4 --- /dev/null +++ b/offapi/com/sun/star/text/TextRanges.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextRanges_idl__ +#define __com_sun_star_text_TextRanges_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides a container for XTextRange objects. + */ +published service TextRanges +{ + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl new file mode 100644 index 000000000..c7911d1c2 --- /dev/null +++ b/offapi/com/sun/star/text/TextSection.idl @@ -0,0 +1,207 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextSection_idl__ +#define __com_sun_star_text_TextSection_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/XTextSection.idl> +#include <com/sun/star/container/XNamed.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/XPropertyState.idl> +#include <com/sun/star/text/SectionFileLink.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/text/XTextColumns.idl> +#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** A TextSection is a range of complete paragraphs within a text. + + <p>The content of the section may be the content of a link into another + document, a link from the same document, or the result of a DDE + operation. + + <p>TextSection instances can be linked from and to other + texts. + +*/ +published service TextSection +{ + service com::sun::star::text::TextContent; + + [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; + + interface com::sun::star::text::XTextSection; + interface com::sun::star::container::XNamed; + interface com::sun::star::beans::XPropertySet; + interface com::sun::star::beans::XPropertyState; + + /** This property contains a conditional expression. + + <p>If the result of the conditional expression is `TRUE` and the property + TextSection::IsVisible is `FALSE`, then the section is hidden.</p> + */ + [property] string Condition; + + /** If this property is `FALSE`, the text section is hidden. + */ + [property] boolean IsVisible; + + /** If this property is `TRUE`, the text section is protected + and cannot be modified from the user interface. + */ + [property] boolean IsProtected; + + /** If this property is set, then the content of the section is read + from the specified document. + + */ + [property] com::sun::star::text::SectionFileLink FileLink; + + /** specifies the source of a file link in the document that is + specified in TextSection::FileLink. + + <p>The source may be a text section or a bookmark. + If TextSection::FileLink is empty, then the + current document is searched for the source. If this property + is empty and TextSection::FileLink is set, + then the complete document content is linked into this section.</p> + */ + [property] string LinkRegion; + + /** specifies the type of the command string for a DDE operation. + <p>The type can be the name of the application that provides a DDE source.</p> + */ + [property] string DDECommandType; + + /** specifies the source file name of the command string for a DDE operation. + */ + [property] string DDECommandFile; + + /** specifies the source element of the command string for a DDE operation. + <p>The element can be i.e. a name of a cell in a sheet or a bookmark.</p> + */ + [property] string DDECommandElement; + + /** contains the URL for the background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the file filter for the background graphic. + */ + [property] string BackGraphicFilter; + + /** determines the position of the background graphic. + + @see GraphicLocation + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + /** determines whether footnotes inside the section are displayed at the end of the + section text. + */ + [property] boolean FootnoteIsCollectAtTextEnd; + /** determines whether the footnotes numbering restarts within the section. + This is only valid if <code>FootnoteIsRestartNumbering</code> is set. + */ + [property] boolean FootnoteIsRestartNumbering; + /** determines at which number the footnote numbering inside of the section starts. + This is only valid if <code>FootnoteIsRestartNumbering</code> is set. + */ + [property] short FootnoteRestartNumberingAt; + /** determines whether the footnotes within the section use an own numbering format. + This is only valid if <code>FootnoteIsRestartNumbering</code> is set. + */ + [property] boolean FootnoteIsOwnNumbering; + /** determines the numbering type of the footnote numbering as a value of + com::sun::star::style::NumberingType. + This is only valid if <code>FootnoteIsOwnNumbering</code> is set. + */ + [property] short FootnoteNumberingType; + /** determines the prefix that is display before the footnote number. + This is only valid if <code>FootnoteIsOwnNumbering</code> is set. + */ + [property] string FootnoteNumberingPrefix; + /** determines the suffix that is display after of the footnote number. + This is only valid if <code>FootnoteIsOwnNumbering</code> is set. + */ + [property] string FootnoteNumberingSuffix; + /** determines whether endnotes inside the section are displayed at the end of the + section text. + */ + [property] boolean EndnoteIsCollectAtTextEnd; + /** determines whether the endnotes numbering restarts within the section. + This is only valid if <code>EndnoteIsRestartNumbering</code> is set. + */ + [property] boolean EndnoteIsRestartNumbering; + /** determines at which number the endnote numbering inside of the section starts. + This is only valid if <code>EndnoteIsRestartNumbering</code> is set. + */ + [property] short EndnoteRestartNumberingAt; + /** determines whether the endnotes within the section use an own numbering format. + This is only valid if <code>EndnoteIsRestartNumbering</code> is set. + */ + [property] boolean EndnoteIsOwnNumbering; + /** determines the numbering type of the endnote numbering as a value of + com::sun::star::style::NumberingType. + This is only valid if <code>EndoteIsOwnNumbering</code> is set. + */ + [property] short EndnoteNumberingType; + /** determines the prefix that is display before the endnote number. + This is only valid if <code>EndnoteIsOwnNumbering</code> is set. + */ + [property] string EndnoteNumberingPrefix; + /** determines the suffix that is display after the endnote number. + This is only valid if <code>EndnoteIsOwnNumbering</code> is set. + */ + [property] string EndnoteNumberingSuffix; + /** determines if a DDE link is updated automatically. + */ + [property] boolean IsAutomaticUpdate; + /** allows columns to be set into the text section + */ + [property] com::sun::star::text::XTextColumns TextColumns; + /** determines the left margin of the section + */ + [optional, property] long SectionLeftMargin; + /** determines the left margin of the section + */ + [optional, property] long SectionRightMargin; + + /** contains the graphic of the background. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextSections.idl b/offapi/com/sun/star/text/TextSections.idl new file mode 100644 index 000000000..06dd8f169 --- /dev/null +++ b/offapi/com/sun/star/text/TextSections.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextSections_idl__ +#define __com_sun_star_text_TextSections_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the text sections in a text document. + */ +published service TextSections +{ + interface com::sun::star::container::XIndexAccess; + interface com::sun::star::container::XNameAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextSortDescriptor.idl b/offapi/com/sun/star/text/TextSortDescriptor.idl new file mode 100644 index 000000000..7f901dabe --- /dev/null +++ b/offapi/com/sun/star/text/TextSortDescriptor.idl @@ -0,0 +1,93 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextSortDescriptor_idl__ +#define __com_sun_star_text_TextSortDescriptor_idl__ + +#include <com/sun/star/util/SortDescriptor.idl> + + + + module com { module sun { module star { module text { + +/** describes sort criteria for sorting text. + + @deprecated + */ +published service TextSortDescriptor +{ + service com::sun::star::util::SortDescriptor; + + /** contains the character that marks the separation of columns. + */ + [property] char Delimiter; + + /** determines if the content of a table is to be sorted. + */ + [property] boolean IsSortInTable; + + /** contains the row or column index used in the first search key. + */ + [property] long SortRowOrColumnNo0; + + /** determines if the sorting in the first search key is done + numeric or alphanumeric order. + */ + [property] boolean IsSortNumeric0; + + /** determines if the sorting in the first search key is done + in ascending or descending order. + */ + [property] boolean IsSortAscending0; + + /** contains the row or column index used in the second search key. + */ + [property] long SortRowOrColumnNo1; + + /** determines if the sorting in the second search key is done + in numeric or alphanumeric order. + */ + [property] boolean IsSortNumeric1; + + /** determines if the sorting in the second search key is done + in ascending or descending order. + */ + [property] boolean IsSortAscending1; + + /** contains the row or column index used in the third search key. + */ + [property] long SortRowOrColumnNo2; + + /** determines if the sorting in the third search key is done + in numeric or alphanumeric order. + */ + [property] boolean IsSortNumeric2; + + /** determines if the sorting in the third search key is done + in ascending or descending order. + */ + [property] boolean IsSortAscending2; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextSortDescriptor2.idl b/offapi/com/sun/star/text/TextSortDescriptor2.idl new file mode 100644 index 000000000..f9f89fb46 --- /dev/null +++ b/offapi/com/sun/star/text/TextSortDescriptor2.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextSortDescriptor2_idl__ +#define __com_sun_star_text_TextSortDescriptor2_idl__ + +#include <com/sun/star/table/TableSortDescriptor2.idl> +#include <com/sun/star/table/TableSortField.idl> +#include <com/sun/star/table/TableSortFieldType.idl> + + + + module com { module sun { module star { module text { + + +/** describes sort criteria for sorting paragraphs or table contents in + a text document. + + @since OOo 1.1.2 + */ +published service TextSortDescriptor2 +{ + service com::sun::star::table::TableSortDescriptor2; + + /** determines if the content of a table or a selection of + paragraphs is to be sorted. + */ + [property] boolean IsSortInTable; + + /** contains the character that marks the column separator + when a selection of paragraphs is to be sorted. + */ + [property] char Delimiter; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextSortable.idl b/offapi/com/sun/star/text/TextSortable.idl new file mode 100644 index 000000000..c1b7afb1d --- /dev/null +++ b/offapi/com/sun/star/text/TextSortable.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextSortable_idl__ +#define __com_sun_star_text_TextSortable_idl__ + +#include <com/sun/star/text/TextSortDescriptor.idl> +#include <com/sun/star/util/XSortable.idl> + + + +module com { module sun { module star { module text { + + +/** provides an interface for sorting. + + @deprecated + + @since OOo 1.1.2 + + */ +published service TextSortable +{ + /** the properties returned by a call to the "createSortDescriptor" method + of this interfaces implementation are those of the + "com.sun.star.text.TextSortDescriptor" service. + + @see com::sun::star::text::TextSortDescriptor + */ + interface com::sun::star::util::XSortable; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextTable.idl b/offapi/com/sun/star/text/TextTable.idl new file mode 100644 index 000000000..bbcb4c1fa --- /dev/null +++ b/offapi/com/sun/star/text/TextTable.idl @@ -0,0 +1,248 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_TextTable_idl__ +#define __com_sun_star_text_TextTable_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/text/XTextTable.idl> +#include <com/sun/star/text/TableColumnSeparator.idl> +#include <com/sun/star/container/XNamed.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/style/BreakType.idl> +#include <com/sun/star/table/ShadowFormat.idl> +#include <com/sun/star/table/TableBorder.idl> +#include <com/sun/star/table/XCellRange.idl> +#include <com/sun/star/table/XAutoFormattable.idl> +#include <com/sun/star/chart/XChartDataArray.idl> +#include <com/sun/star/util/XSortable.idl> +#include <com/sun/star/sheet/XCellRangeData.idl> +#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** is a table of text cells which is anchored to a surrounding text. + + <p>Note: The anchor of the actual implementation for text tables + does not have a position in the text. Thus that anchor can not be + used for some operation like XTextContent::attach() or + XText::insertTextContent() + or other function that require the object to have a position in the text.</p> + + <p>The reason why a text table still needs an anchor is that for example + tables should be insertable via XText::insertTextContent() + and that interface uses a parameter of that type.</p> + + <p>Example: Create and insert a TextTable:</p> + + @code{.bas} + xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" ) + xTable.initialize(5, 8) + xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE + xTable.LeftMargin = 2000 + xTable.RightMargin = 1500 + xTextDoc.getText.insertTextContent( xTextRange, xTable, false ) + @endcode + + @see com::sun::star::text::Cell + @see com::sun::star::text::CellRange + @see com::sun::star::text::TableColumns + @see com::sun::star::text::TableRows + @see com::sun::star::text::TextTableCursor + */ +published service TextTable +{ + service com::sun::star::text::TextContent; + + [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; + + interface com::sun::star::text::XTextTable; + + interface com::sun::star::container::XNamed; + + interface com::sun::star::table::XCellRange; + + interface com::sun::star::chart::XChartDataArray; + + interface com::sun::star::table::XAutoFormattable; + + interface com::sun::star::util::XSortable; + + [optional] interface com::sun::star::sheet::XCellRangeData; + + /** determines the type of break that is applied at the beginning of the table.@see com::sun::star::style::BreakType + */ + [property] com::sun::star::style::BreakType BreakType; + + /** contains the left margin of the table. + */ + [property] long LeftMargin; + + /** contains the right margin of the table. + */ + [property] long RightMargin; + + /** contains the horizontal orientation. @see com::sun::star::text::HoriOrientation + */ + [property] short HoriOrient; + + /** Setting this property to TRUE prevents page or column + breaks between this table and the following paragraph or text table. + */ + [property] boolean KeepTogether; + + /** Setting this property to FALSE prevents the table from + getting spread on two pages. + */ + [property] boolean Split; + + /** If a page break property is set at the table, + this property contains the new value for the page number. + */ + [property] short PageNumberOffset; + + /** If this property is set, it creates a page break before the + table and assigns the value as the name of the new page style sheet to use. + */ + [property] string PageDescName; + + /** determines the width of the table relative to its environment. + */ + [property] short RelativeWidth; + /** determines if the value of the relative width is valid. + */ + [property] boolean IsWidthRelative; + + /** determines if the first row of the table is repeated on every new page. + */ + [property] boolean RepeatHeadline; + /** determines the number of rows of the table repeated on every new page. + */ + [optional, property] long HeaderRowCount; + + /** determines the type, color and size of the shadow.@see com::sun::star::table::ShadowFormat + */ + [property] com::sun::star::table::ShadowFormat ShadowFormat; + + /** determines the top margin. + */ + [property] long TopMargin; + + /** determines the bottom margin. + */ + [property] long BottomMargin; + + /** determines if the background color is transparent. + */ + [property] boolean BackTransparent; + + /** contains the absolute table width. + + <p>As this is only a describing property the value of the actual table may vary depending on the + environment the table is located in and the settings of LeftMargin, + RightMargin and HoriOrient. </p> + */ + [property] long Width; + + /** determines if the first row of the table should be treated as + axis labels when a chart is to be created. + */ + [property] boolean ChartRowAsLabel; + + /** determines if the first column of the table should be treated as + axis labels when a chart is to be created. + */ + [property] boolean ChartColumnAsLabel; + + /** contains the description of the table borders. @see com::sun::star::table::TableBorder + */ + [property] com::sun::star::table::TableBorder TableBorder; + + /** contains the column description of the table. + @see com::sun::star::text::TableColumnSeparator + */ + [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators; + + /** contains the sum of the column width values used in TableColumnSeparators. + */ + [property] short TableColumnRelativeSum; + + /** contains the color of the background. + */ + [property] com::sun::star::util::Color BackColor; + + /** contains the URL for the background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the file filter for the background graphic. + */ + [property] string BackGraphicFilter; + + + /** determines the position of the background graphic.@see GraphicLocation + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + + /** determines whether borders of neighboring table cells are + * collapsed into one + */ + [optional, property] boolean CollapsingBorders; + + /** Grab bag of table properties, used as a string-any map for interim interop purposes. + + @since LibreOffice 4.3 + + <p>This property is intentionally not handled by the ODF filter. Any + member that should be handled there should be first moved out from this grab + bag to a separate property.</p> + */ + [optional, property] sequence<com::sun::star::beans::PropertyValue> TableInteropGrabBag; + + /** contains the name of table style used by the table. + + @since LibreOffice 5.3 + */ + [optional, property] string TableTemplateName; + + /** contains the graphic for the background. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextTableCursor.idl b/offapi/com/sun/star/text/TextTableCursor.idl new file mode 100644 index 000000000..75912f3c2 --- /dev/null +++ b/offapi/com/sun/star/text/TextTableCursor.idl @@ -0,0 +1,66 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextTableCursor_idl__ +#define __com_sun_star_text_TextTableCursor_idl__ + +#include <com/sun/star/text/XTextTableCursor.idl> +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/style/CharacterProperties.idl> +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#include <com/sun/star/style/ParagraphProperties.idl> +#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> + + + + module com { module sun { module star { module text { + + +/** specifies a cursor in text tables. + + <p>This cursor can be used to:</p> + <ul> + <li>travel through text table cells</li> + <li>select text table cells</li> + <li>get property values from the selected cells</li> + <li>set property values in the selected cells</li> + </ul> + + @see com::sun::star::text::TextTable + */ +published service TextTableCursor +{ + interface com::sun::star::text::XTextTableCursor; + + interface com::sun::star::beans::XPropertySet; + + service com::sun::star::style::CharacterProperties; + service com::sun::star::style::CharacterPropertiesAsian; + service com::sun::star::style::CharacterPropertiesComplex; + service com::sun::star::style::ParagraphProperties; + + [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextTableRow.idl b/offapi/com/sun/star/text/TextTableRow.idl new file mode 100644 index 000000000..dcecda3f2 --- /dev/null +++ b/offapi/com/sun/star/text/TextTableRow.idl @@ -0,0 +1,124 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextTableRow_idl__ +#define __com_sun_star_text_TextTableRow_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/util/Color.idl> +#include <com/sun/star/style/GraphicLocation.idl> +#include <com/sun/star/text/TableColumnSeparator.idl> +#include <com/sun/star/graphic/XGraphic.idl> + +module com { module sun { module star { module text { + +/** specifies the properties of a text table row. + + @see com::sun::star::TextTable + */ +published service TextTableRow +{ + interface com::sun::star::beans::XPropertySet; + + + /** specifies the color of the background. + */ + [property] com::sun::star::util::Color BackColor; + + + /** If `TRUE`, the background color value in "BackColor" is not visible. + */ + [property] boolean BackTransparent; + + + /** contains the URL of a background graphic. + + @deprecated as of LibreOffice 6.1 - use BackGraphic instead + + Note the new behaviour since it this was deprecated: + This property can only be set and only external URLs are + supported (no more vnd.sun.star.GraphicObject scheme). When an + URL is set, then it will load the graphic and set the BackGraphic + property. + */ + [property] string BackGraphicURL; + + /** contains the name of the file filter of a background graphic. + */ + [property] string BackGraphicFilter; + + + /** determines the position of the background graphic.@see GraphicLocation + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + + /** contains the description of the columns in the table row. + */ + [property] sequence< com::sun::star::text::TableColumnSeparator > TableColumnSeparators; + + + /** contains the height of the table row. + */ + [property] long Height; + + + /** If the value of this property is `TRUE`, the height of the table row + depends on the content of the table cells. + */ + [property] boolean IsAutoHeight; + + + /** If `TRUE`, the row is allowed to be split at page or column breaks. + + @since OOo 2.0 + */ + [optional, property, maybevoid] boolean IsSplitAllowed; + + /** Grab bag of row properties, used as a string-any map for interop purposes. + + @since LibreOffice 4.4 + + <p>This property is intentionally not handled by the ODF filter. Any + member that should be handled there should be first moved out from this grab + bag to a separate property.</p> + */ + [optional, property] sequence<com::sun::star::beans::PropertyValue> RowInteropGrabBag; + + /** contains the graphic of the background. + + @since LibreOffice 6.1 + */ + [optional, property] com::sun::star::graphic::XGraphic BackGraphic; + + /** If TRUE, the table row wasn't deleted or inserted with its tracked cell content + + @since LibreOffice 7.2 + */ + + [optional, property] boolean HasTextChangesOnly; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextTables.idl b/offapi/com/sun/star/text/TextTables.idl new file mode 100644 index 000000000..0885de6ed --- /dev/null +++ b/offapi/com/sun/star/text/TextTables.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextTables_idl__ +#define __com_sun_star_text_TextTables_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to all tables in a document. + */ +published service TextTables +{ + interface com::sun::star::container::XIndexAccess; + interface com::sun::star::container::XNameAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TextViewCursor.idl b/offapi/com/sun/star/text/TextViewCursor.idl new file mode 100644 index 000000000..37d62f11b --- /dev/null +++ b/offapi/com/sun/star/text/TextViewCursor.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TextViewCursor_idl__ +#define __com_sun_star_text_TextViewCursor_idl__ + +#include <com/sun/star/text/TextLayoutCursor.idl> +#include <com/sun/star/view/XScreenCursor.idl> + + + + module com { module sun { module star { module text { + +/** A TextViewCursor is a TextRange which can travel + within a view of a Text object. + @see TextDocumentView + */ +published service TextViewCursor +{ + service com::sun::star::text::TextLayoutCursor; + interface com::sun::star::view::XScreenCursor; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/TimeDisplayFormat.idl b/offapi/com/sun/star/text/TimeDisplayFormat.idl new file mode 100644 index 000000000..adbf16ea2 --- /dev/null +++ b/offapi/com/sun/star/text/TimeDisplayFormat.idl @@ -0,0 +1,75 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_TimeDisplayFormat_idl__ +#define __com_sun_star_text_TimeDisplayFormat_idl__ + + + + module com { module sun { module star { module text { + + +/** These constants define how a time field is formatted before it is displayed. + The format may also depend on the system or document locale. + + @deprecated + */ +published constants TimeDisplayFormat +{ + + /** the system standard + */ + const short STANDARD = 0; + + + /** 13:49 + */ + const short HHMM = 1; + + + /** 13:49:20 + */ + const short HHMMSS = 2; + + + /** 13:49:20.30 + */ + const short HHMMSS00 = 3; + + + /** 01:49 + */ + const short HHMMAMPM = 4; + + + /** 01:49:20 + */ + const short HHMMSSAMPM = 5; + + + /** 01:49:20.30 + */ + const short HHMMSS00AMPM = 6; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/UserDataPart.idl b/offapi/com/sun/star/text/UserDataPart.idl new file mode 100644 index 000000000..a9f7a4045 --- /dev/null +++ b/offapi/com/sun/star/text/UserDataPart.idl @@ -0,0 +1,98 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_UserDataPart_idl__ +#define __com_sun_star_text_UserDataPart_idl__ + + + + module com { module sun { module star { module text { + +/** These constants define which part of the user data is displayed in a + user data text field (service "sun.one.text.TextField.ExtendedUser") + */ +published constants UserDataPart +{ + /** The field shows the company name. + */ + const short COMPANY = 0; + + /** The field shows the first name. + */ + const short FIRSTNAME = 1; + + /** The field shows the name. + */ + const short NAME = 2; + + /** The field shows the initials. + */ + const short SHORTCUT = 3; + + /** The field shows the street. + */ + const short STREET = 4; + + /** The field shows the country. + */ + const short COUNTRY = 5; + + /** The field shows the zip code. + */ + const short ZIP = 6; + + /** The field shows the city. + */ + const short CITY = 7; + + /** The field shows the title. + */ + const short TITLE = 8; + + /** The field shows the position. + */ + const short POSITION = 9; + + /** The field shows the no of the private phone. + */ + const short PHONE_PRIVATE = 10; + + /** The field shows the number of the business phone. + */ + const short PHONE_COMPANY = 11; + + /** The field shows the fax no. + */ + const short FAX = 12; + + /** The field shows the e-Mail. + */ + const short EMAIL = 13; + + /** The field shows the state. + */ + const short STATE = 14; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/UserDefinedIndex.idl b/offapi/com/sun/star/text/UserDefinedIndex.idl new file mode 100644 index 000000000..fc7c7aaf9 --- /dev/null +++ b/offapi/com/sun/star/text/UserDefinedIndex.idl @@ -0,0 +1,77 @@ +/* -*- 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 . + */ + + +#ifndef __com_sun_star_text_UserDefinedIndex_idl__ +#define __com_sun_star_text_UserDefinedIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> +#include <com/sun/star/text/XDocumentIndexMark.idl> + + +module com { module sun { module star { module text { + + +/** specifies service of user defined indexes within a document.@see com::sun::star::text::BaseIndex + */ +published service UserDefinedIndex +{ + service com::sun::star::text::BaseIndex; + + /** contains the interface to access the paragraph style names that are included + in this index. + @see DocumentIndexParagraphStyles + */ + [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; + + /** determines if the document index marks are included in this index. + */ + [optional, property] boolean CreateFromMarks; + + /** determines if the outline level of the location of the indexed object is + used as index level of the index entry.*/ + [optional, property] boolean UseLevelFromSource; + + /** determines if tables are included in the index. + */ + [optional, property] boolean CreateFromTables; + + /** determines if text frames are included in the index. + */ + [optional, property] boolean CreateFromTextFrames; + + /** determines if graphic objects are included in the index. + */ + [optional, property] boolean CreateFromGraphicObjects; + + /** determines if embedded objects are included in the index. + */ + [optional, property] boolean CreateFromEmbeddedObjects; + + /** + contains all index marks that are related to this index. + */ + [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks; +}; + + +}; }; }; }; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/UserFieldFormat.idl b/offapi/com/sun/star/text/UserFieldFormat.idl new file mode 100644 index 000000000..2ff364478 --- /dev/null +++ b/offapi/com/sun/star/text/UserFieldFormat.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_UserFieldFormat_idl__ +#define __com_sun_star_text_UserFieldFormat_idl__ + + + + module com { module sun { module star { module text { + +/** These constants describe how the content of a user text field is + formatted. + */ +published constants UserFieldFormat +{ + /** The number format of the operating system is used. + */ + const short SYSTEM = 0; + + /** The content is formatted as text. + */ + const short TEXT = 1; + + /** The number format of the property "NumberFormat" is used. + */ + const short NUM = 2; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/UserIndex.idl b/offapi/com/sun/star/text/UserIndex.idl new file mode 100644 index 000000000..c6f7d431e --- /dev/null +++ b/offapi/com/sun/star/text/UserIndex.idl @@ -0,0 +1,74 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_UserIndex_idl__ +#define __com_sun_star_text_UserIndex_idl__ + +#include <com/sun/star/text/BaseIndex.idl> + + +module com { module sun { module star { module text { + +/** specifies service of user defined indexes within a document. + @see com::sun::star::text::BaseIndex +*/ +published service UserIndex +{ + service com::sun::star::text::BaseIndex; + + /** contains the interface to access the paragraph style names that are included + in this index. + @see DocumentIndexParagraphStyles + */ + [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; + + /** determines if the document index marks are included in this index. + */ + [optional, property] boolean CreateFromMarks; + + /** determines if the outline level of the location of the indexed object is + used as index level of the index entry.*/ + [optional, property] boolean UseLevelFromSource; + + /** determines if tables are included in the index. + */ + [optional, property] boolean CreateFromTables; + + /** determines if text frames are included in the index. + */ + [optional, property] boolean CreateFromTextFrames; + + /** determines if graphic objects are included in the index. + */ + [optional, property] boolean CreateFromGraphicObjects; + + /** determines if embedded objects are included in the index. + */ + [optional, property] boolean CreateFromEmbeddedObjects; + /** contains the name of the user index. + */ + [property] string UserIndexName; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/UserIndexMark.idl b/offapi/com/sun/star/text/UserIndexMark.idl new file mode 100644 index 000000000..f756fb48f --- /dev/null +++ b/offapi/com/sun/star/text/UserIndexMark.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_UserIndexMark_idl__ +#define __com_sun_star_text_UserIndexMark_idl__ + +#include <com/sun/star/text/TextContent.idl> +#include <com/sun/star/text/BaseIndexMark.idl> + + + + module com { module sun { module star { module text { + + +/** is a TextRange which is explicitly marked + as an index entry for a UserIndex. + */ +published service UserIndexMark +{ + service com::sun::star::text::TextContent; + + service com::sun::star::text::BaseIndexMark; + /** contains the name of the user index it belongs to. + */ + [property] string UserIndexName; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/VertOrientation.idl b/offapi/com/sun/star/text/VertOrientation.idl new file mode 100644 index 000000000..30b9e256a --- /dev/null +++ b/offapi/com/sun/star/text/VertOrientation.idl @@ -0,0 +1,77 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_VertOrientation_idl__ +#define __com_sun_star_text_VertOrientation_idl__ + + + + module com { module sun { module star { module text { + +/** These enumeration values are used to specify the vertical orientation. + */ +published constants VertOrientation +{ + /** no hard alignment + */ + const short NONE = 0; + + /** aligned at the top + */ + const short TOP = 1; + + /** aligned at the center + */ + const short CENTER = 2; + + /** aligned at the bottom + */ + const short BOTTOM = 3; + + /** aligned at the top of a character (anchored to character) + */ + const short CHAR_TOP = 4; + + /** aligned at the center of a character (anchored to character ) + */ + const short CHAR_CENTER = 5; + + /** aligned at the bottom of a character (anchored to character ) + */ + const short CHAR_BOTTOM = 6; + + /** aligned at the top of the line (anchored to character ) + */ + const short LINE_TOP = 7; + + /** aligned at the center of the line (anchored to character ) + */ + const short LINE_CENTER = 8; + + /** aligned at the bottom of the line (anchored to character ) + */ + const short LINE_BOTTOM = 9; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/VertOrientationFormat.idl b/offapi/com/sun/star/text/VertOrientationFormat.idl new file mode 100644 index 000000000..174f97f7d --- /dev/null +++ b/offapi/com/sun/star/text/VertOrientationFormat.idl @@ -0,0 +1,59 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_VertOrientationFormat_idl__ +#define __com_sun_star_text_VertOrientationFormat_idl__ + + + + module com { module sun { module star { module text { + +/** describes the vertical orientation of an object. + + + + <p>If <code>VerticalOrientation == VERT_NONE</code>, then the value "YPos" + describes the distance from the top of the context. Otherwise "YPos" + is ignored. + </p> + */ +published struct VertOrientationFormat +{ + /** contains the distance from top. Only valid if the property + VerticalOrientation contains the value VERT_NONE. + */ + long YPos; + + /** determines the vertical alignment of an object. + The values refer to com::sun::star::VertOrientation. + */ + short VerticalOrientation; + + /** determines the reference position of the vertical alignment.@see com::sun::star::text::RelOrientation + */ + short VerticalRelation; + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/ViewSettings.idl b/offapi/com/sun/star/text/ViewSettings.idl new file mode 100644 index 000000000..4439b7fc9 --- /dev/null +++ b/offapi/com/sun/star/text/ViewSettings.idl @@ -0,0 +1,311 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_ViewSettings_idl__ +#define __com_sun_star_text_ViewSettings_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/view/DocumentZoomType.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +module com { module sun { module star { module text { + +/** provides access to the settings of the controller of a text document. + */ +published service ViewSettings +{ + interface com::sun::star::beans::XPropertySet; + + /** If this property is `TRUE`, annotations (notes) are visible. + */ + [property] boolean ShowAnnotations; + + /** If this property is `TRUE`, paragraph line breaks are visible. + */ + [property] boolean ShowBreaks; + + /** If this property is `TRUE`, shapes are visible. + */ + [property] boolean ShowDrawings; + + /** If this property is `TRUE`, text fields are shown with their commands; otherwise + the content is visible. + */ + [property] boolean ShowFieldCommands; + + /** If this property is `TRUE`, footnotes symbols are displayed with gray background. + */ + [property] boolean ShowFootnoteBackground; + + /** If this property is `TRUE`, graphic objects are visible. + */ + [property] boolean ShowGraphics; + + /** If this property is `TRUE`, hidden paragraphs are displayed. + */ + [property] boolean ShowHiddenParagraphs; + + /** If this property is `TRUE`, hidden text is displayed. + */ + [property] boolean ShowHiddenText; + + /** ShowHoriRuler and ShowVertRuler determine whether a ruler is visible. + */ + [property] boolean ShowRulers; + + /** If this property is `TRUE` and the property ShowRulers is `TRUE`, + the horizontal ruler is displayed. + */ + [property] boolean ShowHoriRuler; + + /** If this property is `TRUE` and the property ShowRulers is `TRUE`, + the horizontal scroll bar is displayed. + */ + [property] boolean ShowHoriScrollBar; + + /** If this property is `TRUE`, index marks are displayed with gray background. + */ + [property] boolean ShowIndexMarkBackground; + + /** If this property is `TRUE`, paragraph breaks are visible. + */ + [property] boolean ShowParaBreaks; + + /** If this property is `TRUE`, protected spaces (hard spaces) are displayed with gray + background. + */ + [property] boolean ShowProtectedSpaces; + + /** If this property is `TRUE`, soft hyphens are displayed with gray background. + */ + [property] boolean ShowSoftHyphens; + + /** If this property is `TRUE`, spaces are displayed with dots. + */ + [property] boolean ShowSpaces; + + /** If this property is `TRUE`, table boundaries are displayed. + */ + [property] boolean ShowTableBoundaries; + + /** If this property is `TRUE`, tables are visible. + */ + [property] boolean ShowTables; + + /** If this property is `TRUE`, tab stops are visible. + */ + [property] boolean ShowTabstops; + + /** If this property is `TRUE`, text boundaries are displayed. + */ + [property] boolean ShowTextBoundaries; + + /** If this property is `TRUE`, text fields are displayed with gray background. + */ + [property] boolean ShowTextFieldBackground; + + /** If this property is `TRUE`, the vertical ruler is displayed. + */ + [property] boolean ShowVertRuler; + + /** If this property is `TRUE`, the vertical scroll bar is displayed. + */ + [property] boolean ShowVertScrollBar; + + /** If this property is `TRUE`, smooth scrolling is active. + */ + [property] boolean SmoothScrolling; + + /** If this property is `TRUE`, the vertical ruler is aligned to the right side + of the view and the vertical scrollbar is on the left. + */ + [property] boolean IsVertRulerRightAligned; + + /** If this property is `TRUE` the document will be displayed as if it + were a HTML document. + */ + [property] boolean ShowOnlineLayout; + + /** This property defines the zoom type for the document. + + @see com::sun::star::view::DocumentZoomType + */ + [property] short ZoomType; + + /** Defines the zoom value to use. + Valid only if the ZoomType is set to + com::sun::star::view::DocumentZoomType::BY_VALUE. + */ + [property] short ZoomValue; + /** If this property is `TRUE` hyperlinks in the document are executed (loaded) on + mouse click. Otherwise they are handled like normal text. + */ + [optional, property] boolean IsExecuteHyperlinks; + + /** Specifies whether to display the grid or not + + @since OOo 2.0 + */ + [optional, property] boolean IsRasterVisible; + + /** Specifies whether to move frames, drawing elements, and form + functions only between grid points. + + @since OOo 2.0 + */ + [optional, property] boolean IsSnapToRaster; + + /** Specifies the number of intervals between grid points on the X-axis. + + <p>The value must be greater or equal to 0, and the application + may enforce an upper bound for the value.</p> + + @since OOo 2.0 + @throws com::sun::star::lang::IllegalArgumentException + if the value is out of bounds. + */ + [optional, property] long RasterSubdivisionX; + + /** Specifies the number of intervals between grid points on the Y-axis. + + <p>The value must be greater or equal to 0, and the application + may enforce an upper bound for the value.</p> + + @since OOo 2.0 + @throws com::sun::star::lang::IllegalArgumentException + if the value is out of bounds. + */ + [optional, property] long RasterSubdivisionY; + + /** Defines the unit of measure for the spacing between grid points + on the X-axis. + + <p>The value must be greater than 0. The application + may enforce more restricting bounds for the value.</p> + + @since OOo 2.0 + @throws com::sun::star::lang::IllegalArgumentException + if the value is out of bounds. + */ + [optional, property] long RasterResolutionX; + + /** Defines the unit of measure for the spacing between grid points + on the Y-axis. + + <p>The value must be greater than 0. The application + may enforce more restricting bounds for the value.</p> + + @since OOo 2.0 + @throws com::sun::star::lang::IllegalArgumentException + if the value is out of bounds. + */ + [optional, property] long RasterResolutionY; + + /** If this property is `TRUE`, hidden characters are displayed + + @since OOo 3.0 + */ + [optional, property] boolean ShowHiddenCharacters; + /** If this property is `TRUE`, the settings of non-printing characters are applied. + + <p>This option controls the use of the settings ShowHiddenCharacters, + ShowTabstops, ShowSpaces, ShowBreaks and ShowParaBreaks </p> + + @since OOo 3.0 + */ + [optional, property] boolean ShowNonprintingCharacters; + + /** metric unit of the horizontal ruler + + <p>Uses values com::sun::star::awt::FieldUnit</p> + + @since OOo 3.1 + */ + [optional, property] long HorizontalRulerMetric; + + /** metric unit of the vertical ruler + + <p>Uses values from com::sun::star::awt::FieldUnit</p> + + @since OOo 3.1 + */ + [optional, property] long VerticalRulerMetric; + + /** If this property is `TRUE`, tips for document content are shown, + typically in a help balloon when the mouse is over the content. + + @since LibreOffice 4.1 + */ + [optional, property] boolean ShowContentTips; + + /** If this property is `TRUE`, and the scroll bar is shown, a tool tip + is displayed while scrolling. + + @since LibreOffice 4.2 + */ + [optional, property] boolean ShowScrollBarTips; + + /** If this property is `TRUE`, whitespaces around pages are hidden. + + @since LibreOffice 5.1 + */ + [optional, property] boolean HideWhitespace; + + /** If this property is `TRUE`, tooltips for tracked changes are shown. + + @since LibreOffice 6.1 + */ + [optional, property] boolean ShowInlineTooltips; + + /** If this property is `TRUE`, the advanced menu for header/footer is shown + + @since LibreOffice 6.2 + */ + [optional, property] boolean UseHeaderFooterMenu; + + /** If this property is `TRUE`, bookmark positions are displayed. + + @since LibreOffice 7.0 + */ + [optional, property] boolean ShowBookmarks; + + /** If this property is `TRUE`, the outline content visibility toggle button is shown. + + @since LibreOffice 7.1 + */ + [optional, property] boolean ShowOutlineContentVisibilityButton; + + /** If this property is `TRUE`, tracked deletions are shown in margin. + + @since LibreOffice 7.1 + */ + [optional, property] boolean ShowChangesInMargin; + + /** If this property is `TRUE`, sub outline levels are treated as content in + outline content visibility actions. + + @since LibreOffice 7.2 + */ + [optional, property] boolean TreatSubOutlineLevelsAsContent; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/WebDocument.idl b/offapi/com/sun/star/text/WebDocument.idl new file mode 100644 index 000000000..8b3e31921 --- /dev/null +++ b/offapi/com/sun/star/text/WebDocument.idl @@ -0,0 +1,43 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_WebDocument_idl__ +#define __com_sun_star_text_WebDocument_idl__ + +#include <com/sun/star/text/GenericTextDocument.idl> + + + module com { module sun { module star { module text { + + +/** Specify the document service of the web module. + + @deprecated + */ +service WebDocument +{ + /** Provides the functionality of such web document. */ + service GenericTextDocument; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/WrapInfluenceOnPosition.idl b/offapi/com/sun/star/text/WrapInfluenceOnPosition.idl new file mode 100644 index 000000000..6be641fc1 --- /dev/null +++ b/offapi/com/sun/star/text/WrapInfluenceOnPosition.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_WrapInfluenceOnPosition_idl__ +#define __com_sun_star_text_WrapInfluenceOnPosition_idl__ + + + + module com { module sun { module star { module text { + + +/** These values specify the influence of the wrapping style of a floating + screen object when it's positioned. + */ +constants WrapInfluenceOnPosition +{ + + /** wrapping style has no influence on the position and the floating screen + object is successive positioned. + */ + const short ONCE_SUCCESSIVE = 1; + + + /** wrapping style has no influence on the position and the floating screen + object is concurrent positioned. + */ + const short ONCE_CONCURRENT = 2; + + + /** wrapping style has influence on the position and the floating screen + object is iterative positioned. + */ + const short ITERATIVE = 3; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/WrapTextMode.idl b/offapi/com/sun/star/text/WrapTextMode.idl new file mode 100644 index 000000000..6344b9579 --- /dev/null +++ b/offapi/com/sun/star/text/WrapTextMode.idl @@ -0,0 +1,66 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_WrapTextMode_idl__ +#define __com_sun_star_text_WrapTextMode_idl__ + + + + module com { module sun { module star { module text { + +/** enumeration values specify the text wrap around objects in a text. + */ +published enum WrapTextMode +{ + /** text does not flow around the object. + */ + NONE, + + /** text flow ignores the object. + */ + THROUGH, + + /** text flow ignores the object: errant spelling deprecated in version 5.4 + */ + THROUGHT = THROUGH, + + /** text flows to the left and right of the object. + */ + PARALLEL, + + /** text flow depends on the situation. The text formatting + decides the best way. + */ + DYNAMIC, + + /** text flows to the left side of the object. + */ + LEFT, + + /** text flows to the right side of the object. + */ + RIGHT + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/WritingMode.idl b/offapi/com/sun/star/text/WritingMode.idl new file mode 100644 index 000000000..2d431040f --- /dev/null +++ b/offapi/com/sun/star/text/WritingMode.idl @@ -0,0 +1,65 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_WritingMode_idl__ +#define __com_sun_star_text_WritingMode_idl__ + + + + module com { module sun { module star { module text { + + +/** this enum covers the different writing directions + + @deprecated + Use WritingMode2 instead + */ +published enum WritingMode +{ + + /** text within lines is written left-to-right. lines and blocks are placed + top-to-bottom. + <p> + Typically, this is the writing mode for normal "alphabetic" text. + */ + LR_TB, + + + /** text within a line are written right-to-left. Lines and blocks are + placed top-to-bottom. + <p> + Typically, this writing mode is used in Arabic and Hebrew text. + */ + RL_TB, + + + /** text within a line is written top-to-bottom. Lines and blocks are + placed right-to-left. + <p> + Typically, this writing mode is used in Chinese and Japanese text. + */ + TB_RL + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/WritingMode2.idl b/offapi/com/sun/star/text/WritingMode2.idl new file mode 100644 index 000000000..1edc467e7 --- /dev/null +++ b/offapi/com/sun/star/text/WritingMode2.idl @@ -0,0 +1,93 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_WritingMode2_idl__ +#define __com_sun_star_text_WritingMode2_idl__ + + + + module com { module sun { module star { module text { + + +/** this set of constants describes different writing directions + + <p>In addition to numerous explicit writing directions, it allows to specify to take the writing + direction from the object's context.</p> + */ +published constants WritingMode2 +{ + + /** text within lines is written left-to-right. Lines and blocks are placed + top-to-bottom. + <p> + Typically, this is the writing mode for normal "alphabetic" text. + */ + const short LR_TB = 0; + + + /** text within a line are written right-to-left. Lines and blocks are + placed top-to-bottom. + <p> + Typically, this writing mode is used in Arabic and Hebrew text. + */ + const short RL_TB = 1; + + + /** text within a line is written top-to-bottom. Lines and blocks are + placed right-to-left. + <p> + Typically, this writing mode is used in Chinese and Japanese text. + */ + const short TB_RL = 2; + + + /** text within a line is written top-to-bottom. Lines and blocks are + placed left-to-right. + <p> + Typically, this writing mode is used in Mongolian text. + */ + const short TB_LR = 3; + + + /** obtain writing mode from the current page. + + <p>May not be used in page styles.</p> + + @deprecated + Use CONTEXT instead. + */ + const short PAGE = 4; + + /** obtain actual writing mode from the context of the object. + */ + const short CONTEXT = 4; + + /** text within a line is written bottom-to-top. Lines and blocks are + placed left-to-right. + + @since LibreOffice 6.3 + */ + const short BT_LR = 5; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XAutoTextContainer.idl b/offapi/com/sun/star/text/XAutoTextContainer.idl new file mode 100644 index 000000000..a44fba34c --- /dev/null +++ b/offapi/com/sun/star/text/XAutoTextContainer.idl @@ -0,0 +1,86 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XAutoTextContainer_idl__ +#define __com_sun_star_text_XAutoTextContainer_idl__ + +#include <com/sun/star/container/ElementExistException.idl> +#include <com/sun/star/container/NoSuchElementException.idl> +#include <com/sun/star/container/XNameAccess.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/text/XAutoTextGroup.idl> + +module com { module sun { module star { module text { + +/** handles blocks of AutoTextEntry. + @see AutoTextContainer +*/ +published interface XAutoTextContainer: com::sun::star::container::XNameAccess +{ + /** creates a new AutoText group. + + @param aGroupName the name of the AutoTextContainer + + <p>The name must follow the pattern <code>groupname*pathid</code>, where:</p> + + <ul> + <li><code>groupname</code> should contain only alphanumeric characters + (A-Za-z0-9), underscore (_) or space (0x20)</li> + <li>an asterisk (*) delimiter separates the group name from the path + identifier</li> + <li><code>pathid</code> is a number (0 or 1) identifying the directory + where the AutoText file is stored. Paths are stored in the Office + configuration and accessed through + com::sun::star::util::PathSettings::AutoText. + <ul> + <li>0 indicates the path of the <b>Office Basis</b> layer</li> + <li>1 indicates the path of the <b>user</b> directory</li> + </ul> + </li> + </ul> + If only <code>groupname</code> is specified, the path defaults to 0, the + <b>Office Basis</b> layer.<br>Note that in some systems the user may lack of + write access to the Office Basis directory. + + Example: + + <ul> + <li><code>standard*0</code><br>the "standard" AutoTextGroup in the Office Basis layer</li> + <li><code>template</code><br>the "template" AutoTextGroup in the Office Basis layer</li> + <li><code>mytexts*1</code><br>the "mytexts" AutoTextGroup in the user directory</li> + </ul> + + */ + com::sun::star::text::XAutoTextGroup insertNewByName( [in] string aGroupName ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException ); + + /** deletes the specified AutoText group. + @param aGroupName + see the documentation for XAutoTextContainer::insertNewByName() + */ + void removeByName( [in] string aGroupName ) + raises( com::sun::star::container::NoSuchElementException ); + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XAutoTextContainer2.idl b/offapi/com/sun/star/text/XAutoTextContainer2.idl new file mode 100644 index 000000000..8d018f1a2 --- /dev/null +++ b/offapi/com/sun/star/text/XAutoTextContainer2.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XAutoTextContainer2_idl__ +#define __com_sun_star_text_XAutoTextContainer2_idl__ + +#include <com/sun/star/text/XAutoTextContainer.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + +module com { module sun { module star { module text { + + +/** + @since LibreOffice 4.1 + */ +published interface XAutoTextContainer2 +{ + interface com::sun::star::text::XAutoTextContainer; + + interface com::sun::star::container::XIndexAccess; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XAutoTextEntry.idl b/offapi/com/sun/star/text/XAutoTextEntry.idl new file mode 100644 index 000000000..46d0c1576 --- /dev/null +++ b/offapi/com/sun/star/text/XAutoTextEntry.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XAutoTextEntry_idl__ +#define __com_sun_star_text_XAutoTextEntry_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/XTextRange.idl> + + + + module com { module sun { module star { module text { + +/** identifies an autotext entry. + + + + + + + + + + + + + + @deprecated + */ +published interface XAutoTextEntry: com::sun::star::uno::XInterface +{ + /** inserts the contents represented by this auto text entry at the + specified text range. + */ + void applyTo( [in] com::sun::star::text::XTextRange xRange ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XAutoTextGroup.idl b/offapi/com/sun/star/text/XAutoTextGroup.idl new file mode 100644 index 000000000..87c4b05da --- /dev/null +++ b/offapi/com/sun/star/text/XAutoTextGroup.idl @@ -0,0 +1,84 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XAutoTextGroup_idl__ +#define __com_sun_star_text_XAutoTextGroup_idl__ + +#include <com/sun/star/container/XNameAccess.idl> + +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/container/ElementExistException.idl> + +#include <com/sun/star/io/IOException.idl> + +#include <com/sun/star/text/XAutoTextEntry.idl> + +#include <com/sun/star/text/XTextRange.idl> + +#include <com/sun/star/container/NoSuchElementException.idl> + + + + module com { module sun { module star { module text { + +/** The interface provide methods to insert, rename and delete autotext entries from the current autotext group. + */ +published interface XAutoTextGroup: com::sun::star::container::XNameAccess +{ + /** returns the titles of all autotext entries. The order of the entries + corresponds to the output of the function getElementNames(). + */ + sequence<string> getTitles(); + + /** renames an entry in the autotext group. + + + + <p>The position of the autotext entry is not changed. + + </p> + */ + void renameByName( [in] string aElementName, + [in] string aNewElementName, + [in] string aNewElementTitle ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::ElementExistException, + com::sun::star::io::IOException ); + + /** creates a new AutoTextEntry entry. + */ + com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName, + [in] string aTitle, + [in] com::sun::star::text::XTextRange xTextRange ) + raises( com::sun::star::container::ElementExistException ); + + /** removes the specified autotext entry. + */ + void removeByName( [in] string aEntryName ) + raises( com::sun::star::container::NoSuchElementException ); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XBookmarkInsertTool.idl b/offapi/com/sun/star/text/XBookmarkInsertTool.idl new file mode 100644 index 000000000..4ed608f43 --- /dev/null +++ b/offapi/com/sun/star/text/XBookmarkInsertTool.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XBookmarkInsertTool_idl__ +#define __com_sun_star_text_XBookmarkInsertTool_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/XTextContent.idl> + +#include <com/sun/star/text/XTextRange.idl> + + + + module com { module sun { module star { module text { + +/** offers an easy way to insert bookmarks by name.@see Text + */ +published interface XBookmarkInsertTool: com::sun::star::uno::XInterface +{ + /** inserts a bookmark at the specified text position. + */ + com::sun::star::text::XTextContent insertNewBookmark( [in] com::sun::star::text::XTextRange xTextRange, + [in] string aName ); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XBookmarksSupplier.idl b/offapi/com/sun/star/text/XBookmarksSupplier.idl new file mode 100644 index 000000000..d3f66410c --- /dev/null +++ b/offapi/com/sun/star/text/XBookmarksSupplier.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XBookmarksSupplier_idl__ +#define __com_sun_star_text_XBookmarksSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the collection of all bookmarks within this text container. + */ +published interface XBookmarksSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of all Bookmark instances which are + within this context and which support the Bookmarks service. + */ + com::sun::star::container::XNameAccess getBookmarks(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XChapterNumberingSupplier.idl b/offapi/com/sun/star/text/XChapterNumberingSupplier.idl new file mode 100644 index 000000000..c7788bcde --- /dev/null +++ b/offapi/com/sun/star/text/XChapterNumberingSupplier.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XChapterNumberingSupplier_idl__ +#define __com_sun_star_text_XChapterNumberingSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XIndexReplace.idl> + + + + module com { module sun { module star { module text { + +/** contains the settings of the chapter numbering in a text + document. + */ +published interface XChapterNumberingSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of numbering rules for this document. + + <P>This interface allows access to the properties + of the numbering level via a sequence of com::sun::star::beans::PropertyValues. + */ + com::sun::star::container::XIndexReplace getChapterNumberingRules(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XDefaultNumberingProvider.idl b/offapi/com/sun/star/text/XDefaultNumberingProvider.idl new file mode 100644 index 000000000..a520d9e04 --- /dev/null +++ b/offapi/com/sun/star/text/XDefaultNumberingProvider.idl @@ -0,0 +1,65 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XDefaultNumberingProvider_idl__ +#define __com_sun_star_text_XDefaultNumberingProvider_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/lang/Locale.idl> +#include <com/sun/star/beans/PropertyValues.idl> + +module com { module sun { module star { module text { + +/** + provides access to default com::sun::star::text::NumberingRules + according to a given locale information. + <p></p> + @see com::sun::star::text::NumberingRules + @see com::sun::star::lang::Locale + @version 1.0 +*/ +published interface XDefaultNumberingProvider : com::sun::star::uno::XInterface +{ + /** + provides access to outline numberings according to + a given com::sun::star::lang::Locale. + <p>Outline numberings usually consist of levels + with different settings. </p> + @see com::sun::star::text::NumberingLevel + */ + sequence<com::sun::star::container::XIndexAccess> + getDefaultOutlineNumberings([in]com::sun::star::lang::Locale aLocale); + /** + provides access to outline numberings according + to a given com::sun::star::lang::Locale. + <p>In contrast to outline numberings the continuous + numberings consist of + level using the equal settings in all numbering levels.</P> + @see com::sun::star::text::NumberingLevel + @see com::sun::star::lang::Locale + */ + sequence<com::sun::star::beans::PropertyValues> + getDefaultContinuousNumberingLevels([in]com::sun::star::lang::Locale aLocale); +}; +};};};}; + +#endif + + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XDependentTextField.idl b/offapi/com/sun/star/text/XDependentTextField.idl new file mode 100644 index 000000000..6386d6b49 --- /dev/null +++ b/offapi/com/sun/star/text/XDependentTextField.idl @@ -0,0 +1,83 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XDependentTextField_idl__ +#define __com_sun_star_text_XDependentTextField_idl__ + +#include <com/sun/star/text/XTextField.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + + module com { module sun { module star { module text { + + +/** makes it possible to attach this TextField to a + TextFieldMaster. + */ +published interface XDependentTextField: com::sun::star::text::XTextField +{ + + /** method must be called to attach the + TextFieldMaster to this TextField. + <p>A TextFieldMaster can only be assigned once. + </p> + + Example: Create and insert a user field (with a <code>UserField</code>): + + @code{.java} + // Create a fieldmaster for our newly created User Text field, and access it's + // XPropertySet interface + XPropertySet xMasterPropSet = (XPropertySet) UnoRuntime.queryInterface( + XPropertySet.class, mxDocFactory.createInstance( + "com.sun.star.text.FieldMaster.User")); + // Set the name and value of the FieldMaster + xMasterPropSet.setPropertyValue ("Name", "UserEmperor"); + xMasterPropSet.setPropertyValue ("Value", new Integer(42)); + // Attach the field master to the user field + xUserField.attachTextFieldMaster (xMasterPropSet); + // Move the cursor to the end of the document + mxDocCursor.gotoEnd(false); + // insert a paragraph break using the XSimpleText interface + mxDocText.insertControlCharacter( + mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false); + // Insert the user field at the end of the document + mxDocText.insertTextContent(mxDocText.getEnd(), xUserField, false); + @endcode + */ + void attachTextFieldMaster( [in] com::sun::star::beans::XPropertySet xFieldMaster ) + raises( com::sun::star::lang::IllegalArgumentException ); + + + /** @returns + the previously attached TextFieldMaster + */ + com::sun::star::beans::XPropertySet getTextFieldMaster(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XDocumentIndex.idl b/offapi/com/sun/star/text/XDocumentIndex.idl new file mode 100644 index 000000000..cfde98615 --- /dev/null +++ b/offapi/com/sun/star/text/XDocumentIndex.idl @@ -0,0 +1,63 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XDocumentIndex_idl__ +#define __com_sun_star_text_XDocumentIndex_idl__ + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** This is the main interface for a document index. + + + + <p>Use com::sun::star::util::XRefreshable and + com::sun::star::lang::XServiceInfo instead, if available. + + </p> + + + + + + + @deprecated + @see com::sun::star::util::XRefreshable + @see com::sun::star::lang::XServiceInfo + */ +published interface XDocumentIndex: com::sun::star::text::XTextContent +{ + /** returns the service name that was used to create this document index type. + */ + string getServiceName(); + + /** initiates an update to the document index. + */ + void update(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XDocumentIndexMark.idl b/offapi/com/sun/star/text/XDocumentIndexMark.idl new file mode 100644 index 000000000..fc1b56f4d --- /dev/null +++ b/offapi/com/sun/star/text/XDocumentIndexMark.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XDocumentIndexMark_idl__ +#define __com_sun_star_text_XDocumentIndexMark_idl__ + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** gives access to the mark of a document index entry.@see DocumentIndexMark + */ +published interface XDocumentIndexMark: com::sun::star::text::XTextContent +{ + /** @returns + the explicitly set string for the index mark. + + @see setMarkEntry + */ + string getMarkEntry(); + + /** sets an explicit string for this index mark to use + in the index. + + + + <p>If empty, the string of the TextRange to which + the TextContent refers is used in the index.</p> + */ + void setMarkEntry( [in] string aIndexEntry ); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl b/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl new file mode 100644 index 000000000..0918c6bb9 --- /dev/null +++ b/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XDocumentIndexesSupplier_idl__ +#define __com_sun_star_text_XDocumentIndexesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + +/** gives access to the collection of document indexes. + + + + <p>In general this interface is supported by a TextDocument.</p> + */ +published interface XDocumentIndexesSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of "DocumentIndexes" currently contained in the object. + */ + com::sun::star::container::XIndexAccess getDocumentIndexes(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl b/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl new file mode 100644 index 000000000..f6db5181c --- /dev/null +++ b/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XEndnotesSettingsSupplier_idl__ +#define __com_sun_star_text_XEndnotesSettingsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the FootnoteSettings + within the context (e.g. document). + */ +published interface XEndnotesSettingsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + EndnoteSettings of the object. + */ + com::sun::star::beans::XPropertySet getEndnotesSettings(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XEndnotesSupplier.idl b/offapi/com/sun/star/text/XEndnotesSupplier.idl new file mode 100644 index 000000000..812bf28fa --- /dev/null +++ b/offapi/com/sun/star/text/XEndnotesSupplier.idl @@ -0,0 +1,54 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XEndnotesSupplier_idl__ +#define __com_sun_star_text_XEndnotesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XIndexAccess.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the endnotes within the + context (e.g. document). + */ +published interface XEndnotesSupplier: com::sun::star::uno::XInterface +{ + /** @returns + a collection of endnotes. + */ + com::sun::star::container::XIndexAccess getEndnotes(); + + /** @returns + the endnote settings of the document. + */ + com::sun::star::beans::XPropertySet getEndnoteSettings(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFlatParagraph.idl b/offapi/com/sun/star/text/XFlatParagraph.idl new file mode 100644 index 000000000..2948e4675 --- /dev/null +++ b/offapi/com/sun/star/text/XFlatParagraph.idl @@ -0,0 +1,169 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XFlatParagraph_idl__ +#define __com_sun_star_text_XFlatParagraph_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/Locale.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/text/XTextMarkup.idl> + + +module com { module sun { module star { module text { + + +/** provides functionality to ... + + @since OOo 3.0 + */ + +interface XFlatParagraph: com::sun::star::text::XTextMarkup +{ + + /** get the content of the paragraph + + @returns + the content of the paragraph. + */ + string getText(); + + /** check whether the content has been modified + + @returns + `TRUE` if the content has been modified, + `FALSE` otherwise. + */ + boolean isModified(); + + /** change the "checked" flag of the respective text node, i.e., mark the + text node as "processed" + + @param nType + type, see TextMarkupType. + + @param bVal + `TRUE` the respective text node has been processed + `FALSE` the respective text node needs to be processed again + later + */ + void setChecked( [in] long nType, [in] boolean bVal ); + + /** returns whether the respective text node has already been processed + + @param nType + type, see TextMarkupType. + + @returns + `TRUE` if the respective text node has been checked + `FALSE` otherwise. + */ + boolean isChecked( [in] long nType ); + + /** get the language of the specific text + + @param nPos + start index of the text. + + @param nLen + the length of the text. + + @returns + the locale for the language identified. + If no language could be identified, the locale will be empty. + + @throws IllegalArgumentException + when any argument is wrong. + */ + com::sun::star::lang::Locale getLanguageOfText( [in] long nPos, [in] long nLen ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** get the single most probable language of the specific text, + especially after getLanguageOfText fails + + @param nPos + start index of the text. + + @param nLen + the length of the text. + + @returns + the locale for the language identified. + + @throws IllegalArgumentException + when any argument is wrong. + */ + com::sun::star::lang::Locale getPrimaryLanguageOfText( [in] long nPos, + [in] long nLen ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** replace the specific text with new text. + + @param nPos + start index of the text. + + @param nLen + the length of the text. + + @param NewText + new text. + + @param aAttributes + the given set of attributes e.g. Language + + @throws IllegalArgumentException + when any argument is wrong. + */ + void changeText( [in] long nPos, [in] long nLen, [in] string NewText, + [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** replace the attributes of the specific text with the given set of attributes. + + @param nPos + start index of the text. + + @param nLen + the length of the text. + + @param aAttributes + the given set of attributes e.g. Language. + + @throws IllegalArgumentException + when any argument is wrong. + */ + void changeAttributes( [in] long nPos, [in] long nLen, + [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** get a list of indexes that separate each two different languages + + @returns + a list of indices. + */ + sequence< long > getLanguagePortions(); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFlatParagraphIterator.idl b/offapi/com/sun/star/text/XFlatParagraphIterator.idl new file mode 100644 index 000000000..a50f457c0 --- /dev/null +++ b/offapi/com/sun/star/text/XFlatParagraphIterator.idl @@ -0,0 +1,96 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XFlatParagraphIterator_idl__ +#define __com_sun_star_text_XFlatParagraphIterator_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/text/XFlatParagraph.idl> + + +module com { module sun { module star { module text { + + +/** provides functionality to ... + + @since OOo 3.0 + */ + +interface XFlatParagraphIterator: com::sun::star::uno::XInterface +{ + + /** get the first flat paragraph to be checked or an empty reference if + there are no more paragraphs to check. + + @returns + the paragraph. + */ + com::sun::star::text::XFlatParagraph getFirstPara(); + + /** get the next flat paragraph to be checked or an empty reference if + there are no more paragraphs to check. + + @returns + the paragraph. + */ + com::sun::star::text::XFlatParagraph getNextPara(); + + /** get the last flat paragraph + + @returns + the paragraph. + */ + com::sun::star::text::XFlatParagraph getLastPara(); + + /** get the flat paragraph before this one + + @param xPara + the current flat paragraph + + @returns + the flat paragraph. + + @throws IllegalArgumentException + if any argument is wrong. + */ + com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** get the flat paragraph just following this one + + @param xPara + the current flat paragraph + + @returns + the flat paragraph. + + @throws IllegalArgumentException + if any argument is wrong. + */ + com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl b/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl new file mode 100644 index 000000000..f93a61749 --- /dev/null +++ b/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl @@ -0,0 +1,68 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__ +#define __com_sun_star_text_XFlatParagraphIteratorProvider_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/text/XFlatParagraphIterator.idl> + +//---------------------------------------Note---------------------------------- +// allows for different iterators for grammar checking and smart tags, +// interface must be implemented exactly once for each document since +// the interface pointer will be used to get a unique document id. + + +module com { module sun { module star { module text { + + +/** provides functionality to ... + + @since OOo 3.0 + */ + +interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface +{ + /** get XFlatParagraphIterator + + @param nType + Type of text markup see TextMarkupType. + + @param bAutomatic + Automatic or interactive checking. + + @returns + the iterator. + + @throws IllegalArgumentException + if any argument is wrong. + + */ + com::sun::star::text::XFlatParagraphIterator getFlatParagraphIterator( [in] long nType, + [in] boolean bAutomatic ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFootnote.idl b/offapi/com/sun/star/text/XFootnote.idl new file mode 100644 index 000000000..4fb215980 --- /dev/null +++ b/offapi/com/sun/star/text/XFootnote.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XFootnote_idl__ +#define __com_sun_star_text_XFootnote_idl__ + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** specifies a footnote within a Text.@see Footnote + */ +published interface XFootnote: com::sun::star::text::XTextContent +{ + /** @returns the label of the footnote. + + @see XFootnote::setLabel + */ + string getLabel(); + + /** sets the label of the footnote. + */ + void setLabel( [in] string aLabel ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl b/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl new file mode 100644 index 000000000..fa2b650e1 --- /dev/null +++ b/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XFootnotesSettingsSupplier_idl__ +#define __com_sun_star_text_XFootnotesSettingsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the FootnoteSettings + with the context (e.g. document). + */ +published interface XFootnotesSettingsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + FootnoteSettings of the object. + */ + com::sun::star::beans::XPropertySet getFootnotesSettings(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFootnotesSupplier.idl b/offapi/com/sun/star/text/XFootnotesSupplier.idl new file mode 100644 index 000000000..fdbd5b4c9 --- /dev/null +++ b/offapi/com/sun/star/text/XFootnotesSupplier.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XFootnotesSupplier_idl__ +#define __com_sun_star_text_XFootnotesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XIndexAccess.idl> + +#include <com/sun/star/beans/XPropertySet.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the footnotes within + the context (e.g. document). + */ +published interface XFootnotesSupplier: com::sun::star::uno::XInterface +{ + /** returns a collection of footnotes. + */ + com::sun::star::container::XIndexAccess getFootnotes(); + + /** @returns + the footnotes settings of the document. + */ + com::sun::star::beans::XPropertySet getFootnoteSettings(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XFormField.idl b/offapi/com/sun/star/text/XFormField.idl new file mode 100644 index 000000000..152b12b0b --- /dev/null +++ b/offapi/com/sun/star/text/XFormField.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XFormField_idl__ +#define __com_sun_star_text_XFormField_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/container/XNameContainer.idl> + +module com { module sun { module star { module text { + + /** @deprecated + */ + interface XFormField : com::sun::star::uno::XInterface + { + string getFieldType(); + void setFieldType([in] string fieldType); + com::sun::star::container::XNameContainer getParameters(); + }; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XLineNumberingProperties.idl b/offapi/com/sun/star/text/XLineNumberingProperties.idl new file mode 100644 index 000000000..f5cec957d --- /dev/null +++ b/offapi/com/sun/star/text/XLineNumberingProperties.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XLineNumberingProperties_idl__ +#define __com_sun_star_text_XLineNumberingProperties_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/XPropertySet.idl> + + + module com { module sun { module star { module text { + + +/** contains the settings of the line numbering in a text document. + */ +published interface XLineNumberingProperties: com::sun::star::uno::XInterface +{ + + /** @return + the LineNumberingProperties of the object. + */ + com::sun::star::beans::XPropertySet getLineNumberingProperties(); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XMailMergeBroadcaster.idl b/offapi/com/sun/star/text/XMailMergeBroadcaster.idl new file mode 100644 index 000000000..2e00e2034 --- /dev/null +++ b/offapi/com/sun/star/text/XMailMergeBroadcaster.idl @@ -0,0 +1,68 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XMailMergeBroadcaster_idl__ +#define __com_sun_star_text_XMailMergeBroadcaster_idl__ + + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/text/XMailMergeListener.idl> + +//module com { module sun { module star { module text { +// published interface XMailMergeListener; +//}; }; }; }; + + +module com { module sun { module star { module text { + +/** allows for adding/removing of mail merge event listeners. + + <p>Registered listeners will be notified with a + com::sun::star::text::MailMergeEvent + when a document is about to get merged.</p> + + @see com::sun::star::text::MailMergeEvent + @see com::sun::star::text::MailMerge + + @since OOo 1.1.2 +*/ +published interface XMailMergeBroadcaster : com::sun::star::uno::XInterface +{ + /** Adds an entry to the list of mail merge listeners. + + @param xListener + The listener to be added. + */ + void addMailMergeEventListener( + [in] com::sun::star::text::XMailMergeListener xListener ); + + /** Removes an entry to the list of mail merge listeners. + + @param xListener + The listener to be removed. + */ + void removeMailMergeEventListener( + [in] com::sun::star::text::XMailMergeListener xListener ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XMailMergeListener.idl b/offapi/com/sun/star/text/XMailMergeListener.idl new file mode 100644 index 000000000..664090568 --- /dev/null +++ b/offapi/com/sun/star/text/XMailMergeListener.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XMailMergeListener_idl__ +#define __com_sun_star_text_XMailMergeListener_idl__ + + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/text/MailMergeEvent.idl> + + + +module com { module sun { module star { module text { + +/** used to notify listeners about mail merge events. + + <p>Registered listeners will be notified with a + com::sun::star::text::MailMergeEvent + when a document is about to get merged.</p> + + @see com::sun::star::text::MailMerge + @see com::sun::star::text::MailMergeEvent + + @since OOo 1.1.2 +*/ +published interface XMailMergeListener : com::sun::star::uno::XInterface +{ + /** Notifies the listener about mail merge events. + + @param aEvent + The Event containing the model of the document to be merged + that is send to the listener. + */ + void notifyMailMergeEvent( + [in] com::sun::star::text::MailMergeEvent aEvent ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XMarkingAccess.idl b/offapi/com/sun/star/text/XMarkingAccess.idl new file mode 100644 index 000000000..35762b6d2 --- /dev/null +++ b/offapi/com/sun/star/text/XMarkingAccess.idl @@ -0,0 +1,37 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XMarkingAccess_idl__ +#define __com_sun_star_text_XMarkingAccess_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +module com { module sun { module star { module text { + +/** extends a text range by method to modify its position. + */ +interface XMarkingAccess +{ + void invalidateMarkings([in] long nType); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XMultiTextMarkup.idl b/offapi/com/sun/star/text/XMultiTextMarkup.idl new file mode 100644 index 000000000..c110ec78c --- /dev/null +++ b/offapi/com/sun/star/text/XMultiTextMarkup.idl @@ -0,0 +1,62 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XMultiTextMarkup_idl__ +#define __com_sun_star_text_XMultiTextMarkup_idl__ + +#include <com/sun/star/container/XStringKeyMap.idl> +#include <com/sun/star/text/TextMarkupDescriptor.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + +module com { module sun { module star { module text { + + +/** provides functionality to apply multiple text markups in one call. + + @since OOo 3.0.1 + */ + +interface XMultiTextMarkup +{ + /** submits multiple new markup ranges. + + <p>The main use of this function will probably be for proofreading to + allow for setting the markup of all found errors in a sentence in a single + call. For this the sequence needs to provide the markups for all errors along + with the markup for the identified sentence boundaries. + The order of those entries is arbitrary.</p> + + @param aMarkups + a sequence of single text markups. + + @see com::sun::star::text::XTextMarkup + @see com::sun::star::text::TextMarkupType + + */ + void commitMultiTextMarkup( + [in] sequence< com::sun::star::text::TextMarkupDescriptor > aMarkups ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XNumberingFormatter.idl b/offapi/com/sun/star/text/XNumberingFormatter.idl new file mode 100644 index 000000000..a44157922 --- /dev/null +++ b/offapi/com/sun/star/text/XNumberingFormatter.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XNumberingFormatter_idl__ +#define __com_sun_star_text_XNumberingFormatter_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/lang/Locale.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +module com { module sun { module star { module text { +/** + supports the formatting of numberings + in various language environments. + @see com::sun::star::text::NumberingRules + @see com::sun::star::text::NumberingLevel + @version 1.0 +*/ +published interface XNumberingFormatter : com::sun::star::uno::XInterface +{ +/** @returns + the formatted numbering string according to the given + com::sun::star::text::NumberingLevel + and the given com::sun::star::lang::Locale. +*/ + string makeNumberingString( + [in]sequence <com::sun::star::beans::PropertyValue> aProperties, + [in]com::sun::star::lang::Locale aLocale) + raises( com::sun::star::lang::IllegalArgumentException ); +}; +};};};}; +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XNumberingRulesSupplier.idl b/offapi/com/sun/star/text/XNumberingRulesSupplier.idl new file mode 100644 index 000000000..d3019ad8c --- /dev/null +++ b/offapi/com/sun/star/text/XNumberingRulesSupplier.idl @@ -0,0 +1,46 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XNumberingRulesSupplier_idl__ +#define __com_sun_star_text_XNumberingRulesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/container/XIndexAccess.idl> + + + +module com { module sun { module star { module text { + +/** This interface enables the object to handle numbering rules. + @see com::sun::star::text::NumberingRules +*/ +published interface XNumberingRulesSupplier : com::sun::star::uno::XInterface +{ + /** @returns + the collection of "NumberingRules" currently contained in the object. + */ + com::sun::star::container::XIndexAccess getNumberingRules(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XNumberingTypeInfo.idl b/offapi/com/sun/star/text/XNumberingTypeInfo.idl new file mode 100644 index 000000000..33f24eb1d --- /dev/null +++ b/offapi/com/sun/star/text/XNumberingTypeInfo.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XNumberingTypeInfo_idl__ +#define __com_sun_star_text_XNumberingTypeInfo_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +module com { module sun { module star { module text { + +/** provides access to the numbering types that are supported by a component. + <p>To be able to store unknown numbering types in a file format the numbering types + correspond to an identifier.</p> + @see com::sun::star::text::NumberingRules + @see com::sun::star::style::NumberingType + @version 1.0 +*/ +published interface XNumberingTypeInfo : com::sun::star::uno::XInterface +{ + /** returns the numbering type values that are supported by the component. + @see + */ + sequence<short> getSupportedNumberingTypes(); + /** returns the corresponding numbering type to an identifier. + */ + short getNumberingType([in]string NumberingIdentifier); + /** determines whether an identifier is supported. + */ + boolean hasNumberingType([in]string NumberingIdentifier); + /** returns the corresponding identifier to a numbering type. + */ + string getNumberingIdentifier([in]short NumberingType); +}; +};};};}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XPageCursor.idl b/offapi/com/sun/star/text/XPageCursor.idl new file mode 100644 index 000000000..9d65b326a --- /dev/null +++ b/offapi/com/sun/star/text/XPageCursor.idl @@ -0,0 +1,78 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XPageCursor_idl__ +#define __com_sun_star_text_XPageCursor_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + + +module com { module sun { module star { module text { + +/** makes it possible to perform cursor movements between pages. + */ +published interface XPageCursor: com::sun::star::uno::XInterface +{ + /** moves the cursor to the first page. + */ + boolean jumpToFirstPage(); + + /** moves the cursor to the last page. + */ + boolean jumpToLastPage(); + + /** moves the cursor to the specified page. + */ + boolean jumpToPage( [in] short nPage ); + + /** @returns + the number of the page within the document of this cursor. + */ + short getPage(); + + /** moves the cursor to the next page. + + @see XPageCursor::jumpToPreviousPage + */ + boolean jumpToNextPage(); + + /** moves the cursor to the previous page. + + @see XPageCursor::jumpToNextPage + */ + boolean jumpToPreviousPage(); + + /** moves the cursor to the end of the current page. + + @see XPageCursor::jumpToEndOfPreviousPage + */ + boolean jumpToEndOfPage(); + + /** moves the cursor to the start of the current page. + */ + boolean jumpToStartOfPage(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XPagePrintable.idl b/offapi/com/sun/star/text/XPagePrintable.idl new file mode 100644 index 000000000..49f3d8e21 --- /dev/null +++ b/offapi/com/sun/star/text/XPagePrintable.idl @@ -0,0 +1,74 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XPagePrintable_idl__ +#define __com_sun_star_text_XPagePrintable_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + + module com { module sun { module star { module text { + + +/** Print several pages on one printer page. + */ +published interface XPagePrintable: com::sun::star::uno::XInterface +{ + + /** @returns the settings of printing of pages. + <p> + These settings contains: + <UL> + <LI><P>short PageRows - number of rows of pages printed to one page </P> + <LI><P>short PageColumns - number of columns of pages printed to one page</P> + <LI><P>long LeftMargin - left margin of the page</P> + <LI><P>long RightMargin - right margin of the page</P> + <LI><P>long TopMargin - top margin of the page</P> + <LI><P>long BottomMargin - bottom margin of the page</P> + <LI><P>long HoriMargin - margin between rows of pages</P> + <LI><P>long VertMargin - margin between columns of pages</P> + <LI><P>boolean IsLandscape - determines if the output page is printed in landscape format</P> + </UL> + </p> + */ + sequence<com::sun::star::beans::PropertyValue> getPagePrintSettings(); + + /** adjusts the settings of the page printing. + @see getPagePrintSettings + */ + void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings ); + + /** prints the pages according to the PagePrintSettings. + + @see com::sun::star::view::PrintOptions + */ + void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) + raises( com::sun::star::lang::IllegalArgumentException ); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XParagraphAppend.idl b/offapi/com/sun/star/text/XParagraphAppend.idl new file mode 100644 index 000000000..5413a3f42 --- /dev/null +++ b/offapi/com/sun/star/text/XParagraphAppend.idl @@ -0,0 +1,79 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XParagraphAppend_idl__ +#define __com_sun_star_text_XParagraphAppend_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/beans/UnknownPropertyException.idl> + +#include <com/sun/star/text/XTextRange.idl> + + + module com { module sun { module star { module text { + + +/** allows inserting and appending paragraphs. + */ +interface XParagraphAppend : com::sun::star::uno::XInterface +{ + /** appends a new and empty paragraph at the end of the text. + + <p>The properties are applied to the last paragraph before the new paragraph is inserted. + </p> + + @param + CharacterAndParagraphProperties can contain all the properties defined by the service + Paragraph. + + */ + com::sun::star::text::XTextRange finishParagraph( [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException ); + + /** inserts a new and empty paragraph to the text at a given position. + + <p>The properties are applied to the last paragraph before the new paragraph is inserted. + </p> + + @param + CharacterAndParagraphProperties can contain all the properties defined by the service + Paragraph. + + @param + TextRange specifies the position of the insertion. + + @since LibreOffice 4.0 + + */ + com::sun::star::text::XTextRange finishParagraphInsert( [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties, + [in] com::sun::star::text::XTextRange TextRange ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XParagraphCursor.idl b/offapi/com/sun/star/text/XParagraphCursor.idl new file mode 100644 index 000000000..d7986130b --- /dev/null +++ b/offapi/com/sun/star/text/XParagraphCursor.idl @@ -0,0 +1,88 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XParagraphCursor_idl__ +#define __com_sun_star_text_XParagraphCursor_idl__ + +#include <com/sun/star/text/XTextCursor.idl> + + + + module com { module sun { module star { module text { + + +/** makes it possible to move paragraph by paragraph. + */ +published interface XParagraphCursor: com::sun::star::text::XTextCursor +{ + + /** determines if the cursor is positioned at the start of a paragraph. + */ + boolean isStartOfParagraph(); + + + /** determines if the cursor is positioned at the end of a paragraph. + */ + boolean isEndOfParagraph(); + + + /** moves the cursor to the start of the current paragraph. + + @returns + `TRUE` if the cursor is now at the start of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoStartOfParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the end of the current paragraph. + + @returns + `TRUE` if the cursor is now at the end of a paragraph, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoEndOfParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the next paragraph. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoNextParagraph( [in] boolean bExpand ); + + + /** moves the cursor to the previous paragraph. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoPreviousParagraph( [in] boolean bExpand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XPasteBroadcaster.idl b/offapi/com/sun/star/text/XPasteBroadcaster.idl new file mode 100644 index 000000000..faddd99b6 --- /dev/null +++ b/offapi/com/sun/star/text/XPasteBroadcaster.idl @@ -0,0 +1,42 @@ +/* -*- 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/. + */ +#ifndef __com_sun_star_text_XPasteBroadcaster_idl__ +#define __com_sun_star_text_XPasteBroadcaster_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/text/XPasteListener.idl> + +module com { module sun { module star { module text { + +/** allows for adding/removing of paste event listeners. + + @since LibreOffice 6.3 +*/ +interface XPasteBroadcaster : com::sun::star::uno::XInterface +{ + /** Adds an entry to the list of paste listeners. + + @param xListener + The listener to be added. + */ + void addPasteEventListener([in] com::sun::star::text::XPasteListener xListener); + + /** Removes an entry to the list of paste listeners. + + @param xListener + The listener to be removed. + */ + void removePasteEventListener( [in] com::sun::star::text::XPasteListener xListener ); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XPasteListener.idl b/offapi/com/sun/star/text/XPasteListener.idl new file mode 100644 index 000000000..b1a98cae5 --- /dev/null +++ b/offapi/com/sun/star/text/XPasteListener.idl @@ -0,0 +1,43 @@ +/* -*- 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/. + * + */ +#ifndef __com_sun_star_text_XPasteListener_idl__ +#define __com_sun_star_text_XPasteListener_idl__ + +#include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/uno/XInterface.idl> + +module com { module sun { module star { module text { + +/** used to notify listeners about paste events. + + @since LibreOffice 6.3 +*/ +interface XPasteListener : com::sun::star::uno::XInterface +{ + /** Notifies the listener about paste events. + + @param aEvent + The event containing details about the paste. + + <p>The following keys may be used: + <ul> + <li>TextRange</li> + <li>TextGraphicObject</li> + </ul></p> + */ + void notifyPasteEvent([in] sequence< ::com::sun::star::beans::PropertyValue > aEvent); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XRedline.idl b/offapi/com/sun/star/text/XRedline.idl new file mode 100644 index 000000000..a07c92ddf --- /dev/null +++ b/offapi/com/sun/star/text/XRedline.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XRedline_idl__ +#define __com_sun_star_text_XRedline_idl__ + +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + module com { module sun { module star { module text { + + +/** enables creation of redlines (change tracking). + */ +published interface XRedline +{ + + /** + @param RedlineType + <p> Valid type names are:</p> + <UL> + <LI><P>Insert - marks an insertion</P> + <LI><P>Delete - marks a deletion</P> + <LI><P>Format - marks an attribute change</P> + <LI><P>TextTable - marks a text table</P> + <LI><P>Style - marks an applied style</P> + </UL> + @param RedlineProperties + contains the following parameters + [readonly, property] string RedlineAuthor; + [readonly, property] com::sun::star::util::DateTime RedlineDateTime; + [readonly, property] string RedlineComment; + [readonly, optional, property] boolean RedlineMoved; + */ + void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues RedlineProperties) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XReferenceMarksSupplier.idl b/offapi/com/sun/star/text/XReferenceMarksSupplier.idl new file mode 100644 index 000000000..7daaf16eb --- /dev/null +++ b/offapi/com/sun/star/text/XReferenceMarksSupplier.idl @@ -0,0 +1,54 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XReferenceMarksSupplier_idl__ +#define __com_sun_star_text_XReferenceMarksSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the reference marks within this context (i.e. document). + + + + <p>A reference mark is used to refer to text positions in a text + document. + + </p> + */ +published interface XReferenceMarksSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of reference marks. + */ + com::sun::star::container::XNameAccess getReferenceMarks(); + +}; + + +}; }; }; }; + + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XRelativeTextContentInsert.idl b/offapi/com/sun/star/text/XRelativeTextContentInsert.idl new file mode 100644 index 000000000..55480d0ce --- /dev/null +++ b/offapi/com/sun/star/text/XRelativeTextContentInsert.idl @@ -0,0 +1,66 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XRelativeTextContentInsert_idl__ +#define __com_sun_star_text_XRelativeTextContentInsert_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + module com { module sun { module star { module text { + + published interface XTextContent; + +/** makes it possible to insert new text contents before or + after existing text contents. + + + + + + + + @deprecated + */ +published interface XRelativeTextContentInsert: com::sun::star::uno::XInterface +{ + /** inserts text the new text content before of the successor argument. + + <p> This is helpful to insert paragraphs before of text tables. </p> + */ + void insertTextContentBefore( + [in] XTextContent xNewContent, + [in] XTextContent xSuccessor ) + raises( com::sun::star::lang::IllegalArgumentException ); + /** inserts text the new text content after the predecessor argument. + + <p> This is helpful to insert paragraphs after text tables especially in + headers, footers or text frames. </p> + */ + void insertTextContentAfter( + [in] XTextContent xNewContent, + [in] XTextContent xPredecessor ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + +};};};}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XRelativeTextContentRemove.idl b/offapi/com/sun/star/text/XRelativeTextContentRemove.idl new file mode 100644 index 000000000..effc94946 --- /dev/null +++ b/offapi/com/sun/star/text/XRelativeTextContentRemove.idl @@ -0,0 +1,62 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XRelativeTextContentRemove_idl__ +#define __com_sun_star_text_XRelativeTextContentRemove_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + module com { module sun { module star { module text { + + published interface XTextContent; +/** makes it possible to remove text contents before or + after existing text contents. + + + + + + + + @deprecated + */ +published interface XRelativeTextContentRemove: com::sun::star::uno::XInterface +{ + /** removes the text content that precedes the argument. + + <p> This is helpful to remove empty paragraphs before text tables. </p> + */ + void removeTextContentBefore( + [in] XTextContent xSuccessor ) + raises( com::sun::star::lang::IllegalArgumentException ); + /** removes the text content that follows the argument. + + <p> This is helpful to remove empty paragraphs following text tables especially in + headers, footers or text frames. </p> + */ + void removeTextContentAfter( + [in] XTextContent xPredecessor ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; +};};};}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XRubySelection.idl b/offapi/com/sun/star/text/XRubySelection.idl new file mode 100644 index 000000000..3d04094f3 --- /dev/null +++ b/offapi/com/sun/star/text/XRubySelection.idl @@ -0,0 +1,59 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XRubySelection_idl__ +#define __com_sun_star_text_XRubySelection_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + + + + module com { module sun { module star { module text { + + +/** This interface enables the object to handle list of ruby lines (aka Furigana lines). + + */ +published interface XRubySelection : com::sun::star::uno::XInterface +{ + /** returns a sequence of ruby elements. + <p>Each element contains at least a string that contains the selected text and the ruby text. + Additional parameters can be the ruby adjustment, the name of a character style.</p> + @returns + a sequence of ruby properties + @param Automatic + if Automatic is set the selection is parsed for words and applied ruby attributes + */ + sequence<com::sun::star::beans::PropertyValues> getRubyList( [in] boolean Automatic ); + /** applies the RubyList to the current selection. The number of elements must be + equal to the number of elements that are returned by getRubyList. Automatic must be + set equally, too. + */ + void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic ); + +}; + + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XSentenceCursor.idl b/offapi/com/sun/star/text/XSentenceCursor.idl new file mode 100644 index 000000000..d8a0da6f0 --- /dev/null +++ b/offapi/com/sun/star/text/XSentenceCursor.idl @@ -0,0 +1,88 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XSentenceCursor_idl__ +#define __com_sun_star_text_XSentenceCursor_idl__ + +#include <com/sun/star/text/XTextCursor.idl> + + + + module com { module sun { module star { module text { + + +/** makes it possible to perform cursor movements through sentences. + */ +published interface XSentenceCursor: com::sun::star::text::XTextCursor +{ + + /** determines if the cursor is positioned at the start of a sentence. + */ + boolean isStartOfSentence(); + + + /** determines if the cursor is positioned at the end of a sentence. + */ + boolean isEndOfSentence(); + + + /** moves the cursor to the start of the next sentence. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoNextSentence( [in] boolean Expand ); + + + /** moves the cursor to the start of the previous sentence. + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoPreviousSentence( [in] boolean Expand ); + + + /** moves the cursor to the start of the current sentence. + + @returns + `TRUE` if the cursor is now at the start of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoStartOfSentence( [in] boolean Expand ); + + + /** moves the cursor to the end of the current sentence. + + @returns + `TRUE` if the cursor is now at the end of a sentence, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoEndOfSentence( [in] boolean Expand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XSimpleText.idl b/offapi/com/sun/star/text/XSimpleText.idl new file mode 100644 index 000000000..f93339180 --- /dev/null +++ b/offapi/com/sun/star/text/XSimpleText.idl @@ -0,0 +1,127 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XSimpleText_idl__ +#define __com_sun_star_text_XSimpleText_idl__ + +#include <com/sun/star/text/XTextRange.idl> + +#include <com/sun/star/text/XTextCursor.idl> + +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/text/XTextContent.idl> + +#include <com/sun/star/container/NoSuchElementException.idl> + + + + module com { module sun { module star { module text { + + +/** is the main interface for a distinct text unit, i.e. the main text of + a document, the text for headers and footers or for single cells of a + table.@see XText + */ +published interface XSimpleText: com::sun::star::text::XTextRange +{ + + /** @returns + a new instance of a TextCursor service which can + be used to travel in the given text context. + + @see com::sun::star::text::TextCursor + */ + com::sun::star::text::XTextCursor createTextCursor(); + + + /** @returns + a new instance of a TextCursor which is located + at the specified TextRange to travel in the + given text context. + + <p>The initial position is set to <var>aTextPosition</var>. + + @param aTextPosition + specifies the start position for the new + TextCursor. + + @see com::sun::star::text::TextCursor + */ + com::sun::star::text::XTextCursor createTextCursorByRange( [in] com::sun::star::text::XTextRange aTextPosition ); + + + /** inserts a string of characters into the text. + + <p>The string may contain the following white spaces: + </p> + <ul> + <li>blank</li> + <li>tab</li> + <li>cr (which will insert a paragraph break)</li> + <li>lf (which will insert a line break)</li> + </ul> + + @param xRange + specifies the position of insertion. For example, + XSimpleText::createTextCursor() can be used to + get an XTextRange for this argument. + + <p>If the parameter bAbsorb() was `TRUE` + the text range will contain the new inserted string, otherwise + the range (and it's text) will remain unchanged. + + @param aString + specifies the string to insert. + + @param bAbsorb + specifies whether the text spanned by <var>xRange</var> will be + replaced. If `TRUE` then the content of <var>xRange</var> will + be replaced by <var>aString</var>, otherwise <var>aString</var> + will be inserted at the beginning of <var>xRange</var>. + + @code{.java} + xText.insertString( xTextCursor, "Hello " + aName + ",", false ) + + xText.insertControlCharacter( xTextCursor, + ControlCharacter.PARAGRAPH_BREAK, false ); + + xText.insertString( xTextCursor, "more text ...", false ) + @endcode + */ + void insertString( [in] com::sun::star::text::XTextRange xRange, + [in] string aString, + [in] boolean bAbsorb ); + + + /** inserts a control character (like a paragraph break or a hard + space) into the text.@see com::sun::star::text::ControlCharacter + */ + void insertControlCharacter( [in] com::sun::star::text::XTextRange xRange, + [in] short nControlCharacter, + [in] boolean bAbsorb ) + raises( com::sun::star::lang::IllegalArgumentException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XText.idl b/offapi/com/sun/star/text/XText.idl new file mode 100644 index 000000000..2e4a629a4 --- /dev/null +++ b/offapi/com/sun/star/text/XText.idl @@ -0,0 +1,84 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XText_idl__ +#define __com_sun_star_text_XText_idl__ + +#include <com/sun/star/text/XSimpleText.idl> + +#include <com/sun/star/text/XTextCursor.idl> + +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/text/XTextContent.idl> + +#include <com/sun/star/container/NoSuchElementException.idl> + + + + module com { module sun { module star { module text { + + +/** extends a XSimpleText by the capability of inserting + XTextContents. + */ +published interface XText: com::sun::star::text::XSimpleText +{ + + /** inserts a content, such as a text table, text frame or text + field. + + <p>Which contents are accepted is implementation-specific. Some + implementations may only accept contents which were created by the + factory that supplied the same text or the document which contains + the text. + </p> + + @param xRange + specifies the position of insertion. + + @param xContent + the text content to be inserted. + + @param bAbsorb + specifies whether the text spanned by <var>xRange</var> will be + replaced. If `TRUE` then the content of <var>xRange</var> will + be replaced by <var>xContent</var>, otherwise <var>xContent</var> + will be inserted at the end of <var>xRange</var>. + */ + void insertTextContent( [in] com::sun::star::text::XTextRange xRange, + [in] com::sun::star::text::XTextContent xContent, + [in] boolean bAbsorb ) + raises( com::sun::star::lang::IllegalArgumentException ); + + + /** removes the specified content from the text object. + @param xContent + the content that is to be removed. + */ + void removeTextContent( [in] com::sun::star::text::XTextContent xContent ) + raises( com::sun::star::container::NoSuchElementException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextAppend.idl b/offapi/com/sun/star/text/XTextAppend.idl new file mode 100644 index 000000000..bac545c31 --- /dev/null +++ b/offapi/com/sun/star/text/XTextAppend.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextAppend_idl__ +#define __com_sun_star_text_XTextAppend_idl__ + + +#include <com/sun/star/text/XText.idl> +#include <com/sun/star/text/XTextPortionAppend.idl> +#include <com/sun/star/text/XParagraphAppend.idl> + + + module com { module sun { module star { module text { + + +/** is a meta-interface for manipulating and inserting text. + */ + interface XTextAppend +{ + interface com::sun::star::text::XText; + interface com::sun::star::text::XParagraphAppend; + interface com::sun::star::text::XTextPortionAppend ; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextAppendAndConvert.idl b/offapi/com/sun/star/text/XTextAppendAndConvert.idl new file mode 100644 index 000000000..e4ae77854 --- /dev/null +++ b/offapi/com/sun/star/text/XTextAppendAndConvert.idl @@ -0,0 +1,46 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextAppendAndConvert_idl__ +#define __com_sun_star_text_XTextAppendAndConvert_idl__ + + +#include <com/sun/star/text/XTextAppend.idl> +#include <com/sun/star/text/XTextContentAppend.idl> +#include <com/sun/star/text/XTextConvert.idl> + + + module com { module sun { module star { module text { + + +/** merges the functions of XTextAppend, + XTextContentAppend and XTextConvert. + */ + interface XTextAppendAndConvert +{ + interface com::sun::star::text::XTextAppend; + interface com::sun::star::text::XTextContentAppend; + interface com::sun::star::text::XTextConvert; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextColumns.idl b/offapi/com/sun/star/text/XTextColumns.idl new file mode 100644 index 000000000..e92a248b1 --- /dev/null +++ b/offapi/com/sun/star/text/XTextColumns.idl @@ -0,0 +1,85 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextColumns_idl__ +#define __com_sun_star_text_XTextColumns_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/TextColumn.idl> + + + + module com { module sun { module star { module text { + +/** manages columns within the object. + + + + <p>The values used are relative. So it is not necessary to know the + width of the object. The sum of the relative width values depends on + the object and is defined in "ReferenceValue." + + </p> + */ +published interface XTextColumns: com::sun::star::uno::XInterface +{ + /** @returns + the sum of all values. + + <p>As described above, the width values are relative. + */ + long getReferenceValue(); + + /** @returns + the number of columns. + */ + short getColumnCount(); + + /** sets the number of columns. + + + + <p>The minimum is 1 column.</p> + */ + void setColumnCount( [in] short nColumns ); + + /** returns the column description of the object. + @see TextColumn + */ + sequence<com::sun::star::text::TextColumn> getColumns(); + + /** sets the descriptors of all columns. + + + + <p>The number of members in the sequence must be the same as the + number of columns of the object. + + </p>@see TextColumn + */ + void setColumns( [in] sequence<com::sun::star::text::TextColumn> Columns ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextContent.idl b/offapi/com/sun/star/text/XTextContent.idl new file mode 100644 index 000000000..9cb28cb88 --- /dev/null +++ b/offapi/com/sun/star/text/XTextContent.idl @@ -0,0 +1,74 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextContent_idl__ +#define __com_sun_star_text_XTextContent_idl__ + +#include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/text/XTextRange.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + + module com { module sun { module star { module text { + + +/** enables objects to be inserted into a text and to provide their + location in a text once they are inserted into it. + */ +published interface XTextContent: com::sun::star::lang::XComponent +{ + + /** is called when this object gets embedded in a text. + + <p>This acts like a multi-phase construction, thus the object may be + invalid until it is attached to a text position. Usually this method + is called from within XText::insertTextContent(). + </p> + + <p>Both text objects and text content objects may only be connected + to each other if they are created by the same component. When + implementing new components, this behavior is deprecated.</p> + */ + void attach( [in] com::sun::star::text::XTextRange xTextRange ) + raises( com::sun::star::lang::IllegalArgumentException ); + + + /** @returns + the text range to which the content is attached. + + <p>Note: The anchor of the actual implementation for text tables + does not have a position in the text. Thus that anchor can not be + used for some operation like attach() for example or + com::sun::star::text::insertTextContent + or other function that require the object to have a position in the text.</p> + + <p>The reason why a text table still needs an anchor is that for example + tables should be insertable via com::sun::star::text::insertTextContent + and that interface uses a parameter of that type.</p> + */ + com::sun::star::text::XTextRange getAnchor(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextContentAppend.idl b/offapi/com/sun/star/text/XTextContentAppend.idl new file mode 100644 index 000000000..d28f6d62d --- /dev/null +++ b/offapi/com/sun/star/text/XTextContentAppend.idl @@ -0,0 +1,86 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextContentAppend_idl__ +#define __com_sun_star_text_XTextContentAppend_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> + +#include <com/sun/star/beans/UnknownPropertyException.idl> +#include <com/sun/star/text/XTextContent.idl> + + + module com { module sun { module star { module text { + + +/** allows inserting and appending text content. + */ +interface XTextContentAppend : com::sun::star::uno::XInterface +{ + + /** appends a text content at the end of the text. + + <p> The sequence can contain all the properties defined by the service + Paragraph. + </p> + + @param TextContent + contains the object to be inserted. + @param CharacterAndParagraphProperties + can contain all the properties defined by the service + Paragraph. + @return + the anchor text range of the inserted text content. + */ + com::sun::star::text::XTextRange appendTextContent( + [in] com::sun::star::text::XTextContent TextContent, + [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException ); + + /** inserts a text content at the given position. + + @param TextContent + contains the object to be inserted. + @param CharacterAndParagraphProperties + can contain all the properties defined by the service + Paragraph. + @param TextRange + insert position + @return + the anchor text range of the inserted text content. + + @since LibreOffice 4.0 + */ + com::sun::star::text::XTextRange insertTextContentWithProperties( + [in] com::sun::star::text::XTextContent TextContent, + [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties, + [in] com::sun::star::text::XTextRange TextRange ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextConvert.idl b/offapi/com/sun/star/text/XTextConvert.idl new file mode 100644 index 000000000..2de810cf5 --- /dev/null +++ b/offapi/com/sun/star/text/XTextConvert.idl @@ -0,0 +1,92 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextConvert_idl__ +#define __com_sun_star_text_XTextConvert_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/PropertyVetoException,idl> +#include <com/sun/star/beans/UnknownPropertyException.idl> +#include <com/sun/star/text/XTextRange.idl> +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/text/XTextTable.idl> + + + + + module com { module sun { module star { module text { + + +/** allows converting selections of text to frames or tables. + */ +interface XTextConvert : com::sun::star::uno::XInterface +{ + + /** moves the paragraphs from Start to End into a text frame. + + + @param Start start position of frame content + + @param End end position of frame content + + @param FrameProperties + contains the properties of the to-be-created text frame + + @return the newly created text frame + + */ + ::com::sun::star::text::XTextContent convertToTextFrame( + [in] com::sun::star::text::XTextRange Start, + [in] com::sun::star::text::XTextRange End, + [in] com::sun::star::beans::PropertyValues FrameProperties ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException, + com::sun::star::beans::PropertyVetoException ); + + /** converts the paragraphs marked in TableRanges into a table. + + + @param TableRanges contains the TextRange interfaces of the paragraphs, cells and rows of the table. + <p>The inner sequence contains the start and end paragraphs of each table cell. + The next sequence groups the cells to a row and the outer sequence groups the rows of the table.</p> + + @param CellProperties contains the properties of each cell. + @param RowProperties contains the properties of each table row. + @param TableProperties contains the properties of the table. + @return the created table. + + */ + ::com::sun::star::text::XTextTable convertToTable( + [in] sequence< sequence< sequence< com::sun::star::text::XTextRange > > > TableRanges, + [in] sequence< sequence< com::sun::star::beans::PropertyValues > > CellProperties, + [in] sequence< com::sun::star::beans::PropertyValues > RowProperties, + [in] com::sun::star::beans::PropertyValues TableProperties ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException ); + + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextCopy.idl b/offapi/com/sun/star/text/XTextCopy.idl new file mode 100644 index 000000000..6530b12b1 --- /dev/null +++ b/offapi/com/sun/star/text/XTextCopy.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextCopy_idl__ +#define __com_sun_star_text_XTextCopy_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + + module com { module sun { module star { module text { + + +/** enables a text object to copy attributed text from another text object. + */ +published interface XTextCopy: com::sun::star::uno::XInterface +{ + + /** copies the content from another text object. + + @param xSource + specifies the source text object. + */ + void copyText( [in] com::sun::star::text::XTextCopy xSource ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextCursor.idl b/offapi/com/sun/star/text/XTextCursor.idl new file mode 100644 index 000000000..42f8465fd --- /dev/null +++ b/offapi/com/sun/star/text/XTextCursor.idl @@ -0,0 +1,115 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextCursor_idl__ +#define __com_sun_star_text_XTextCursor_idl__ + +#include <com/sun/star/text/XTextRange.idl> + + + + module com { module sun { module star { module text { + + +/** extends a text range by method to modify its position. + */ +published interface XTextCursor: com::sun::star::text::XTextRange +{ + + /** sets the end of the position to the start. + */ + void collapseToStart(); + + + /** sets the start of the position to the end. + */ + void collapseToEnd(); + + + /** determines if the start and end positions are the same. + */ + boolean isCollapsed(); + + + /** moves the cursor the specified number of characters to the left. + + @param nCount + the number of characters to move. + + @param bExpand + specifies if the current selection of the cursor should + be expanded or not. + + @returns + `TRUE` if the command was successfully completed. + `FALSE` otherwise. + + <p>Note: Even if the command was not completed successfully + it may be completed partially. E.g. if it was required to move + 5 characters but it is only possible to move 3 `FALSE` will + be returned and the cursor moves only those 3 characters.<p> + */ + boolean goLeft( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor the specified number of characters to the right. + + @param nCount + the number of characters to move. + + @param bExpand + specifies if the current selection of the cursor should + be expanded or not. + + @returns + `TRUE` if the command was successfully completed. + `FALSE` otherwise. + + <p>Note: Even if the command was not completed successfully + it may be completed partially. E.g. if it was required to move + 5 characters but it is only possible to move 3 `FALSE` will + be returned and the cursor moves only those 3 characters.<p> + */ + boolean goRight( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor to the start of the text. + */ + void gotoStart( [in] boolean bExpand ); + + + /** moves the cursor to the end of the text. + */ + void gotoEnd( [in] boolean bExpand ); + + + /** moves or expands the cursor to a specified TextRange. + */ + void gotoRange( [in] com::sun::star::text::XTextRange xRange, + [in] boolean bExpand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextDocument.idl b/offapi/com/sun/star/text/XTextDocument.idl new file mode 100644 index 000000000..187b37272 --- /dev/null +++ b/offapi/com/sun/star/text/XTextDocument.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextDocument_idl__ +#define __com_sun_star_text_XTextDocument_idl__ + +#include <com/sun/star/frame/XModel.idl> + +#include <com/sun/star/text/XText.idl> + + + + module com { module sun { module star { module text { + +/** is the main interface of a text document.@see com::sun::star::text::TextDocument + */ +published interface XTextDocument: com::sun::star::frame::XModel +{ + /** @returns + the major com::sun::star::text::Text of the text document. + + <p>This text does not contain texts in TextFrames, + or cells of TextTables etc. directly. These are + accessible from the contents via <code>X...Supplier</code> + (e.g. XTextTablesSupplier). + */ + com::sun::star::text::XText getText(); + + /** reformats the contents of the document. + */ + void reformat(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextEmbeddedObjectsSupplier.idl b/offapi/com/sun/star/text/XTextEmbeddedObjectsSupplier.idl new file mode 100644 index 000000000..950aa6e68 --- /dev/null +++ b/offapi/com/sun/star/text/XTextEmbeddedObjectsSupplier.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextEmbeddedObjectsSupplier_idl__ +#define __com_sun_star_text_XTextEmbeddedObjectsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides the collection of all embedded objects within this context + (i.e. this document). + */ +published interface XTextEmbeddedObjectsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of embedded objects. + */ + com::sun::star::container::XNameAccess getEmbeddedObjects(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextField.idl b/offapi/com/sun/star/text/XTextField.idl new file mode 100644 index 000000000..fdcd68899 --- /dev/null +++ b/offapi/com/sun/star/text/XTextField.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextField_idl__ +#define __com_sun_star_text_XTextField_idl__ + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** is the base interface for all text fields. + + + + <p>A text field is embedded in text and expands to a sequence of + characters. + + </p>@see TextField + */ +published interface XTextField: com::sun::star::text::XTextContent +{ + /** @returns the display string of the text field either as the command + of the field or as the output string. + @param bShowCommand + if `TRUE` the command of the field will be returned + */ + string getPresentation( [in] boolean bShowCommand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextFieldsSupplier.idl b/offapi/com/sun/star/text/XTextFieldsSupplier.idl new file mode 100644 index 000000000..e5edc36ea --- /dev/null +++ b/offapi/com/sun/star/text/XTextFieldsSupplier.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextFieldsSupplier_idl__ +#define __com_sun_star_text_XTextFieldsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the text fields used in this context + (e.g. this document).@see com::sun::star::sheet::SpreadsheetDocument + @see TextDocument + */ +published interface XTextFieldsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of TextField instances + in this context (i.e. this document). + */ + com::sun::star::container::XEnumerationAccess getTextFields(); + + /** @returns + the collection of TextFieldMaster instances + which are defined in this context (i.e. this document). + */ + com::sun::star::container::XNameAccess getTextFieldMasters(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextFrame.idl b/offapi/com/sun/star/text/XTextFrame.idl new file mode 100644 index 000000000..94ed9e2ac --- /dev/null +++ b/offapi/com/sun/star/text/XTextFrame.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextFrame_idl__ +#define __com_sun_star_text_XTextFrame_idl__ + +#include <com/sun/star/text/XTextContent.idl> +#include <com/sun/star/text/XText.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the Text of a TextFrame. + @see TextFrame + */ +published interface XTextFrame: com::sun::star::text::XTextContent +{ + /** @returns + the text within this frame. The returned interface belongs + to an object which implements the service Text. + */ + com::sun::star::text::XText getText(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextFramesSupplier.idl b/offapi/com/sun/star/text/XTextFramesSupplier.idl new file mode 100644 index 000000000..b60ce9dc9 --- /dev/null +++ b/offapi/com/sun/star/text/XTextFramesSupplier.idl @@ -0,0 +1,46 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextFramesSupplier_idl__ +#define __com_sun_star_text_XTextFramesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to access the TextFrame instances in this + context (e.g. document). + */ +published interface XTextFramesSupplier: com::sun::star::uno::XInterface +{ + /** returns a collection of text frames. + */ + com::sun::star::container::XNameAccess getTextFrames(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextGraphicObjectsSupplier.idl b/offapi/com/sun/star/text/XTextGraphicObjectsSupplier.idl new file mode 100644 index 000000000..fc7635ae8 --- /dev/null +++ b/offapi/com/sun/star/text/XTextGraphicObjectsSupplier.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextGraphicObjectsSupplier_idl__ +#define __com_sun_star_text_XTextGraphicObjectsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides access to the collection of all embedded and linked graphics + within this context (i.e. within this document). + */ +published interface XTextGraphicObjectsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of graphic objects in this object (document). + */ + com::sun::star::container::XNameAccess getGraphicObjects(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextMarkup.idl b/offapi/com/sun/star/text/XTextMarkup.idl new file mode 100644 index 000000000..ee977897f --- /dev/null +++ b/offapi/com/sun/star/text/XTextMarkup.idl @@ -0,0 +1,82 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_XTextMarkup_idl__ +#define __com_sun_star_text_XTextMarkup_idl__ + +#include <com/sun/star/container/XStringKeyMap.idl> +#include <com/sun/star/text/TextMarkupType.idl> +#include <com/sun/star/text/XTextRange.idl> + + +module com { module sun { module star { module text { + + +/** provides functionality to markup text. + + @since OOo 2.3 + */ + +interface XTextMarkup +{ + /** obtains a container to store additional user defined text markup + information. + + @return + a container to store additional user defined text markup + information. + */ + com::sun::star::container::XStringKeyMap getMarkupInfoContainer(); + + + /** submits a new markup range. + + @param nType + Type of text markup see TextMarkupType. + + @param aIdentifier + A string used to identify the caller. + + @param nStart + Start of the markup range. + + @param nLength + Length of the markup range. + + @param xMarkupInfoContainer + contains additional information about the markup. + */ + void commitStringMarkup( [in] long nType, + [in] string aIdentifier, + [in] long nStart, + [in] long nLength, + [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer ); + + void commitTextRangeMarkup( [in] long nType, + [in] string aIdentifier, + [in] com::sun::star::text::XTextRange xRange, + [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer ); + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextPortionAppend.idl b/offapi/com/sun/star/text/XTextPortionAppend.idl new file mode 100644 index 000000000..8930ab897 --- /dev/null +++ b/offapi/com/sun/star/text/XTextPortionAppend.idl @@ -0,0 +1,90 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextPortionAppend_idl__ +#define __com_sun_star_text_XTextPortionAppend_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/UnknownPropertyException.idl> +#include <com/sun/star/beans/PropertyVetoException,idl> +#include <com/sun/star/text/XTextRange.idl> + + + module com { module sun { module star { module text { + + +/** allows inserting and appending formatted text portions. + */ +interface XTextPortionAppend : com::sun::star::uno::XInterface +{ + + /** appends a new text portion to the paragraph at the end of the text. + + <p> The sequence can contain all the properties defined by the service TextPortion. + </p> + + @param + Text contains the text to be appended. + + @param + CharacterAndParagraphProperties can contain all the properties defined by the service + Paragraph. + */ + com::sun::star::text::XTextRange appendTextPortion( + [in] string Text, + [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException, + com::sun::star::beans::PropertyVetoException ); + + /** inserts a new text portion to the paragraph at a given position. + + <p> The sequence can contain all the properties defined by the service TextPortion. + </p> + + @param + Text contains the text to be inserted. + + @param + CharacterAndParagraphProperties can contain all the properties defined by the service + Paragraph. + + @param + TextRange specifies the position of the insert. + + @since LibreOffice 4.0 + + */ + com::sun::star::text::XTextRange insertTextPortion( + [in] string Text, + [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties, + [in] com::sun::star::text::XTextRange TextRange) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::beans::UnknownPropertyException, + com::sun::star::beans::PropertyVetoException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextRange.idl b/offapi/com/sun/star/text/XTextRange.idl new file mode 100644 index 000000000..e53e23925 --- /dev/null +++ b/offapi/com/sun/star/text/XTextRange.idl @@ -0,0 +1,76 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextRange_idl__ +#define __com_sun_star_text_XTextRange_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + + module com { module sun { module star { module text { + + published interface XText; + +/** describes the object's position in a text. + + + + <p>It represents a text range. The beginning and end of the range may + be identical. + </p> + */ +published interface XTextRange: com::sun::star::uno::XInterface +{ + /** @returns + the text interface in which the text position is contained. + */ + XText getText(); + + /** @returns + a text range which contains only the start of this text range. + */ + XTextRange getStart(); + + /** @returns + a text range which contains only the end of this text range. + */ + XTextRange getEnd(); + + /** @returns + the string that is included in this text range. + */ + string getString(); + + /** the whole string of characters of this piece of text is replaced. + + + + <p>All styles are removed when applying this method. + + </p> + */ + void setString( [in] string aString ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextRangeCompare.idl b/offapi/com/sun/star/text/XTextRangeCompare.idl new file mode 100644 index 000000000..b79c709a7 --- /dev/null +++ b/offapi/com/sun/star/text/XTextRangeCompare.idl @@ -0,0 +1,73 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextRangeCompare_idl__ +#define __com_sun_star_text_XTextRangeCompare_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/lang/IllegalArgumentException.idl> + + + module com { module sun { module star { module text { + + published interface XText; + published interface XTextRange; + +/** compares the positions of two TextRanges within a + Text. + + + + <p>Only TextRange instances within the same Text + can be compared. + </p> + */ +published interface XTextRangeCompare: com::sun::star::uno::XInterface +{ + /** @returns + 1 if <var>xR1</var> starts before <var>xR2</var>, + 0 if <var>xR1</var> starts at the same position as <var>xR2</var> and + -1 if <var>xR1</var> starts behind <var>xR2</var>. + + @throws com::sun::star::lang::IllegalArgumentException + if either <var>xR1</var> or <var>xR2</var> is not within this + text. + */ + short compareRegionStarts( [in] XTextRange xR1, [in] XTextRange xR2 ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** @returns + 1, if <var>xR1</var> ends before <var>xR2</var>, + 0, if <var>xR1</var> ends at the same position as <var>xR2</var> and + -1, if <var>xR1</var> ends behind <var>xR2</var>. + + @throws com::sun::star::lang::IllegalArgumentException + if either <var>xR1</var> or <var>xR2</var> is not within this + text. + */ + short compareRegionEnds( [in] XTextRange xR1, [in] XTextRange xR2 ) + raises( com::sun::star::lang::IllegalArgumentException ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextRangeMover.idl b/offapi/com/sun/star/text/XTextRangeMover.idl new file mode 100644 index 000000000..afaf4115e --- /dev/null +++ b/offapi/com/sun/star/text/XTextRangeMover.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextRangeMover_idl__ +#define __com_sun_star_text_XTextRangeMover_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/XTextRange.idl> + + + + module com { module sun { module star { module text { + +/** makes it possible to move a text range (e.g. a paragraph by itself) + within this text. + + + + <p>The movement is specified by the number of paragraphs within the order + of paragraphs. + + </p>@see Text + */ +published interface XTextRangeMover: com::sun::star::uno::XInterface +{ + /** moves the contents to which <var>xRange</var> refers forward or + backward. + */ + void moveTextRange( [in] com::sun::star::text::XTextRange xRange, + [in] short nParagraphs ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextSection.idl b/offapi/com/sun/star/text/XTextSection.idl new file mode 100644 index 000000000..d249d8cc0 --- /dev/null +++ b/offapi/com/sun/star/text/XTextSection.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextSection_idl__ +#define __com_sun_star_text_XTextSection_idl__ + +#include <com/sun/star/text/XTextContent.idl> + + + + module com { module sun { module star { module text { + +/** provide special data of a TextSection.@see TextSection + */ +published interface XTextSection: com::sun::star::text::XTextContent +{ + /** If the object is a child section, then this method returns + the parent text section. + */ + com::sun::star::text::XTextSection getParentSection(); + + /** @returns + all text sections that are children of this text section (recursive). + */ + sequence<com::sun::star::text::XTextSection> getChildSections(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextSectionsSupplier.idl b/offapi/com/sun/star/text/XTextSectionsSupplier.idl new file mode 100644 index 000000000..58ed2fd47 --- /dev/null +++ b/offapi/com/sun/star/text/XTextSectionsSupplier.idl @@ -0,0 +1,46 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextSectionsSupplier_idl__ +#define __com_sun_star_text_XTextSectionsSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + +/** manages the text sections within the context (i.e. the document). + */ +published interface XTextSectionsSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of text sections. + */ + com::sun::star::container::XNameAccess getTextSections(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextShapesSupplier.idl b/offapi/com/sun/star/text/XTextShapesSupplier.idl new file mode 100644 index 000000000..0994dd107 --- /dev/null +++ b/offapi/com/sun/star/text/XTextShapesSupplier.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextShapesSupplier_idl__ +#define __com_sun_star_text_XTextShapesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XIndexAccess.idl> + + + + module com { module sun { module star { module text { + +/** provides the collection of com::sun::star::drawing::TextShapes. + */ +published interface XTextShapesSupplier: com::sun::star::uno::XInterface +{ + /** returns the collection of shapes. + + @see com::sun::star::drawing::DrawPage + */ + com::sun::star::container::XIndexAccess getShapes(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextTable.idl b/offapi/com/sun/star/text/XTextTable.idl new file mode 100644 index 000000000..559b45929 --- /dev/null +++ b/offapi/com/sun/star/text/XTextTable.idl @@ -0,0 +1,118 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextTable_idl__ +#define __com_sun_star_text_XTextTable_idl__ + +#include <com/sun/star/text/XTextContent.idl> + +#include <com/sun/star/table/XTableRows.idl> + +#include <com/sun/star/table/XTableColumns.idl> + +#include <com/sun/star/table/XCell.idl> + +#include <com/sun/star/text/XTextTableCursor.idl> + + + + module com { module sun { module star { module text { + + +/** manages a text table. + + @see com::sun::star::text::TextTable + @see com::sun::star::text::Cell + */ +published interface XTextTable: com::sun::star::text::XTextContent +{ + + /** determines the numbers of rows and columns of the text table. + + <p> This method must be called after the object is created and + before the object is insert or attached elsewhere. + </p> + */ + void initialize( [in] long nRows, + [in] long nColumns ); + + + /** @returns + the access object for the text table rows. + + @see com::sun::star::table::XTableRows + */ + com::sun::star::table::XTableRows getRows(); + + + /** @returns + the access object for the text table columns. + + @see com::sun::star::table::XTableColumns + */ + com::sun::star::table::XTableColumns getColumns(); + + + /** @returns + the com::sun::star::table::XCell interface of the cell with the specified name. + + @param aCellName + is a concatenation of the alphanumeric column name and the + index of the row. + + <p>Example: The cell in the 4th column and third row has the name "D3". + + <p>In cells that are split, the naming convention is more complex. + In this case the name is a concatenation of the former cell name + (i.e. "D3") and the number of the new column and row index inside + of the original table cell separated by dots. This is done + recursively. + + <p>Example: If the cell "D3" is horizontally split, it now contains + the cells "D3.1.1" and "D3.1.2" + + @see com::sun::star::table::Cell + @see com::sun::star::table::XCell + */ + com::sun::star::table::XCell getCellByName( [in] string aCellName ); + + + /** @returns + the names of all cells of this text table. + */ + sequence<string> getCellNames(); + + + /** creates a text table cursor and returns the + XTextTableCursor interface. + + <p>Initially the cursor is positioned in the cell with the specified name. + </p> + + @see com::sun::star::text::TextTableCursor + */ + com::sun::star::text::XTextTableCursor createCursorByCellName( [in] string aCellName ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextTableCursor.idl b/offapi/com/sun/star/text/XTextTableCursor.idl new file mode 100644 index 000000000..a89b816fb --- /dev/null +++ b/offapi/com/sun/star/text/XTextTableCursor.idl @@ -0,0 +1,158 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextTableCursor_idl__ +#define __com_sun_star_text_XTextTableCursor_idl__ + +#include <com/sun/star/uno/XInterface.idl> + + + +module com { module sun { module star { module text { + + +/** The TextTableCursor provide methods to navigate through the table structure, to merge and split cells + + @see com::sun::star::text::TextTable + @see com::sun::star::text::TextTableCursor + @see com::sun::star::text::Cell + @see com::sun::star::text::XTextTable + */ +published interface XTextTableCursor: com::sun::star::uno::XInterface +{ + + /** @returns + the name of the cell range that is selected by this cursor. + <p>The name is the cell name of the top left table cell of the range + concatenated by ":" with the table cell name of the bottom left table cell of the cell range. + If the range consists of one table cell only then the name of that table cell is returned. + </p> + @see com::sun:star::text::CellRange + */ + string getRangeName(); + + + /** moves the cursor to the cell with the specified name. + + @param aCellName + specifies the name of the cell to go to. + + @param bExpand + determines whether the selection is to be expanded. + + @see com::sun::star::text::Cell + */ + boolean gotoCellByName( [in] string aCellName, + [in] boolean bExpand ); + + + /** moves the cursor to the left neighbor. + + @param nCount + the number of cells to move. + + @param bExpand + determines whether the selection is to be expanded. + */ + boolean goLeft( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor to the right neighbor. + + @param nCount + the number of cells to move. + + @param bExpand + determines whether the selection is to be expanded. + */ + boolean goRight( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor to the top neighbor. + + @param nCount + the number of cells to move. + + @param bExpand + determines whether the selection is to be expanded. + */ + boolean goUp( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor to the bottom neighbor cell. + + @param nCount + the number of cells to move. + + @param bExpand + determines whether the selection is to be expanded. + */ + boolean goDown( [in] short nCount, + [in] boolean bExpand ); + + + /** moves the cursor to the top left cell of the table. + + @param bExpand + determines whether the selection is to be expanded. + */ + void gotoStart( [in] boolean bExpand ); + + + /** moves the cursor to the bottom right cell of the table. + + @param bExpand + determines whether the selection is to be expanded. + */ + void gotoEnd( [in] boolean bExpand ); + + + /** merges the selected range of cells. + + @see com::sun::star::CellRange + */ + boolean mergeRange(); + + + /** splits the range of cells. + + @param nCount + specifies the number of new cells that will be created + for each cell contained in the range. + + @param bHorizontal + `TRUE` if the range should be split vertically. + Otherwise it will be split horizontally. + + @see com::sun::star::Cell + @see com::sun::star::CellRange + */ + boolean splitRange( [in] short nCount, + [in] boolean bHorizontal ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextTablesSupplier.idl b/offapi/com/sun/star/text/XTextTablesSupplier.idl new file mode 100644 index 000000000..7f156497e --- /dev/null +++ b/offapi/com/sun/star/text/XTextTablesSupplier.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextTablesSupplier_idl__ +#define __com_sun_star_text_XTextTablesSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/container/XNameAccess.idl> + + + + module com { module sun { module star { module text { + + +/** enables the object to handle text tables. + */ +published interface XTextTablesSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the collection of "TextTables" currently contained in the object. + + @see com::sun::star::text::TextTables + @see com::sun::star::text::TextTable + */ + com::sun::star::container::XNameAccess getTextTables(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextViewCursor.idl b/offapi/com/sun/star/text/XTextViewCursor.idl new file mode 100644 index 000000000..637d7872b --- /dev/null +++ b/offapi/com/sun/star/text/XTextViewCursor.idl @@ -0,0 +1,56 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextViewCursor_idl__ +#define __com_sun_star_text_XTextViewCursor_idl__ + +#include <com/sun/star/text/XTextCursor.idl> + +#include <com/sun/star/awt/Point.idl> + + + + module com { module sun { module star { module text { + +/** describes a cursor in a text document's view. + */ +published interface XTextViewCursor: com::sun::star::text::XTextCursor +{ + /** @returns + `TRUE` if this cursor is visible for the user. + */ + boolean isVisible(); + + /** shows or hides this cursor for the user. + */ + void setVisible( [in] boolean bVisible ); + + /** @returns + the cursor's coordinates relative to the top left position of + the first page of the document. + */ + com::sun::star::awt::Point getPosition(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextViewCursorSupplier.idl b/offapi/com/sun/star/text/XTextViewCursorSupplier.idl new file mode 100644 index 000000000..01af60e63 --- /dev/null +++ b/offapi/com/sun/star/text/XTextViewCursorSupplier.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextViewCursorSupplier_idl__ +#define __com_sun_star_text_XTextViewCursorSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/XTextViewCursor.idl> + + + + module com { module sun { module star { module text { + +/** supplies access to the cursor in the view. + + + + <p>This cursor is the same instance that is available in the user + interface. + + </p>@see TextDocumentView + */ +published interface XTextViewCursorSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the cursor of the document view. + */ + com::sun::star::text::XTextViewCursor getViewCursor(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XTextViewTextRangeSupplier.idl b/offapi/com/sun/star/text/XTextViewTextRangeSupplier.idl new file mode 100644 index 000000000..57adf359f --- /dev/null +++ b/offapi/com/sun/star/text/XTextViewTextRangeSupplier.idl @@ -0,0 +1,46 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XTextViewTextRangeSupplier_idl__ +#define __com_sun_star_text_XTextViewTextRangeSupplier_idl__ + +#include <com/sun/star/uno/XInterface.idl> + +#include <com/sun/star/text/awt/Point.idl> +#include <com/sun/star/text/XTextRange.idl> + +module com { module sun { module star { module text { + +/** supplies access to a document model position at a view-dependent pixel position. + + @since LibreOffice 7.2 + */ +interface XTextViewTextRangeSupplier: com::sun::star::uno::XInterface +{ + /** @returns + the text range of the document position. + */ + com::sun::star::text::XTextRange createTextRangeByPixelPosition([in] com::sun::star::awt::Point PixelPosition); + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/XWordCursor.idl b/offapi/com/sun/star/text/XWordCursor.idl new file mode 100644 index 000000000..52c877def --- /dev/null +++ b/offapi/com/sun/star/text/XWordCursor.idl @@ -0,0 +1,96 @@ +/* -*- 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 . + */ +#ifndef __com_sun_star_text_XWordCursor_idl__ +#define __com_sun_star_text_XWordCursor_idl__ + +#include <com/sun/star/text/XTextCursor.idl> + + + + module com { module sun { module star { module text { + + +/** makes it possible to move a cursor word by word. + */ +published interface XWordCursor: com::sun::star::text::XTextCursor +{ + + /** determines if the cursor is positioned at the start of a word. + */ + boolean isStartOfWord(); + + + /** determines if the cursor is positioned at the end of a word. + */ + boolean isEndOfWord(); + + + /** moves the cursor to the next word. + + <p>Note: the function returning `TRUE` does not necessarily mean + that the cursor is located at the next word, or any word at all! + This may happen for example if it travels over empty paragraphs.</p> + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoNextWord( [in] boolean bExpand ); + + + /** moves the cursor to the previous word. + + <p>Note: the function returning `TRUE` does not necessarily mean + that the cursor is located at the previous word, or any word at all! + This may happen for example if it travels over empty paragraphs.</p> + + @returns + `TRUE` if the cursor was moved. It returns `FALSE` it the + cursor can not advance further. + */ + boolean gotoPreviousWord( [in] boolean bExpand ); + + + /** moves the cursor to the end of the current word. + + @returns + `TRUE` if the cursor is now at the end of a word, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoEndOfWord( [in] boolean bExpand ); + + + /** moves the cursor to the start of the current word. + + @returns + `TRUE` if the cursor is now at the start of a word, + `FALSE` otherwise. If `FALSE` was returned the cursor + will remain at its original position. + */ + boolean gotoStartOfWord( [in] boolean bExpand ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl new file mode 100644 index 000000000..f2412dd32 --- /dev/null +++ b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl @@ -0,0 +1,83 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_fieldmaster_Bibliography_idl_ +#define __com_sun_star_text_fieldmaster_Bibliography_idl_ + +#include <com/sun/star/text/TextFieldMaster.idl> +#include <com/sun/star/beans/PropertyValues.idl> +#include <com/sun/star/lang/Locale.idl> + + +module com { module sun { module star { module text { module fieldmaster { + +/** specifies service of a Bibliography field master. + @see com::sun::star::text::TextField +*/ +published service Bibliography +{ + service com::sun::star::text::TextFieldMaster; + + /** determines whether the bibliography text fields are numbered. If `FALSE` the + short name of the bibliography entry is displayed instead. + */ + [property] boolean IsNumberEntries; + /** determines whether the bibliography entries in a bibliography index are sorted + by the document position. If `FALSE` the SortKey property determines the + sorting of the entries. + */ + [property] boolean IsSortByPosition; + /** determines the opening bracket used to display the bibliography text fields. + */ + [property] string BracketBefore; + /** determines the closing bracket used to display the bibliography text fields. + */ + [property] string BracketAfter; + /** determines the sorting of the bibliography entries in a bibliography index. + This property is used if the property IsSortByPosition is not set. + Each contained element of the sequence is a sequence of the following + two properties: + <UL> + <LI><P>[property] short SortKey;</P> + <UL> + <LI><P>Determines the bibliography field that is used to sort by.</P> + </UL> + <LI><P>[property] boolean IsSortAscending;</P> + <UL> + <LI><P>Determines whether the sorting is ascending or descending. + It uses the type com::sun::star::text::BibliographyDataField</P> + </UL> + </UL> + */ + [property] sequence< com::sun::star::beans::PropertyValues > SortKeys; + /** contains the locale of the field master + */ + [property] com::sun::star::lang::Locale Locale; + /** contains the name of the sort algorithm that is used to sort the text fields. + */ + [property] string SortAlgorithm; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/fieldmaster/DDE.idl b/offapi/com/sun/star/text/fieldmaster/DDE.idl new file mode 100644 index 000000000..7cbcbec89 --- /dev/null +++ b/offapi/com/sun/star/text/fieldmaster/DDE.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_fieldmaster_DDE_idl_ +#define __com_sun_star_text_fieldmaster_DDE_idl_ + +#include <com/sun/star/text/TextFieldMaster.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + +module com { module sun { module star { module text { module fieldmaster { + +/** specifies service of a DDE field master. + @see com::sun::star::text::TextField +*/ +published service DDE +{ + service com::sun::star::text::TextFieldMaster; + + /** contains the element string of the DDE command. + */ + [property] string DDECommandElement; + /** contains the file string of the DDE command. + */ + [property] string DDECommandFile; + /** contains the type string of the DDE command. + */ + [property] string DDECommandType; + /** determines whether DDE link is updated automatically. + */ + [property] boolean IsAutomaticUpdate; + /** contains the content. + */ + [optional, property] string Content; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/fieldmaster/Database.idl b/offapi/com/sun/star/text/fieldmaster/Database.idl new file mode 100644 index 000000000..928227cca --- /dev/null +++ b/offapi/com/sun/star/text/fieldmaster/Database.idl @@ -0,0 +1,79 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_fieldmaster_Database_idl_ +#define __com_sun_star_text_fieldmaster_Database_idl_ + +#include <com/sun/star/text/TextFieldMaster.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + +module com { module sun { module star { module text { module fieldmaster { + +/** specifies service of a Database field master. + @see com::sun::star::text::TextField + + Only one of the properties #DataBaseName, + #DataBaseURL and #DataBaseResource + should be set. If more than one are set the last one will be used. +*/ +published service Database +{ + service com::sun::star::text::TextFieldMaster; + + /** specifies the database name. + */ + [property] string DataBaseName; + + /** contains the CommandType this + can be the name of a data base table, a data query or a statement. + (0 = table, 1 = query, 2 = statement) + */ + [property] long CommandType; + /** contains the command string. Depending on the CommandType property this + can be the name of a data base table, a data query or a statement. + */ + [property] string DataTableName; + /** contains the name of the data base table. + */ + [property] string DataColumnName; + + /** indicates the URL of a database file. + @since OOo 2.0 + */ + [optional, property] string DataBaseURL; + + /** indicates a connection URL, which locates a database driver. + @since OOo 2.0 + */ + [optional, property] string DataBaseResource; + /** contains the DataColumnName but it enables the fieldmaster and its + depending fields to work without setting DataSourceName, DataTableName and CommandType + @since OOo 2.3 + */ + [optional, property] string Name; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl new file mode 100644 index 000000000..55ed6c70e --- /dev/null +++ b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl @@ -0,0 +1,56 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_fieldmaster_SetExpression_idl_ +#define __com_sun_star_text_fieldmaster_SetExpression_idl_ + +#include <com/sun/star/text/TextFieldMaster.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + +module com { module sun { module star { module text { module fieldmaster { + +/** Specifies the service of a set expression field master. + @see com::sun::star::text::TextFieldMaster +*/ +published service SetExpression +{ + service com::sun::star::text::TextFieldMaster; + + /** determines the number of the chapter. This values is used if the field master + is set as number sequence. + */ + [property] byte ChapterNumberingLevel; + /** determines the numbering separator string if the field master + is set as number sequence. + */ + [property] string NumberingSeparator; + + /** determines the type of the field as + com::sun::star::text::SetVariableType + */ + [property] short SubType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/fieldmaster/User.idl b/offapi/com/sun/star/text/fieldmaster/User.idl new file mode 100644 index 000000000..72029e7d9 --- /dev/null +++ b/offapi/com/sun/star/text/fieldmaster/User.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_fieldmaster_User_idl_ +#define __com_sun_star_text_fieldmaster_User_idl_ + +#include <com/sun/star/text/TextFieldMaster.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + +module com { module sun { module star { module text { module fieldmaster { + +/** Specifies the service of a user field master. + @see com::sun::star::text::TextFieldMaster +*/ +published service User +{ + service com::sun::star::text::TextFieldMaster; + + /** determines whether the field contains an expression. + */ + [property] boolean IsExpression; + /** contains the value. + */ + [property] double Value; + /** contains the content. + */ + [property] string Content; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Annotation.idl b/offapi/com/sun/star/text/textfield/Annotation.idl new file mode 100644 index 000000000..f6140b7e3 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Annotation.idl @@ -0,0 +1,65 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Annotation_idl__ +#define __com_sun_star_text_textfield_Annotation_idl__ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/util/Date.idl> +#include <com/sun/star/util/DateTime.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of an annotation text field. + @see com::sun::star::text::TextField +*/ +published service Annotation +{ + service com::sun::star::text::TextField; + /** contains the name of the author of the annotation. + */ + [property]string Author; + /** contains the initials of the author of the annotation. + + @since LibreOffice 4.0 + */ + [optional, property]string Initials; + /** contains the name of the annotation. + + @since LibreOffice 4.0 + */ + [optional, property]string Name; + /** contains the annotation's content + */ + [property]string Content; + /** contains the creation date. + */ + [property]com::sun::star::util::Date Date; + /** contains the creation date. + */ + [optional, property]com::sun::star::util::DateTime DateTimeValue; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Author.idl b/offapi/com/sun/star/text/textfield/Author.idl new file mode 100644 index 000000000..598a2fc63 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Author.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Author_idl__ +#define __com_sun_star_text_textfield_Author_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of an author text field. + @see com::sun::star::text::TextField +*/ +published service Author +{ + service com::sun::star::text::TextField; + + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + [optional, property] boolean IsFixed; + + /** the is the content of this field + */ + [optional, property] string Content; + + /** this is the display format for this field + @see com::sun::star::text::AuthorDisplayFormat + */ + [optional, property] short AuthorFormat; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [optional, property]string CurrentPresentation; + /** determines whether the full name of the author is displayed rather than + the initials. + */ + [optional, property]boolean FullName; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Bibliography.idl b/offapi/com/sun/star/text/textfield/Bibliography.idl new file mode 100644 index 000000000..1205fd0bc --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Bibliography.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Bibliography_idl__ +#define __com_sun_star_text_textfield_Bibliography_idl_ + +#include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a bibliography text field. + @see com::sun::star::text::TextField +*/ +published service Bibliography +{ + service com::sun::star::text::DependentTextField; + + /** contains the bibliography fields of the text field. + */ + [property] sequence <com::sun::star::beans::PropertyValue> Fields; +}; + + +}; }; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Chapter.idl b/offapi/com/sun/star/text/textfield/Chapter.idl new file mode 100644 index 000000000..79791d0e2 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Chapter.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Chapter_idl__ +#define __com_sun_star_text_textfield_Chapter_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a chapter text field. + @see com::sun::star::text::TextField +*/ +published service Chapter +{ + service com::sun::star::text::TextField; + /** determines how the chapter should be displayed as described in + com::sun::star::text::ChapterFormat. + */ + [property]short ChapterFormat; + /** determines which chapter level should be used. The highest chapter + level has the value 0. + */ + [property]byte Level; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/CharacterCount.idl b/offapi/com/sun/star/text/textfield/CharacterCount.idl new file mode 100644 index 000000000..6d90e8cf9 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/CharacterCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_CharacterCount_idl__ +#define __com_sun_star_text_textfield_CharacterCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of characters + contained in the document. + @see com::sun::star::text::TextField +*/ +published service CharacterCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/CombinedCharacters.idl b/offapi/com/sun/star/text/textfield/CombinedCharacters.idl new file mode 100644 index 000000000..8d7899a31 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/CombinedCharacters.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_CombinedCharacters_idl__ +#define __com_sun_star_text_textfield_CombinedCharacters_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field to combine 1 to 6 characters that are treated + as one normal character. + @see com::sun::star::text::TextField +*/ +published service CombinedCharacters +{ + service com::sun::star::text::TextField; + /** contains the characters to be combined. + */ + [property]string Content; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/ConditionalText.idl b/offapi/com/sun/star/text/textfield/ConditionalText.idl new file mode 100644 index 000000000..c51ab839b --- /dev/null +++ b/offapi/com/sun/star/text/textfield/ConditionalText.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_ConditionalText_idl__ +#define __com_sun_star_text_textfield_ConditionalText_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a conditional text field. + @see com::sun::star::text::TextField +*/ +published service ConditionalText +{ + service com::sun::star::text::TextField; + + /** contains the text that is displayed if the condition evaluates to `TRUE`. + */ + [property] string TrueContent; + /** contains the text that is displayed if the condition evaluates to `FALSE`. + */ + [property] string FalseContent; + /** contains the condition. + */ + [property] string Condition; + /** contains the result of the last evaluation of the condition. + <p>This property has to be read/written in file export/import to save and + restore the result without initiation of a new evaluation.</p> + */ + [property] boolean IsConditionTrue; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [optional, property]string CurrentPresentation; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DDE.idl b/offapi/com/sun/star/text/textfield/DDE.idl new file mode 100644 index 000000000..e7d04d6c3 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DDE.idl @@ -0,0 +1,44 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DDE_idl__ +#define __com_sun_star_text_textfield_DDE_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of text field that visualizes a DDE connection. + + @see com::sun::star::text::TextFieldMaster::DDE + + @since OOo 1.1.2 +*/ +published service DDE +{ + service com::sun::star::text::TextField; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Database.idl b/offapi/com/sun/star/text/textfield/Database.idl new file mode 100644 index 000000000..e02656ac3 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Database.idl @@ -0,0 +1,59 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Database_idl__ +#define __com_sun_star_text_textfield_Database_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a database text field which is used as mail merge field. + @see com::sun::star::text::TextField +*/ +published service Database +{ + service com::sun::star::text::DependentTextField; + + /** contains the database content that was merged in the last database merge action. + Initially it contains the column name in parenthesis (<>). + */ + [property]string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** determines whether the number format is number display format is read + from the database settings. + */ + [property]boolean DataBaseFormat; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DatabaseName.idl b/offapi/com/sun/star/text/textfield/DatabaseName.idl new file mode 100644 index 000000000..9a4840f4c --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DatabaseName.idl @@ -0,0 +1,71 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DatabaseName_idl__ +#define __com_sun_star_text_textfield_DatabaseName_idl_ + + +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of text field that displays the name of a database. + @see com::sun::star::text::TextField + + Only one of the properties #DataBaseName, + #DataBaseURL and #DataBaseResource + should be set. If more than one are set the last one will be used. +*/ +published service DatabaseName +{ + service com::sun::star::text::DependentTextField; + + /** specifies the database name. + */ + [property] string DataBaseName; + + /** determines the interpretation of the property DataTableName. + @see com::sun::star::sdb::CommandType + */ + [property] long DataCommandType; + + /** contains the name of the database table, query or a statement depending + on the DataCommandType property. + */ + [property] string DataTableName; + + /** indicates the URL of a database file. + @since OOo 2.0 + */ + [optional, property] string DataBaseURL; + + /** indicates a connection URL, which locates a database driver. + @since OOo 2.0 + */ + [optional, property] string DataBaseResource; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl b/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl new file mode 100644 index 000000000..b5bb38b23 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl @@ -0,0 +1,75 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DatabaseNextSet_idl__ +#define __com_sun_star_text_textfield_DatabaseNextSet_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that increments a database selection. + @see com::sun::star::text::TextField + + Only one of the properties #DataBaseName, + #DataBaseURL and #DataBaseResource + should be set. If more than one are set the last one will be used. +*/ +published service DatabaseNextSet +{ + service com::sun::star::text::DependentTextField; + + /** specifies the database name. + */ + [property] string DataBaseName; + + /** determines the interpretation of the property DataTableName. + @see com::sun::star::sdb::CommandType + */ + [property] long DataCommandType; + + /** contains the name of the database table, query or a statement depending + on the DataCommandType property. + */ + [property] string DataTableName; + + /** determines whether the database selection is set to the next position or not. + */ + [property] string Condition; + + /** indicates the URL of a database file. + @since OOo 2.0 + */ + [optional, property] string DataBaseURL; + + /** indicates a connection URL, which locates a database driver. + @since OOo 2.0 + */ + [optional, property] string DataBaseResource; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl b/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl new file mode 100644 index 000000000..efe9cd947 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl @@ -0,0 +1,80 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DatabaseNumberOfSet_idl__ +#define __com_sun_star_text_textfield_DatabaseNumberOfSet_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of text field that conditionally set the selection of + a database cursor. + @see com::sun::star::text::TextField + + Only one of the properties #DataBaseName, + #DataBaseURL and #DataBaseResource + should be set. If more than one are set the last one will be used. +*/ +published service DatabaseNumberOfSet +{ + service com::sun::star::text::DependentTextField; + + /** specifies the database name. + */ + [property] string DataBaseName; + + /** determines the interpretation of the property DataTableName. + @see com::sun::star::sdb::CommandType + */ + [property] long DataCommandType; + + /** contains the name of the database table, query or a statement depending + on the DataCommandType property. + */ + [property] string DataTableName; + + /** contains the conditions that determines whether the SetNumber is applied or not. + */ + [property] string Condition; + + /** contains the set number that is to be applied. + */ + [property] long SetNumber; + + /** indicates the URL of a database file. + @since OOo 2.0 + */ + [optional, property] string DataBaseURL; + + /** indicates a connection URL, which locates a database driver. + @since OOo 2.0 + */ + [optional, property] string DataBaseResource; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl b/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl new file mode 100644 index 000000000..a10f9cf97 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl @@ -0,0 +1,81 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DatabaseSetNumber_idl__ +#define __com_sun_star_text_textfield_DatabaseSetNumber_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the current set number of + a database. + @see com::sun::star::text::TextField + + Only one of the properties #DataBaseName, + #DataBaseURL and #DataBaseResource + should be set. If more than one are set the last one will be used. +*/ +published service DatabaseSetNumber +{ + service com::sun::star::text::DependentTextField; + + /** specifies the database name. + */ + [property] string DataBaseName; + + /** determines the interpretation of the property DataTableName. + @see com::sun::star::sdb::CommandType + */ + [property] long DataCommandType; + + /** contains the name of the database table, query or a statement depending + on the DataCommandType property. + */ + [property] string DataTableName; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property] short NumberingType; + + /** contains the number of the database set. + */ + [property] long SetNumber; + + /** indicates the URL of a database file. + @since OOo 2.0 + */ + [optional, property] string DataBaseURL; + + /** indicates a connection URL, which locates a database driver. + @since OOo 2.0 + */ + [optional, property] string DataBaseResource; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DateTime.idl b/offapi/com/sun/star/text/textfield/DateTime.idl new file mode 100644 index 000000000..2f7950735 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DateTime.idl @@ -0,0 +1,88 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DateTime_idl__ +#define __com_sun_star_text_textfield_DateTime_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/util/DateTime.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a date or time text field. + @see com::sun::star::text::TextField +*/ +published service DateTime +{ + service com::sun::star::text::TextField; + + /** If this flag is set to `FALSE` the date or time + is always displayed as the current date or time. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixed; + + /** If this flag is set to `TRUE` this field represents + a date with an optional time. If it is set to `FALSE` + only the time is used here. + */ + [property] boolean IsDate; + + /** the is the content of this field. + */ + [optional, property] com::sun::star::util::DateTime DateTimeValue; + + /** this is the number format for this field + @see com::sun::star::util::NumberFormatter + */ + [optional, property] long NumberFormat; + + /** this is the display format for this field. + Depending on #IsDate, this + is either a + com::sun::star::text::DateDisplayFormat or + com::sun::star::text::TimeDisplayFormat. + + This property is deprecated and is here only + for components that do not support a + com::sun::star::util::NumberFormatter. + + @see com::sun::star::text::DateDisplayFormat + @see com::sun::star::text::TimeDisplayFormat + + @deprecated + */ + [optional, property] short DateTimeFormat; + /** contains an offset to the date or time value in minutes. + */ + [optional, property] long Adjust; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/DropDown.idl b/offapi/com/sun/star/text/textfield/DropDown.idl new file mode 100644 index 000000000..ec93e664f --- /dev/null +++ b/offapi/com/sun/star/text/textfield/DropDown.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_DropDown_idl__ +#define __com_sun_star_text_textfield_DropDown_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of an author text field. + @see com::sun::star::text::TextField +*/ +published service DropDown +{ + service com::sun::star::text::TextField; + + /** + The name of the drop down field. + */ + [property] string Name; + + /** + The items of the dropdown field. + */ + [property] sequence<string> Items; + + /** + The selected item. If no item is selected this property + contains an empty string. If this property is set to a value + not present in the items of the dropdown field it is + invalidated, i.e. it is set to an empty string. + */ + [property] string SelectedItem; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/EmbeddedObjectCount.idl b/offapi/com/sun/star/text/textfield/EmbeddedObjectCount.idl new file mode 100644 index 000000000..57c78ca5a --- /dev/null +++ b/offapi/com/sun/star/text/textfield/EmbeddedObjectCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_EmbeddedObjectCount_idl__ +#define __com_sun_star_text_textfield_EmbeddedObjectCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of embedded objects + contained in the document. + @see com::sun::star::text::TextField +*/ +published service EmbeddedObjectCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/ExtendedUser.idl b/offapi/com/sun/star/text/textfield/ExtendedUser.idl new file mode 100644 index 000000000..75e559402 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/ExtendedUser.idl @@ -0,0 +1,57 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_ExtendedUser_idl__ +#define __com_sun_star_text_textfield_ExtendedUser_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that shows and element of the user data + (name, address, phone, ...) + @see com::sun::star::text::TextField +*/ +published service ExtendedUser +{ + service com::sun::star::text::TextField; + /** contains the content. + */ + [property]string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content is regularly updated. + */ + [property]boolean IsFixed; + /** specifies which part of the user data is displayed as described in + com::sun::star::text::UserDataPart. + */ + [property]short UserDataType; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/FileName.idl b/offapi/com/sun/star/text/textfield/FileName.idl new file mode 100644 index 000000000..4a5ab163d --- /dev/null +++ b/offapi/com/sun/star/text/textfield/FileName.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_FileName_idl__ +#define __com_sun_star_text_textfield_FileName_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of text field that displays the file name (URL) of + the document. + @see com::sun::star::text::TextField +*/ +published service FileName +{ + 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; + /** determines the format the file name is displayed as specified in + com::sun::star::text::FilenameDisplayFormat. + */ + [property]short FileFormat; + /** If this flag is set to `FALSE` the content is regularly updated. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/GetExpression.idl b/offapi/com/sun/star/text/textfield/GetExpression.idl new file mode 100644 index 000000000..d29702a66 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/GetExpression.idl @@ -0,0 +1,73 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_GetExpression_idl__ +#define __com_sun_star_text_textfield_GetExpression_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a get expression text field. + @see com::sun::star::text::TextField +*/ +published service GetExpression +{ + service com::sun::star::text::TextField; + /** contains the textual content of the field. + */ + [property]string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; + + /** determines whether the content is displayed or evaluated. + */ + [property]boolean IsShowFormula; + /** determines the type of the variable as described in + com::sun::star::text::SetVariableType + */ + [property]short SubType; + /** contains the numerical value of the field. + */ + [property, readonly] double Value; + + /** deprecated + */ + [property]short VariableSubtype; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/GetReference.idl b/offapi/com/sun/star/text/textfield/GetReference.idl new file mode 100644 index 000000000..f561053c8 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/GetReference.idl @@ -0,0 +1,77 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_GetReference_idl__ +#define __com_sun_star_text_textfield_GetReference_idl__ + +#include <com/sun/star/text/TextField.idl> + + +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; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/GraphicObjectCount.idl b/offapi/com/sun/star/text/textfield/GraphicObjectCount.idl new file mode 100644 index 000000000..57509aa20 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/GraphicObjectCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_GraphicObjectCount_idl__ +#define __com_sun_star_text_textfield_GraphicObjectCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of graphic objects + contained in the document. + @see com::sun::star::text::TextField +*/ +published service GraphicObjectCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/HiddenParagraph.idl b/offapi/com/sun/star/text/textfield/HiddenParagraph.idl new file mode 100644 index 000000000..add73fb18 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/HiddenParagraph.idl @@ -0,0 +1,50 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_HiddenParagraph_idl__ +#define __com_sun_star_text_textfield_HiddenParagraph_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a hidden paragraph field. + @see com::sun::star::text::TextField +*/ +published service HiddenParagraph +{ + service com::sun::star::text::TextField; + + /** contains the condition. + */ + [property] string Condition; + /** contains the result of the last evaluation of the condition. + <p>This property has to be read/written in file export/import to save and + restore the result without initiation of a new evaluation.</p> + */ + [property] boolean IsHidden; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/HiddenText.idl b/offapi/com/sun/star/text/textfield/HiddenText.idl new file mode 100644 index 000000000..fcbdeff4f --- /dev/null +++ b/offapi/com/sun/star/text/textfield/HiddenText.idl @@ -0,0 +1,54 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_HiddenText_idl__ +#define __com_sun_star_text_textfield_HiddenText_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a hidden text field. + @see com::sun::star::text::TextField +*/ +published service HiddenText +{ + service com::sun::star::text::TextField; + + /** contains the text content of the hidden text field. + <p> The content is displayed if the condition evaluates to `FALSE`.</p> + */ + [property] string Content; + /** contains the condition. + */ + [property] string Condition; + /** contains the result of the last evaluation of the condition. + <p>This property has to be read/written in file export/import to save and + restore the result without initiation of a new evaluation.</p> + */ + [property] boolean IsHidden; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Input.idl b/offapi/com/sun/star/text/textfield/Input.idl new file mode 100644 index 000000000..0f88a4f46 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Input.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Input_idl__ +#define __com_sun_star_text_textfield_Input_idl__ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text input field. + @see com::sun::star::text::TextField +*/ +published service Input +{ + service com::sun::star::text::TextField; + + /** contains the text content of the text field. + <p> The field displays the text content.</p> + */ + [optional, property] string Content; + + /** contains a hint text. + <p> This hint may be used as help tip or as headline of a corresponding + dialog to edit the field content.</p> + */ + [optional, property] string Hint; + + /** contains an internal-use-only multi purpose string. + <p>This is an internal multi purpose string used in WW8 import/export. + Usually it holds the help text for form fields.</p> + <p>It's content must NEVER be modified by the user.</p> + */ + [optional, property] string Help; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/InputUser.idl b/offapi/com/sun/star/text/textfield/InputUser.idl new file mode 100644 index 000000000..92fcbbd4e --- /dev/null +++ b/offapi/com/sun/star/text/textfield/InputUser.idl @@ -0,0 +1,53 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_InputUser_idl__ +#define __com_sun_star_text_textfield_InputUser_idl__ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of an input field that is used to change the content of a corresponding + field master of a user defined text field. + + @see com::sun::star::text::TextField +*/ +published service InputUser +{ + service com::sun::star::text::TextField; + + /** contains the name of the corresponding field master. + */ + [optional, property] string Content; + + /** contains a hint text. + <p> This hint may be used as help tip or as headline of a corresponding + dialog to edit the field content.</p> + */ + [optional, property] string Hint; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/JumpEdit.idl b/offapi/com/sun/star/text/textfield/JumpEdit.idl new file mode 100644 index 000000000..cd9c5f131 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/JumpEdit.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_JumpEdit_idl__ +#define __com_sun_star_text_textfield_JumpEdit_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a place holder text field. + @see com::sun::star::text::TextField +*/ +published service JumpEdit +{ + service com::sun::star::text::TextField; + /** determines a hint that is displayed at the user interface as tip. + */ + [property]string Hint; + /** determines the text of the place holder. + */ + [property]string PlaceHolder; + /** determines the type of the place holder as described in + com::sun::star::text::PlaceholderType. + */ + [property]short PlaceHolderType; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Macro.idl b/offapi/com/sun/star/text/textfield/Macro.idl new file mode 100644 index 000000000..004954ad0 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Macro.idl @@ -0,0 +1,51 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Macro_idl__ +#define __com_sun_star_text_textfield_Macro_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a macro text field. + @see com::sun::star::text::TextField +*/ +published service Macro +{ + service com::sun::star::text::TextField; + /** contains a tip that is displayed at the user interface. + */ + [property]string Hint; + /** contains the macro name of a StarBASIC macro. + */ + [property]string MacroName; + /** contains the library name of a StarBASIC macro. + */ + [property]string MacroLibrary; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/MetadataField.idl b/offapi/com/sun/star/text/textfield/MetadataField.idl new file mode 100644 index 000000000..a4f237cd4 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/MetadataField.idl @@ -0,0 +1,80 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_MetadataField_idl__ +#define __com_sun_star_text_textfield_MetadataField_idl__ + +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/container/XChild.idl> +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/XText.idl> +#include <com/sun/star/rdf/XMetadatable.idl> + + + +module com { module sun { module star { module text { module textfield { + +/** is a com::sun::star::text::TextField whose content + is specified by RDF metadata. + + @since OOo 3.2 + + @see com::sun::star::rdf +*/ +service MetadataField +{ + /** None of the properties of + com::sun::star::text::TextContent are supported. */ + service com::sun::star::text::TextField; + + /** The MetadataField can have RDF metadata attached. */ + interface com::sun::star::rdf::XMetadatable; + + /** Allows for insertion of text content into, and creating cursors + that are bound within, the MetadataField. */ + interface com::sun::star::text::XText; + + /** The com::sun::star::text::TextContents that are + contained in the MetadataField can be enumerated. */ + interface com::sun::star::container::XEnumerationAccess; + + /** The com::sun::star::text::TextContent + that is the parent of this MetadataField. + @since OOo 3.3 + */ + interface com::sun::star::container::XChild; + + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [optional, property] long NumberFormat; + + /** determines whether changes in language attributes at the + position of the text field also change the number format + as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/PageCount.idl b/offapi/com/sun/star/text/textfield/PageCount.idl new file mode 100644 index 000000000..2ae0a408d --- /dev/null +++ b/offapi/com/sun/star/text/textfield/PageCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_PageCount_idl__ +#define __com_sun_star_text_textfield_PageCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of pages + contained in the document. + @see com::sun::star::text::TextField +*/ +published service PageCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/PageNumber.idl b/offapi/com/sun/star/text/textfield/PageNumber.idl new file mode 100644 index 000000000..dc172303e --- /dev/null +++ b/offapi/com/sun/star/text/textfield/PageNumber.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_PageNumber_idl__ +#define __com_sun_star_text_textfield_PageNumber_idl__ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/PageNumberType.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a page number text field. + @see com::sun::star::text::TextField +*/ +published service PageNumber +{ + service com::sun::star::text::TextField; + + /** determines the type of the numbering. + @see com::sun::star::style::NumberingType + */ + [property] short NumberingType; + + /** determines an offset value to show a different page number. + */ + [property] short Offset; + /** determines which page the field refers to. + @see com::sun::star::text::PageNumberType + */ + [property] PageNumberType SubType; + /** if the user text string is set then it is displayed when the value + of NumberingType is set to com::sun::star::style::NumberingType::CHAR_SPECIAL + */ + [property] string UserText; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/ParagraphCount.idl b/offapi/com/sun/star/text/textfield/ParagraphCount.idl new file mode 100644 index 000000000..dc5626b48 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/ParagraphCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_ParagraphCount_idl__ +#define __com_sun_star_text_textfield_ParagraphCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of paragraphs + contained in the document. + @see com::sun::star::text::TextField +*/ +published service ParagraphCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/ReferencePageGet.idl b/offapi/com/sun/star/text/textfield/ReferencePageGet.idl new file mode 100644 index 000000000..1b0a8761f --- /dev/null +++ b/offapi/com/sun/star/text/textfield/ReferencePageGet.idl @@ -0,0 +1,48 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_ReferencePageGet_idl__ +#define __com_sun_star_text_textfield_ReferencePageGet_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that + displays the page number with respect to a reference point. + The reference point is determined by a ReferencePageSet text field. + @see com::sun::star::text::TextField + @see com::sun::star::text::textfield::ReferencePageSet +*/ +published service ReferencePageGet +{ + service com::sun::star::text::TextField; + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/ReferencePageSet.idl b/offapi/com/sun/star/text/textfield/ReferencePageSet.idl new file mode 100644 index 000000000..1157d8d58 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/ReferencePageSet.idl @@ -0,0 +1,49 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_ReferencePageSet_idl__ +#define __com_sun_star_text_textfield_ReferencePageSet_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that inserts additional page numbers. + @see com::sun::star::text::TextField + @see com::sun::star::text::textfield::ReferencePageGet +*/ +published service ReferencePageSet +{ + service com::sun::star::text::TextField; + /** determines an offset value to change the displayed value of a ReferencePageGet text field. + */ + [property]short Offset; + /** determines whether the ReferencePageGet text fields are displayed or not. + */ + [property]boolean NameOn; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Script.idl b/offapi/com/sun/star/text/textfield/Script.idl new file mode 100644 index 000000000..3e74c4ef0 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Script.idl @@ -0,0 +1,52 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_Script_idl__ +#define __com_sun_star_text_textfield_Script_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field . + @see com::sun::star::text::TextField +*/ +published service Script +{ + service com::sun::star::text::TextField; + /** contains the script text or a URL that points to a script depending on + the URLContent property. + */ + [property]string Content; + /** contains the name of the script type (i.e. JavaScript) + */ + [property]string ScriptType; + /** determines whether the property Content contains a URL or a script. + */ + [property]boolean URLContent; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/SetExpression.idl b/offapi/com/sun/star/text/textfield/SetExpression.idl new file mode 100644 index 000000000..269ada8cc --- /dev/null +++ b/offapi/com/sun/star/text/textfield/SetExpression.idl @@ -0,0 +1,104 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_SetExpression_idl__ +#define __com_sun_star_text_textfield_SetExpression_idl_ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of an expression text field. + @see com::sun::star::text::TextField +*/ +published service SetExpression +{ + service com::sun::star::text::DependentTextField; + + /** contains the textual content of the field. + */ + [property] string Content; + + /** contains the current content of the text field. + <p>This property is especially useful for import/export purposes.</p> + */ + [property] string CurrentPresentation; + + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property] long NumberFormat; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property] short NumberingType; + + /** determines whether the content is displayed or evaluated. + */ + [property] boolean IsShowFormula; + + /** contains an informational text that is displayed at the user + interface if it's an input field. + */ + [property] string Hint; + + /** determines whether this field is an input field. + */ + [property] boolean IsInput; + + /** determines whether the field is visible. + */ + [property] boolean IsVisible; + + /** contains the sequence value when this field is used as sequence field. + */ + [property] short SequenceValue; + + /** determines the type of the variable as described in + com::sun::star::text::SetVariableType + */ + [property] short SubType; + + /** contains the numerical value of the field. + */ + [property]double Value; + + /** contains the name of the set expression field master this field is + connected to. + */ + [property, readonly] string VariableName; + + /** determines whether changes in language attributes at the position + the text field is located also change the number format as appropriate + for this language. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/TableCount.idl b/offapi/com/sun/star/text/textfield/TableCount.idl new file mode 100644 index 000000000..d0dbe48ca --- /dev/null +++ b/offapi/com/sun/star/text/textfield/TableCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_TableCount_idl__ +#define __com_sun_star_text_textfield_TableCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of tables + contained in the document. + @see com::sun::star::text::TextField +*/ +published service TableCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/TableFormula.idl b/offapi/com/sun/star/text/textfield/TableFormula.idl new file mode 100644 index 000000000..d44307ccb --- /dev/null +++ b/offapi/com/sun/star/text/textfield/TableFormula.idl @@ -0,0 +1,58 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_TableFormula_idl__ +#define __com_sun_star_text_textfield_TableFormula_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a table formula text field. + @deprecated + @see com::sun::star::text::TextField +*/ +published service TableFormula +{ + service com::sun::star::text::TextField; + + /** contains the formula. */ + [property] string Formula; + + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property] string CurrentPresentation; + + /** determines whether the formula displayed as text or evaluated. + */ + [property] boolean IsShowFormula; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property] short NumberFormat; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/TemplateName.idl b/offapi/com/sun/star/text/textfield/TemplateName.idl new file mode 100644 index 000000000..d8bd1aad6 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/TemplateName.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_TemplateName_idl__ +#define __com_sun_star_text_textfield_TemplateName_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service text field that displays the name of the template the document + has been created from. + @see com::sun::star::text::TextField +*/ +published service TemplateName +{ + service com::sun::star::text::TextField; + /** determines the format the template file name is displayed as specified in + com::sun::star::text::FilenameDisplayFormat. + */ + [property]short FileFormat; + +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/Type.idl b/offapi/com/sun/star/text/textfield/Type.idl new file mode 100644 index 000000000..648400a22 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/Type.idl @@ -0,0 +1,53 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_text_textfield_Type_idl__ +#define __com_sun_star_text_textfield_Type_idl__ + + +module com { module sun { module star { module text { module textfield { + +/** + * Text field types. + * + * Right now this only contains the types that are supported by the edit engine, + * but it should eventually contain all field types that are used across all + * engines. + * + * @since LibreOffice 3.6 + */ +constants Type +{ + const long UNSPECIFIED = -1; + + const long DATE = 0; + const long URL = 1; + const long PAGE = 2; + const long PAGES = 3; + const long TIME = 4; + const long TABLE = 5; + const long EXTENDED_TIME = 6; + const long EXTENDED_FILE = 7; + const long AUTHOR = 8; + const long MEASURE = 9; + + const long DOCINFO_TITLE = 10; + + const long PRESENTATION_HEADER = 11; + const long PRESENTATION_FOOTER = 12; + const long PRESENTATION_DATE_TIME = 13; + const long PAGE_NAME = 14; + const long DOCINFO_CUSTOM = 15; +}; + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/URL.idl b/offapi/com/sun/star/text/textfield/URL.idl new file mode 100644 index 000000000..a6edcdf78 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/URL.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_URL_idl__ +#define __com_sun_star_text_textfield_URL_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of text field that displays a URL + + @see com::sun::star::text::TextField +*/ +published service URL +{ + service com::sun::star::text::TextField; + + /** Specifies how the URL is formatted on output. + */ + [property] short Format; + + /** contains the unparsed original URL, for example, + http://me:pass@www.sun.de:8080/pub/test/foo.txt?a=b#xyz + */ + [property] string URL; + + /** contains the content that will be displayed to the user. + <p> If this string is empty, the <code>URL</code> will be shown. + */ + [property] string Representation; + + /** Specifies the frame name in that the URL will be opened + */ + [property] string TargetFrame; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/User.idl b/offapi/com/sun/star/text/textfield/User.idl new file mode 100644 index 000000000..4da8faea4 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/User.idl @@ -0,0 +1,62 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_User_idl__ +#define __com_sun_star_text_textfield_User_idl__ + +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> +#include <com/sun/star/text/XDependentTextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a user defined field. + @see com::sun::star::text::TextField +*/ +published service User +{ + service com::sun::star::text::DependentTextField; + + /** determines if the content is shown as text rather than as value. + */ + [optional, property] boolean IsShowFormula; + + /** determines if the field is visible. + */ + [optional, property] boolean IsVisible; + + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [optional, property] long NumberFormat; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/WordCount.idl b/offapi/com/sun/star/text/textfield/WordCount.idl new file mode 100644 index 000000000..5bd269f57 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/WordCount.idl @@ -0,0 +1,47 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_WordCount_idl__ +#define __com_sun_star_text_textfield_WordCount_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { module text { module textfield { + +/** specifies service of a text field that displays the number of words + contained in the document. + @see com::sun::star::text::TextField +*/ +published service WordCount +{ + service com::sun::star::text::TextField; + + /** specifies the type of the numbering as + com::sun::star::style::NumberingType + */ + [property]short NumberingType; +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/ChangeAuthor.idl b/offapi/com/sun/star/text/textfield/docinfo/ChangeAuthor.idl new file mode 100644 index 000000000..a44418dfa --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/ChangeAuthor.idl @@ -0,0 +1,56 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_ChangeAuthor_idl__ +#define __com_sun_star_text_textfield_docinfo_ChangeAuthor_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the author + of the last change. + @see com::sun::star::text::TextField +*/ +published service ChangeAuthor +{ + service com::sun::star::text::TextField; + + /** contains the name of the author. + */ + [property]string Author; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + [optional, property] boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl new file mode 100644 index 000000000..3d0023d4c --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/ChangeDateTime.idl @@ -0,0 +1,73 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_ChangeDateTime_idl__ +#define __com_sun_star_text_textfield_docinfo_ChangeDateTime_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the date + and time the document was last changed. + @see com::sun::star::text::TextField +*/ +published service ChangeDateTime +{ + 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; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + /** If this flag is set to `FALSE` the date or time + is always displayed as the current date or time. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixed; + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` + only the time is used here. + */ + [property]boolean IsDate; + /** contains the date and time as double value. + */ + [property]double DateTimeValue; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/CreateAuthor.idl b/offapi/com/sun/star/text/textfield/docinfo/CreateAuthor.idl new file mode 100644 index 000000000..8beda78d1 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/CreateAuthor.idl @@ -0,0 +1,56 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_CreateAuthor_idl__ +#define __com_sun_star_text_textfield_docinfo_CreateAuthor_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the author + who created the document. + @see com::sun::star::text::TextField +*/ +published service CreateAuthor +{ + service com::sun::star::text::TextField; + + /** contains the name of the author. + */ + [property]string Author; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + [optional, property] boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl new file mode 100644 index 000000000..277d726ab --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/CreateDateTime.idl @@ -0,0 +1,73 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_CreateDateTime_idl__ +#define __com_sun_star_text_textfield_docinfo_CreateDateTime_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the date + and time of the document creation. + @see com::sun::star::text::TextField +*/ +published service CreateDateTime +{ + 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; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + /** If this flag is set to `FALSE` the date or time + is always displayed as the current date or time. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixed; + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` + only the time is used here. + */ + [property]boolean IsDate; + /** contains the date and time as double value. + */ + [property]double DateTimeValue; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Custom.idl b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl new file mode 100644 index 000000000..4903b1ddb --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Custom.idl @@ -0,0 +1,60 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Custom_idl__ +#define __com_sun_star_text_textfield_docinfo_Custom_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that refers to the content of a + user-defined field in the document information. + + @since OOo 3.0 + + @see com::sun::star::text::TextField +*/ +published service Custom +{ + service com::sun::star::text::TextField; + + /** the name of the user-defined property that this field refers to. + */ + [property] string Name; + + /** contains the current content of the text field. + <p>This property is useful for import/export purposes.</p> + */ + [property] string CurrentPresentation; + + /** If this flag is set to `FALSE`, the content is updated when + the document information changes. + */ + [property] boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Description.idl b/offapi/com/sun/star/text/textfield/docinfo/Description.idl new file mode 100644 index 000000000..6b017363e --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Description.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Description_idl__ +#define __com_sun_star_text_textfield_docinfo_Description_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides the description that is contained + in the document information. + @see com::sun::star::text::TextField +*/ +published service Description +{ + service com::sun::star::text::TextField; + + /** contains content information. + */ + [property] string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content updated every time the document + information is changed. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl b/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl new file mode 100644 index 000000000..d133bfcae --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/EditTime.idl @@ -0,0 +1,68 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_EditTime_idl__ +#define __com_sun_star_text_textfield_docinfo_EditTime_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the + duration the document has been edited. + @see com::sun::star::text::TextField +*/ +published service EditTime +{ + 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; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + /** If this flag is set to `FALSE` the date or time + is always displayed as the current date or time. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixed; + /** contains the date and time as double value. + */ + [property]double DateTimeValue; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl new file mode 100644 index 000000000..e7a95235a --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Keywords.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Keywords_idl__ +#define __com_sun_star_text_textfield_docinfo_Keywords_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides the keywords that are contained + in the document information. + @see com::sun::star::text::TextField +*/ +published service Keywords +{ + service com::sun::star::text::TextField; + + /** contains content information. + */ + [property] string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content updated every time the document + information is changed. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/PrintAuthor.idl b/offapi/com/sun/star/text/textfield/docinfo/PrintAuthor.idl new file mode 100644 index 000000000..4deb0427c --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/PrintAuthor.idl @@ -0,0 +1,56 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_PrintAuthor_idl__ +#define __com_sun_star_text_textfield_docinfo_PrintAuthor_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the author + of the last print operation. + @see com::sun::star::text::TextField +*/ +published service PrintAuthor +{ + service com::sun::star::text::TextField; + + /** contains the name of the author. + */ + [property]string Author; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + [optional, property] boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl b/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl new file mode 100644 index 000000000..86b0445d5 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/PrintDateTime.idl @@ -0,0 +1,73 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_PrintDateTime_idl__ +#define __com_sun_star_text_textfield_docinfo_PrintDateTime_idl__ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides information about the date + and time the document was last printed. + @see com::sun::star::text::TextField +*/ +published service PrintDateTime +{ + 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; + /** If this flag is set to false the author + will be overridden by the current author + each time the document is saved. + */ + /** If this flag is set to `FALSE` the date or time + is always displayed as the current date or time. + + @since OOo 1.1.2 + */ + [optional, property] boolean IsFixed; + /** If this flag is set to `TRUE` this field represents, + a date with an optional time. If it is set to `FALSE` + only the time is used here. + */ + [property]boolean IsDate; + /** contains the date and time as double value. + */ + [property]double DateTimeValue; + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter + */ + [property]long NumberFormat; + /** determines whether changes in language attributes at the position the text field + is located also change the number format as appropriate for this language. + */ + [optional, property] boolean IsFixedLanguage; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Revision.idl b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl new file mode 100644 index 000000000..04ca64c15 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Revision.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Revision_idl__ +#define __com_sun_star_text_textfield_docinfo_Revision_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides the revision that is contained + in the document information. + @see com::sun::star::text::TextField +*/ +published service Revision +{ + service com::sun::star::text::TextField; + + /** contains content information. + */ + [property] string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content updated every time the document + information is changed. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Subject.idl b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl new file mode 100644 index 000000000..5f3348080 --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Subject.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Subject_idl__ +#define __com_sun_star_text_textfield_docinfo_Subject_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides the subject that is contained + in the document information. + @see com::sun::star::text::TextField +*/ +published service Subject +{ + service com::sun::star::text::TextField; + + /** contains content information. + */ + [property] string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content updated every time the document + information is changed. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/text/textfield/docinfo/Title.idl b/offapi/com/sun/star/text/textfield/docinfo/Title.idl new file mode 100644 index 000000000..29730bffa --- /dev/null +++ b/offapi/com/sun/star/text/textfield/docinfo/Title.idl @@ -0,0 +1,55 @@ +/* -*- 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 . + */ + +#ifndef __com_sun_star_text_textfield_docinfo_Title_idl__ +#define __com_sun_star_text_textfield_docinfo_Title_idl_ + +#include <com/sun/star/text/TextField.idl> + + +module com { module sun { module star { + module text { module textfield { module docinfo { + +/** specifies service of a text field that provides the title that is contained + in the document information. + @see com::sun::star::text::TextField +*/ +published service Title +{ + service com::sun::star::text::TextField; + + /** contains content information. + */ + [property] string Content; + /** contains the current content of the text field. + <p> This property is especially useful for import/export purposes. </p> + */ + [property]string CurrentPresentation; + /** If this flag is set to `FALSE` the content updated every time the document + information is changed. + */ + [property]boolean IsFixed; +}; + + +}; }; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |