xref: /aoo41x/main/offapi/com/sun/star/document/UndoManagerEvent.idl (revision d1766043)

/**************************************************************
 *
 * 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_document_UndoManagerEvent_idl__
#define __com_sun_star_document_UndoManagerEvent_idl__

#include <com/sun/star/lang/EventObject.idl>

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

module com { module sun { module star { module document {

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

/** is an event sent by an <type>XUndoManager</type> implementation when the Undo/Redo stacks of the manager are
    modified.
    @see XUndoManager
    @see XUndoManagerListener
    @see XUndoAction
 */
published struct UndoManagerEvent : ::com::sun::star::lang::EventObject
{
    /** the title of the undo action which is described by the event
        @see XUndoAction::Title
    */
    string  UndoActionTitle;

    /** denotes the number of Undo contexts which are open, and not yet closed, at the time the event is fired.
        @see XUndoManager::enterUndoContext
    */
    long    UndoContextDepth;
};

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

}; }; }; };

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

#endif