001/* ----------------------------------------------------------------------------
002   The Kiwi Toolkit - A Java Class Library
003   Copyright (C) 1998-2004 Mark A. Lindner
004
005   This library is free software; you can redistribute it and/or
006   modify it under the terms of the GNU General Public License as
007   published by the Free Software Foundation; either version 2 of the
008   License, or (at your option) any later version.
009
010   This library is distributed in the hope that it will be useful,
011   but WITHOUT ANY WARRANTY; without even the implied warranty of
012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013   General Public License for more details.
014
015   You should have received a copy of the GNU General Public License
016   along with this library; if not, write to the Free Software
017   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
018   02111-1307, USA.
019 
020   The author may be contacted at: mark_a_lindner@yahoo.com
021   ----------------------------------------------------------------------------
022   $Log: PluginContext.java,v $
023   Revision 1.3  2004/05/12 18:03:42  markl
024   javadoc updates
025
026   Revision 1.2  2003/01/19 09:31:22  markl
027   Javadoc & comment header updates.
028
029   Revision 1.1  2001/03/12 10:20:59  markl
030   New classes.
031   ----------------------------------------------------------------------------
032*/
033
034package kiwi.util.plugin;
035
036/** The application context for a plugin. This interface provides a means for
037 * a plugin to communicate with the application in which it resides.
038 *
039 * @since Kiwi 1.3
040 *
041 * @author Mark Lindner
042 */
043
044public interface PluginContext
045  {
046
047  /** Show a status message in the application's status bar or other status
048   * area.
049   *
050   * @param text The status message.
051   */
052  
053  public void showStatus(String text);
054
055  /** Show a message, perhaps as an alert dialog box.
056   *
057   * @param text The text of the message.
058   */
059
060  public void showMessage(String text);
061
062  /** Show a yes/no or ok/cancel style question, perhaps as an alert dialog
063   * box.
064   *
065   * @param text The text of the message.
066   * @return <code>true</code> if a positive (yes/ok) response was received,
067   * and <code>false</code> otherwise.
068   */
069  
070  public boolean showQuestion(String text);
071
072  }
073
074/* end of source file */