offapi/com/sun/star/text/XPagePrintable.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 #ifndef __com_sun_star_text_XPagePrintable_idl__
  20 #define __com_sun_star_text_XPagePrintable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30
  31 /** Print several pages on one printer page.
  32  */
  33 published interface XPagePrintable: com::sun::star::uno::XInterface
  34 {
  35
  36     /** @returns the settings of printing of pages.
  37              <p>
  38              These settings contains:
  39             <UL>
  40                 <LI><P>short PageRows  - number of rows of pages printed to one page  </P>
  41                 <LI><P>short PageColumns - number of columns of pages printed to one page</P>
  42                 <LI><P>long LeftMargin  - left margin of the page</P>
  43                 <LI><P>long RightMargin - right margin of the page</P>
  44                 <LI><P>long TopMargin   - top margin of the page</P>
  45                 <LI><P>long BottomMargin - bottom margin of the page</P>
  46                 <LI><P>long HoriMargin  - margin between rows of pages</P>
  47                 <LI><P>long VertMargin  - margin between columns of pages</P>
  48                 <LI><P>boolean IsLandscape - determines if the output page is printed in landscape format</P>
  49             </UL>
  50              </p>
  51      */
  52     sequence<com::sun::star::beans::PropertyValue> getPagePrintSettings();
  53
  54         /** adjusts the settings of the page printing.
  55             @see getPagePrintSettings
  56      */
  57     void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings );
  58
  59     /** prints the pages according to the PagePrintSettings.
  60
  61     @see com::sun::star::view::PrintOptions
  62      */
  63     void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  64             raises( com::sun::star::lang::IllegalArgumentException );
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */