1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_view_XRenderable_idl__ 28#define __com_sun_star_view_XRenderable_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_beans_PropertyValue_idl__ 35#include <com/sun/star/beans/PropertyValue.idl> 36#endif 37 38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 39#include <com/sun/star/lang/IllegalArgumentException.idl> 40#endif 41 42//============================================================================= 43 44module com { module sun { module star { module view { 45 46//============================================================================= 47 48/** represents something that can be rendered. 49 50 @since OOo 1.1.2 51 */ 52published interface XRenderable : com::sun::star::uno::XInterface 53{ 54 //------------------------------------------------------------------------- 55 56 /** @returns 57 the count of renderers (based on paper count of a document, for example). 58 59 <p> If a selection is given, the count has to be calculated 60 based on this selection. The other methods of this interface 61 will rely on this value if called. 62 63 <p> If the selection contains a valid XModel interface, 64 it is assumed that the whole document should be rendered. 65 If the selection is empty, nothing should be rendered. 66 67 @see RenderOptions 68 */ 69 long getRendererCount( [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) 70 raises( com::sun::star::lang::IllegalArgumentException ); 71 72 //------------------------------------------------------------------------- 73 74 /** @returns 75 a descriptor of the specific renderer. 76 77 <p> returns the specific renderer properties based on the given selection. 78 79 <p> If the selection contains a valid XModel interface, 80 it is assumed that the whole document should be rendered. 81 If the selection is empty, nothing should be rendered. 82 83 @see RenderDescriptor 84 @see RenderOptions 85 */ 86 sequence<com::sun::star::beans::PropertyValue> getRenderer( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) 87 raises( com::sun::star::lang::IllegalArgumentException ); 88 89 //------------------------------------------------------------------------- 90 91 /** renders the object. 92 93 <p> renders the object with the specific renderer based on the given selection. 94 95 <p> If the selection contains a valid XModel interface, 96 it is assumed that the whole document should be rendered. 97 If the selection is empty, nothing should be rendered. 98 99 @see RenderOptions 100 */ 101 void render( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) 102 raises( com::sun::star::lang::IllegalArgumentException ); 103 104}; 105 106//============================================================================= 107 108}; }; }; }; 109 110#endif 111