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

/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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