LibreOffice LibreOffice 26.2 SDK API Reference

XDocumentTemplates.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 frame {
22
34published interface XDocumentTemplates: com::sun::star::uno::XInterface
35{
45 com::sun::star::ucb::XContent getContent();
46
66 boolean storeTemplate(
67 [in] string GroupName,
68 [in] string TemplateName,
69 [in] XStorable Storable);
70
90 boolean addTemplate(
91 [in] string GroupName,
92 [in] string TemplateName,
93 [in] string SourceURL);
94
108 boolean removeTemplate(
109 [in] string GroupName,
110 [in] string TemplateName);
111
128 boolean renameTemplate(
129 [in] string GroupName,
130 [in] string OldTemplateName,
131 [in] string NewTemplateName);
132
143 boolean addGroup( [in] string GroupName );
144
155 boolean removeGroup( [in] string GroupName );
156
170 boolean renameGroup(
171 [in] string OldGroupName,
172 [in] string NewGroupName);
173
182 void update();
183};
184
185
186}; }; }; };
187
188/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::frame::XDocumentTemplates
provides a high level API to organize document templates
Definition: XDocumentTemplates.idl:35
com::sun::star::frame::XDocumentTemplates::renameGroup
boolean renameGroup([in] string OldGroupName, [in] string NewGroupName)
rename an existing group
com::sun::star::frame::XDocumentTemplates::renameTemplate
boolean renameTemplate([in] string GroupName, [in] string OldTemplateName, [in] string NewTemplateName)
rename a template inside specified group
com::sun::star::frame::XDocumentTemplates::storeTemplate
boolean storeTemplate([in] string GroupName, [in] string TemplateName, [in] XStorable Storable)
creates the template with the given name in the given group using the data from the storable
com::sun::star::frame::XDocumentTemplates::addTemplate
boolean addTemplate([in] string GroupName, [in] string TemplateName, [in] string SourceURL)
creates the template with the given name in the given group using the given URL
com::sun::star::frame::XDocumentTemplates::addGroup
boolean addGroup([in] string GroupName)
creates a new group
com::sun::star::frame::XDocumentTemplates::removeGroup
boolean removeGroup([in] string GroupName)
remove an existing group
com::sun::star::frame::XDocumentTemplates::update
void update()
force an update for internal structures
com::sun::star::frame::XDocumentTemplates::getContent
com::sun::star::ucb::XContent getContent()
provides access to the root of internal used hierarchy
com::sun::star::frame::XDocumentTemplates::removeTemplate
boolean removeTemplate([in] string GroupName, [in] string TemplateName)
remove a template from specified group
com::sun::star::frame::XStorable
offers a simple way to store a component to a URL.
Definition: XStorable.idl:42
com::sun::star::ucb::XContent
specifies a content with a type and an identifier, which is able to manage listeners for events that ...
Definition: XContent.idl:32
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20