offapi/com/sun/star/style/XStyleLoader.idl

   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
  21
  22  module com {  module sun {  module star {  module style {
  23
  24 /** enables the object to import styles from documents.
  25  */
  26 published interface XStyleLoader: com::sun::star::uno::XInterface
  27 {
  28     /** loads styles from a document at the given URL.
  29         <p>
  30         If <var>OverwriteStyles</var> is `TRUE`, then all styles
  31         will be loaded.  Otherwise, only styles which are not already
  32         defined in this document are loaded.</p>
  33          @param URL
  34              The directory and the filename from document with the styles
  35              You can also load from stream. Use "private:stream" as the URL and the InputStream parameter below.
  36          @param aOptions
  37              Specifies which of the Style families the method should load.
  38
  39          The <code>sequence<PropertyValue></code> has the following, optional items:
  40          <ul>
  41         <li> boolean LoadCellStyles </li>
  42         <li> boolean LoadTextStyles </li>
  43         <li> boolean LoadFrameStyles </li>
  44         <li> boolean LoadPageStyles </li>
  45         <li> boolean LoadNumberingStyles </li>
  46         <li> boolean OverwriteStyles</li>
  47         <li> com::sun::star::io::XInputStream InputStream (since LibreOffice 7.0)</li>
  48         </ul>
  49      <p>As the default, all supported style families are loaded and existing styles are overwritten.</p>
  50      */
  51     void loadStylesFromURL( [in] string URL,
  52              [in] sequence<com::sun::star::beans::PropertyValue> aOptions )
  53             raises( com::sun::star::io::IOException );
  54
  55     /** @returns
  56     a sequence of the supported properties as declared in XStyleLoader::loadStylesFromURL()
  57     with their current values.
  58     */
  59     sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions();
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */