offapi/com/sun/star/view/XRenderable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module view {
  22
  23
  24 /** represents something that can be rendered.
  25
  26     @since OOo 1.1.2
  27  */
  28 published interface XRenderable : com::sun::star::uno::XInterface
  29 {
  30
  31     /** @returns
  32             the count of renderers (based on paper count of a document, for example).
  33
  34         <p> If a selection is given, the count has to be calculated
  35             based on this selection. The other methods of this interface
  36             will rely on this value if called.
  37
  38         <p> If the selection contains a valid XModel interface,
  39             it is assumed that the whole document should be rendered.
  40             If the selection is empty, nothing should be rendered.
  41
  42         @see RenderOptions
  43      */
  44     long getRendererCount( [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  45             raises( com::sun::star::lang::IllegalArgumentException );
  46
  47
  48     /** @returns
  49             a descriptor of the specific renderer.
  50
  51         <p> returns the specific renderer properties based on the given selection.
  52
  53         <p> If the selection contains a valid XModel interface,
  54             it is assumed that the whole document should be rendered.
  55             If the selection is empty, nothing should be rendered.
  56
  57         @see RenderDescriptor
  58         @see RenderOptions
  59      */
  60     sequence<com::sun::star::beans::PropertyValue> getRenderer( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  61             raises( com::sun::star::lang::IllegalArgumentException );
  62
  63
  64     /** renders the object.
  65
  66         <p> renders the object with the specific renderer based on the given selection.
  67
  68         <p> If the selection contains a valid XModel interface,
  69             it is assumed that the whole document should be rendered.
  70             If the selection is empty, nothing should be rendered.
  71
  72         @see RenderOptions
  73      */
  74     void render( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  75             raises( com::sun::star::lang::IllegalArgumentException );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */