AOO410/main/offapi/com/sun/star/view/RenderOptions.idl

/**************************************************************
 * 
 * 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_view_RenderOptions_idl__ 
#define __com_sun_star_view_RenderOptions_idl__ 
 
#ifndef __com_sun_star_awt_XDevice_idl__ 
#include <com/sun/star/awt/XDevice.idl> 
#endif 

//============================================================================= 
 
module com {  module sun {  module star {  module view {  
 
//============================================================================= 
 
/** describes the options for Render jobs.

    @since OpenOffice 1.1.2
 */
published service RenderOptions
{ 
	//------------------------------------------------------------------------- 
		
	/** specifies the device the page should be rendered to
	 */
	[property] com::sun::star::awt::XDevice RenderDevice;

    //------------------------------------------------------------------------- 
        
    /** indicates that the current page is the first page to be exported.
            
        <p>Hyperlinks, notes, and outlines cannot be exported on a per 
        page base. They have to be exported once *before* the first page 
        is exported. Therefore the IsFirstPage property has been introduced. 
        It is evaluated in the ::render function and indicates that the 
        current page is the first page to be exported.
        </p>

        @see XRenderable
     */
    [optional, property] boolean IsFirstPage;
    //------------------------------------------------------------------------- 
        
    /** indicates that the current page is the last page to be exported.

        <p>Hyperlinks from the EditEngine have to be exported once *after* 
        the last page has been processed. Therefore the IsLastPage property 
        has been introduced. It is evaluated in the ::render function and 
        indicates that the current page is the last page to be exported.
        </p>

        @see XRenderable
     */
    [optional, property] boolean IsLastPage;
    //------------------------------------------------------------------------- 
        
    /** specifies if empty pages should be skipped.

        <p>Tells the pdf export to skip empty pages. This flag also has 
        to be passed to the ::render function, in order to calculate to 
        correct page numbers during the export of hyperlinks, notes, and 
        outlines.
        </p>

        @see XRenderable
     */
    [optional, property] boolean IsSkipEmptyPages;
    //------------------------------------------------------------------------- 
        
    /** specifies the page ranges to be rendered.

        <p>Tells the pdf export to skip empty pages. This flag also has 
        to be passed to the ::render function, in order to calculate to 
        correct page numbers during the export of hyperlinks, notes, 
        and outlines.
        </p>

        @see XRenderable
     */
    [optional, property] string PageRange;
}; 
 
//============================================================================= 
 
}; }; }; };  
 

#endif