/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: RenderOptions.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: kz $ $Date: 2005-10-05 14:29:40 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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 OOo 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
