xref: /aoo4110/main/offapi/com/sun/star/text/XRedline.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_XRedline_idl__
#define __com_sun_star_text_XRedline_idl__

#ifndef __com_sun_star_beans_PropertyValues_idl__
#include <com/sun/star/beans/PropertyValues.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 {

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

/** enables creation of redlines (change tracking).
 */
published interface XRedline
{
	//-------------------------------------------------------------------------

        /**
                @param RedlineType
                <p> Valid type names are:</p>
                    <UL>
                    <LI><P>Insert - marks an insertion</P>
                    <LI><P>Delete - marks an deletion</P>
                    <LI><P>Format - marks an attribute change</P>
                    <LI><P>TextTable - marks a text table</P>
                    <LI><P>Style - marks an applied style</P>
                </UL>
                @param RedlineProperties
                        contains the following parameters
                [readonly, property] string RedlineAuthor;
                [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
                [readonly, property] string RedlineComment;
        */
        void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues  RedlineProperties)
                        raises( com::sun::star::lang::IllegalArgumentException );
};

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

}; }; }; };

#endif