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

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