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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_style_XStyleLoader_idl__
  29 #define __com_sun_star_style_XStyleLoader_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/beans/PropertyValue.idl>
  33 #include <com/sun/star/io/IOException.idl>
  34
  35
  36 //=============================================================================
  37
  38  module com {  module sun {  module star {  module style {
  39
  40 //=============================================================================
  41
  42 // DocMerge from xml: interface com::sun::star::style::XStyleLoader
  43 /** enables the object to import styles from documents.
  44  */
  45 published interface XStyleLoader: com::sun::star::uno::XInterface
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     // DocMerge from xml: method com::sun::star::style::XStyleLoader::loadStylesFromURL
  50     /** loads styles from a document at the given URL.
  51         <p>
  52         If <var>OverwriteStyles</var> is <TRUE/>, then all styles
  53         will be loaded.  Otherwise, only styles which are not already
  54         defined in this document are loaded.</p>
  55          @param string URL:
  56              The directory and the filename from document with the styles
  57          @param aOptions :
  58              Specifies which of the Style families the method should load.
  59          The sequence <PropertyValue/> has the following, optional items:
  60          <ul>
  61         <li> boolean LoadCellStyles </li>
  62         <li> boolean LoadTextStyles </li>
  63         <li> boolean LoadFrameStyles </li>
  64         <li> boolean LoadPageStyles </li>
  65         <li> boolean LoadNumberingStyles </li>
  66         <li> boolean OverwriteStyles</li>
  67         </ul>
  68      <p>As the default, all supported style families are loaded and existing styles are overwritten.</p>
  69      */
  70     void loadStylesFromURL( [in] string URL,
  71              [in] sequence<com::sun::star::beans::PropertyValue> aOptions )
  72             raises( com::sun::star::io::IOException );
  73
  74     //-------------------------------------------------------------------------
  75     /** @returns
  76     a sequence of the supported properties as declared in <member>XStyleLoader::loadStylesFromURL</member>
  77     with their current values.
  78     */
  79     sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions();
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 /*=============================================================================
  88
  89 =============================================================================*/
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */