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