xref: /trunk/main/offapi/com/sun/star/style/XStyleLoader.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_style_XStyleLoader_idl__
#define __com_sun_star_style_XStyleLoader_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif


//=============================================================================

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

//=============================================================================

// DocMerge from xml: interface com::sun::star::style::XStyleLoader
/** enables the object to import styles from documents.
 */
published interface XStyleLoader: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::style::XStyleLoader::loadStylesFromURL
	/** 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 string URL:
	 		The directory and the filename from document with the styles
	 	@param aOptions :
	 		Specifies which of the Style families the method should load.
	 	The sequence <PropertyValue/> 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>
		</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 <member>XStyleLoader::loadStylesFromURL</member>
	with their current values.
	*/
	sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions();

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif