xref: /trunk/main/offapi/com/sun/star/awt/XPrinterPropertySet.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * 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_awt_XPrinterPropertySet_idl__
#define __com_sun_star_awt_XPrinterPropertySet_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_PropertyVetoException_idl__
#include <com/sun/star/beans/PropertyVetoException.idl>
#endif

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


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

 module com {  module sun {  module star {  module awt {

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

/** represents an extended property set for printer properties.

    <p>All properties are vetoable properties. If you change the properties
    between <member scope="com::sun::star::awt">XPrinter::startPage</member>
    and <member scope="com::sun::star::awt">XPrinter::endPage</member>, a
    <type scope="com::sun::star::beans">PropertyVetoException</type>
    is thrown.</p>

    @see XPrinter
    @see XInfoPrinter
 */
published interface XPrinterPropertySet: com::sun::star::beans::XPropertySet
{
    //-------------------------------------------------------------------------

    /** sets the orientation.
     */
    void setHorizontal( [in] boolean bHorizontal )
            raises( com::sun::star::beans::PropertyVetoException,
                    com::sun::star::lang::IllegalArgumentException );

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

    /** returns descriptions of all available printer forms.
     */
    sequence<string> getFormDescriptions();

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

    /** sets the form that should be used.

        <p>Indirectly a printer is selected.</p>
     */
    void selectForm( [in] string aFormDescription )
            raises( com::sun::star::beans::PropertyVetoException,
                    com::sun::star::lang::IllegalArgumentException );

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

    /** returns a binary encoded version of the printer setup.
     */
    sequence<byte> getBinarySetup();

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

    /** sets the data specific to the printer driver.

        <p>Get this data from the info printer and set the data to the
        printer.</p>
     */
    void setBinarySetup( [in] sequence<byte> data )
            raises( com::sun::star::beans::PropertyVetoException,
                    com::sun::star::lang::IllegalArgumentException );

};

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

}; }; }; };

#endif