LibreOffice LibreOffice 25.2 SDK API Reference

OfficeDocument.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module document {
22
33published service OfficeDocument
34{
43 interface com::sun::star::frame::XModel;
44
53 interface com::sun::star::util::XModifiable;
54
66 interface com::sun::star::frame::XStorable;
67
75 interface com::sun::star::view::XPrintable;
76
80 [optional] interface XEventBroadcaster;
81
85 [optional] interface XDocumentEventBroadcaster;
86
89 [optional] interface XEventsSupplier;
90
93 [optional] interface XViewDataSupplier;
94
99 [optional] interface com::sun::star::view::XPrintJobBroadcaster;
100
105 [optional] interface XEmbeddedScripts;
106
111 [optional] interface XDocumentPropertiesSupplier;
112
115 [optional] interface XUndoManagerSupplier;
116
125 [property, optional] boolean AutomaticControlFocus;
126
134 [property, optional] boolean ApplyFormDesignMode;
135
142 [property, optional, readonly] string RuntimeUID;
143
153 [optional, property] sequence<com::sun::star::beans::PropertyValue> InteropGrabBag;
154};
155
156
157}; }; }; };
158
159/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::document::XDocumentEventBroadcaster
allows to be notified of events happening in an OfficeDocument, and to cause notification of such eve...
Definition: XDocumentEventBroadcaster.idl:36
com::sun::star::document::XDocumentPropertiesSupplier
provides access to the XDocumentProperties instance of a document.
Definition: XDocumentPropertiesSupplier.idl:36
com::sun::star::document::XEmbeddedScripts
is supported by OfficeDocuments which allow to embed scripts
Definition: XEmbeddedScripts.idl:29
com::sun::star::document::XEventBroadcaster
makes it possible to register listeners which are called whenever a document event (see EventObject) ...
Definition: XEventBroadcaster.idl:30
com::sun::star::document::XEventsSupplier
gives access to a list of URLs bound to events of this object
Definition: XEventsSupplier.idl:26
com::sun::star::document::XUndoManagerSupplier
provides access to an XUndoManager.
Definition: XUndoManagerSupplier.idl:31
com::sun::star::document::XViewDataSupplier
gives access to some properties describing all open views to a document
Definition: XViewDataSupplier.idl:34
com::sun::star::frame::XModel
represents a component which is created from a URL and arguments.
Definition: XModel.idl:51
com::sun::star::frame::XStorable
offers a simple way to store a component to a URL.
Definition: XStorable.idl:42
com::sun::star::util::XModifiable
makes the modify state of the object accessible.
Definition: XModifiable.idl:31
com::sun::star::view::XPrintJobBroadcaster
allows for getting information about a print job.
Definition: XPrintJobBroadcaster.idl:34
com::sun::star::view::XPrintable
offers printing functionality.
Definition: XPrintable.idl:28
com
Definition: Ambiguous.idl:20
com::sun::star::document::OfficeDocument
abstract service which specifies a storable and printable document
Definition: OfficeDocument.idl:34
com::sun::star::document::OfficeDocument::InteropGrabBag
sequence< com::sun::star::beans::PropertyValue > InteropGrabBag
Grab bag of document properties, used as a string-any map for interim interop purposes.
Definition: OfficeDocument.idl:153
com::sun::star::document::OfficeDocument::AutomaticControlFocus
boolean AutomaticControlFocus
controls the focus behavior of the form controls in the document
Definition: OfficeDocument.idl:115
com::sun::star::document::OfficeDocument::ApplyFormDesignMode
boolean ApplyFormDesignMode
controls the initial (on-load) behavior of the form controls in the document
Definition: OfficeDocument.idl:134
com::sun::star::document::OfficeDocument::RuntimeUID
string RuntimeUID
contains a unique id for the document
Definition: OfficeDocument.idl:142