summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/style/XStyleLoader.idl
blob: 566f6fb263dbe621b21c21c7e724fbd89087d193 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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_style_XStyleLoader_idl__
#define __com_sun_star_style_XStyleLoader_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/PropertyValue.idl>
#include <com/sun/star/io/IOException.idl>



 module com {  module sun {  module star {  module style {

/** enables the object to import styles from documents.
 */
published interface XStyleLoader: com::sun::star::uno::XInterface
{
    /** loads styles from a document at the given URL.
        <p>
        If <var>OverwriteStyles</var> is `TRUE`, then all styles
        will be loaded.  Otherwise, only styles which are not already
        defined in this document are loaded.</p>
         @param URL
             The directory and the filename from document with the styles
             You can also load from stream. Use "private:stream" as the URL and the InputStream parameter below.
         @param aOptions
             Specifies which of the Style families the method should load.

         The <code>sequence<PropertyValue></code> has the following, optional items:
         <ul>
        <li> boolean LoadCellStyles </li>
        <li> boolean LoadTextStyles </li>
        <li> boolean LoadFrameStyles </li>
        <li> boolean LoadPageStyles </li>
        <li> boolean LoadNumberingStyles </li>
        <li> boolean OverwriteStyles</li>
        <li> com::sun::star::io::XInputStream InputStream (since LibreOffice 7.0)</li>
        </ul>
     <p>As the default, all supported style families are loaded and existing styles are overwritten.</p>
     */
    void loadStylesFromURL( [in] string URL,
             [in] sequence<com::sun::star::beans::PropertyValue> aOptions )
            raises( com::sun::star::io::IOException );

    /** @returns
    a sequence of the supported properties as declared in XStyleLoader::loadStylesFromURL()
    with their current values.
    */
    sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions();

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */