xref: /aoo4110/main/offapi/com/sun/star/text/PrintSettings.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_text_PrintSettings_idl__
#define __com_sun_star_text_PrintSettings_idl__

#ifndef __com_sun_star_text_NotePrintMode_idl__
#include <com/sun/star/text/NotePrintMode.idl>
#endif


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

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

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

// DocMerge from xml: service com::sun::star::text::PrintSettings
/** These properties describe the printing of the content of a text document.
 */
published service PrintSettings
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintGraphics
	/** determines if graphic objects are printed
	 */
	[property] boolean PrintGraphics;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintTables
	/** determines if text tables are printed.
	 */
	[property] boolean PrintTables;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintDrawings
	/** determines if shapes are printed.
	 */
	[property] boolean PrintDrawings;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintLeftPage
	/** determines if left pages are printed.
	 */
	[property] boolean PrintLeftPages;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintRightPage
	/** determines if right pages are printed.
	 */
	[property] boolean PrintRightPages;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintControls
	/** determines if control shapes are printed.
	 */
	[property] boolean PrintControls;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintReverse
	/** determines if the pages are printed in the reverse order, starting with the last page.
	 */
	[property] boolean PrintReversed;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PaperFromSetup
	/** specifies if the printer paper tray selection of the system
		printer is used.



		<p>If <member scope="com::sun::star::view">PrintSettings::PaperFromSetup</member> is <FALSE/>,
		then the paper tray selection of the page styles is used.</p>
	 */
	[property] boolean PrintPaperFromSetup;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::FaxName
	/** contains the name of the fax.
	 */
	[property] string PrintFaxName;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintNotes
	/** determines how notes are printed.@see NotePrintMode
	 */
	[property] com::sun::star::text::NotePrintMode PrintAnnotationMode;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintProspect
	/** determines if prospect printing is used.
	 */
	[property] boolean PrintProspect;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBackground
	/** determines if the background color / background graphic of pages is printed.
	 */
	[property] boolean PrintPageBackground;

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

	// DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBlackFont
	/** determines if characters are always printed in black.
	 */
	[property] boolean PrintBlackFonts;

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

        /** determines if automatically inserted empty pages are printed.
         */
        [optional, property] boolean PrintEmptyPages;
};

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

}; }; }; };

#endif