offapi/com/sun/star/view/XRenderable.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: XRenderable.idl,v $
  10  * $Revision: 1.13 $
  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_view_XRenderable_idl__
  31 #define __com_sun_star_view_XRenderable_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_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module view {
  48
  49 //=============================================================================
  50
  51 /** represents something that can be rendered.
  52
  53     @since OOo 1.1.2
  54  */
  55 published interface XRenderable : com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** @returns
  60             the count of renderers (based on paper count of a document, for example).
  61
  62         <p> If a selection is given, the count has to be calculated
  63             based on this selection. The other methods of this interface
  64             will rely on this value if called.
  65
  66         <p> If the selection contains a valid XModel interface,
  67             it is assumed that the whole document should be rendered.
  68             If the selection is empty, nothing should be rendered.
  69
  70         @see RenderOptions
  71      */
  72     long getRendererCount( [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  73             raises( com::sun::star::lang::IllegalArgumentException );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** @returns
  78             a descriptor of the specific renderer.
  79
  80         <p> returns the specific renderer properties based on the given selection.
  81
  82         <p> If the selection contains a valid XModel interface,
  83             it is assumed that the whole document should be rendered.
  84             If the selection is empty, nothing should be rendered.
  85
  86         @see RenderDescriptor
  87         @see RenderOptions
  88      */
  89     sequence<com::sun::star::beans::PropertyValue> getRenderer( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  90             raises( com::sun::star::lang::IllegalArgumentException );
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** renders the object.
  95
  96         <p> renders the object with the specific renderer based on the given selection.
  97
  98         <p> If the selection contains a valid XModel interface,
  99             it is assumed that the whole document should be rendered.
 100             If the selection is empty, nothing should be rendered.
 101
 102         @see RenderOptions
 103      */
 104     void render( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
 105             raises( com::sun::star::lang::IllegalArgumentException );
 106
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif