modules/oji/public/nsIJVMConsole.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 ////////////////////////////////////////////////////////////////////////////////
  39 // NETSCAPE JAVA VM PLUGIN EXTENSIONS
  40 //
  41 // This interface allows a Java virtual machine to be plugged into
  42 // Communicator to implement the APPLET tag and host applets.
  43 //
  44 // Note that this is the C++ interface that the plugin sees. The browser
  45 // uses a specific implementation of this, nsJVMPlugin, found in jvmmgr.h.
  46 ////////////////////////////////////////////////////////////////////////////////
  47
  48 #ifndef nsIJVMConsole_h___
  49 #define nsIJVMConsole_h___
  50
  51 #include "nsIJVMWindow.h"
  52
  53 #define NS_IJVMCONSOLE_IID                           \
  54 { /* fefaf860-6220-11d2-8164-006008119d7a */         \
  55     0xfefaf860,                                      \
  56     0x6220,                                          \
  57     0x11d2,                                          \
  58     {0x81, 0x64, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
  59 }
  60
  61 ////////////////////////////////////////////////////////////////////////////////
  62 // JVM Console Interface
  63 // This interface defines the API the browser needs to show and hide the JVM's
  64 // Java console, and to send text to it.
  65
  66 class nsIJVMConsole : public nsIJVMWindow {
  67 public:
  68     NS_IMETHOD
  69     Show(void) = 0;
  70
  71     NS_IMETHOD
  72     Hide(void) = 0;
  73
  74     NS_IMETHOD
  75     IsVisible(PRBool *result) = 0;
  76
  77     // Prints a message to the Java console. The encodingName specifies the
  78     // encoding of the message, and if NULL, specifies the default platform
  79     // encoding.
  80     NS_IMETHOD
  81     Print(const char* msg, const char* encodingName = NULL) = 0;
  82
  83     NS_DECLARE_STATIC_IID_ACCESSOR(NS_IJVMCONSOLE_IID)
  84 };
  85
  86 NS_DEFINE_STATIC_IID_ACCESSOR(nsIJVMConsole, NS_IJVMCONSOLE_IID)
  87
  88 ////////////////////////////////////////////////////////////////////////////////
  89
  90 #endif /* nsIJVMConsole_h___ */