offapi/com/sun/star/text/XPagePrintable.idl

   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_text_XPagePrintable_idl__
  28 #define __com_sun_star_text_XPagePrintable_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 //=============================================================================
  44
  45  module com {  module sun {  module star {  module text {
  46
  47 //=============================================================================
  48
  49 /** Print several pages on one printer page.
  50  */
  51 published interface XPagePrintable: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** @returns the settings of printing of pages.
  56              <p>
  57              These settings contains:
  58             <UL>
  59                 <LI><P>short PageRows  - number of rows of pages printed to one page  </P>
  60                 <LI><P>short PageColumns - number of columns of pages printed to one page</P>
  61                 <LI><P>long LeftMargin  - left margin of the page</P>
  62                 <LI><P>long RightMargin - right margin of the page</P>
  63                 <LI><P>long TopMargin   - top margin of the page</P>
  64                 <LI><P>long BottomMargin - bottom margin of the page</P>
  65                 <LI><P>long HoriMargin  - margin between rows of pages</P>
  66                 <LI><P>long VertMargin  - margin between columns of pages</P>
  67                 <LI><P>boolean IsLandscape - determins if the output page is printed in landscape format</P>
  68             </UL>
  69              </p>
  70      */
  71     sequence<com::sun::star::beans::PropertyValue> getPagePrintSettings();
  72
  73     //-------------------------------------------------------------------------
  74         /** adjusts the settings of the page printing.
  75             @see getPagePrintSettings
  76      */
  77     void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings );
  78
  79     //-------------------------------------------------------------------------
  80
  81     // DocMerge from xml: method com::sun::star::text::XPagePrintable::printPages
  82     /** prints the pages according to the <typ>PagePrintSettings</type>.
  83
  84     @see com::sun::star::view::PrintOptions
  85      */
  86     void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  87             raises( com::sun::star::lang::IllegalArgumentException );
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95
  96 #endif