org.eclipse.text.undo.IDocumentUndoListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2006, 2008 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.text.undo;


/**
 * This interface is used to listen to notifications from a DocumentUndoManager.
 * The supplied DocumentUndoEvent describes the particular notification.
 * 
 * Document undo listeners must be prepared to receive notifications from a
 * background thread. Any UI access occurring inside the implementation must be
 * properly synchronized using the techniques specified by the client's widget
 * library.
 * 
 * Clients may implement this interface.
 * 
 *
 * @since 3.2
 */
public interface IDocumentUndoListener {

	/**
	 * The document is involved in an undo-related change.  Notify listeners
	 * with an event describing the change.
	 *
	 * @param event the document undo event that describes the particular notification
	 */
	void documentUndoNotification(DocumentUndoEvent event);

}