001/* A simple interface for Vergil GUI actions performed on the model.
002
003 Copyright (c) 2010-2014 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 2
027 */
028package ptolemy.vergil.basic;
029
030import ptolemy.kernel.util.NamedObj;
031
032///////////////////////////////////////////////////////////////////
033//// IGuiAction
034
035/**
036A simple interface that allows to define actions for Vergil that
037operate on the model. Vergil needs no specific dependencies on
038the class implementing the actions but can just call doAction
039to trigger it.
040
041@author  Christian Motika
042@version $Id$
043@since Ptolemy II 10.0
044@Pt.ProposedRating Red (cmot)
045@Pt.AcceptedRating Red (cmot)
046 */
047public interface IGuiAction {
048
049    /**
050     * Perform the action/modification on the current model triggered
051     * by a Vergil GUI action.
052     *
053     * @param model the current Ptolemy model
054     */
055    public void doAction(NamedObj model);
056
057}