xref: /aoo41x/main/offapi/com/sun/star/text/XPagePrintable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XPagePrintable_idl__
#define __com_sun_star_text_XPagePrintable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** Print several pages on one printer page.
 */
published interface XPagePrintable: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** @returns the settings of printing of pages.
			 <p>
			 These settings contains:
			<UL>
				<LI><P>short PageRows  - number of rows of pages printed to one page  </P>
				<LI><P>short PageColumns - number of columns of pages printed to one page</P>
				<LI><P>long LeftMargin  - left margin of the page</P>
				<LI><P>long RightMargin - right margin of the page</P>
				<LI><P>long TopMargin   - top margin of the page</P>
				<LI><P>long BottomMargin - bottom margin of the page</P>
				<LI><P>long HoriMargin  - margin between rows of pages</P>
				<LI><P>long VertMargin  - margin between columns of pages</P>
				<LI><P>boolean IsLandscape - determins if the output page is printed in landscape format</P>
			</UL>
			 </p>
	 */
	sequence<com::sun::star::beans::PropertyValue> getPagePrintSettings();

	//-------------------------------------------------------------------------
        /** adjusts the settings of the page printing.
            @see getPagePrintSettings
	 */
	void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings );

	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::text::XPagePrintable::printPages
    /** prints the pages according to the <typ>PagePrintSettings</type>.

	@see com::sun::star::view::PrintOptions
	 */
	void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
			raises( com::sun::star::lang::IllegalArgumentException );

};

//=============================================================================

}; }; }; };


#endif