contrib/include/wx/applet/window.h

   1 /****************************************************************************
   2 *
   3 *                       wxWindows HTML Applet Package
   4 *
   5 *               Copyright (C) 1991-2001 SciTech Software, Inc.
   6 *                            All rights reserved.
   7 *
   8 *  ======================================================================
   9 *  |REMOVAL OR MODIFICATION OF THIS HEADER IS STRICTLY PROHIBITED BY LAW|
  10 *  |                                                                    |
  11 *  |This copyrighted computer code is a proprietary trade secret of     |
  12 *  |SciTech Software, Inc., located at 505 Wall Street, Chico, CA 95928 |
  13 *  |USA (www.scitechsoft.com).  ANY UNAUTHORIZED POSSESSION, USE,       |
  14 *  |VIEWING, COPYING, MODIFICATION OR DISSEMINATION OF THIS CODE IS     |
  15 *  |STRICTLY PROHIBITED BY LAW.  Unless you have current, express       |
  16 *  |written authorization from SciTech to possess or use this code, you |
  17 *  |may be subject to civil and/or criminal penalties.                  |
  18 *  |                                                                    |
  19 *  |If you received this code in error or you would like to report      |
  20 *  |improper use, please immediately contact SciTech Software, Inc. at  |
  21 *  |530-894-8400.                                                       |
  22 *  |                                                                    |
  23 *  |REMOVAL OR MODIFICATION OF THIS HEADER IS STRICTLY PROHIBITED BY LAW|
  24 *  ======================================================================
  25 *
  26 * Language:     ANSI C++
  27 * Environment:  Any
  28 *
  29 * Description:  Header file for the wxHtmlAppletWindow class
  30 *
  31 ****************************************************************************/
  32
  33 #ifndef __WX_APPLET_WINDOW_H
  34 #define __WX_APPLET_WINDOW_H
  35
  36 #include "wx/html/htmlwin.h"
  37
  38 /*--------------------------- Class Definitions ---------------------------*/
  39
  40 // Declare a linked list of wxApplet pointers
  41 class wxApplet;
  42 WX_DECLARE_LIST(wxApplet, wxAppletList);
  43
  44 /****************************************************************************
  45 MEMBERS:
  46 appletModules   - List of register applet modules
  47 appletList      - List of all active applets instances
  48 cookies         - Hash table for managing cookies
  49
  50 REMARKS:
  51 Defines the class for wxAppletWindow. This class is derived from the
  52 wxHtmlWindow class and extends it with functionality to handle embedded
  53 wxApplet's on the HTML pages.
  54 ****************************************************************************/
  55 class wxHtmlAppletWindow : public wxHtmlWindow {
  56 private:
  57     DECLARE_CLASS(wxHtmlAppletWindow);
  58     DECLARE_EVENT_TABLE();
  59
  60 protected:
  61     wxAppletList    m_AppletList;
  62     wxHashTable     m_Cookies;
  63
  64 public:
  65             // Constructor
  66             wxHtmlAppletWindow(
  67                 wxWindow *parent,
  68                 wxWindowID id = -1,
  69                 const wxPoint& pos = wxDefaultPosition,
  70                 const wxSize& size = wxDefaultSize,
  71                 long style = wxHW_SCROLLBAR_AUTO,
  72                 const wxString& name = "htmlAppletWindow");
  73
  74             // Destructor
  75             ~wxHtmlAppletWindow();
  76
  77             // Create an instance of an applet based on it's class name
  78             wxApplet *CreateApplet(
  79                 const wxString& className,
  80                 const wxSize& size);
  81
  82             // Find an instance of an applet based on it's class name
  83             wxApplet *FindApplet(const wxString& className);
  84
  85             // Remove an applet from the window. Called during applet destruction
  86             bool RemoveApplet(const wxApplet *applet);
  87
  88             // Load a new URL page
  89             bool LoadPage(const wxString& hRef);
  90
  91             // Called when users clicked on hypertext link.
  92             void OnLinkClicked(const wxHtmlLinkInfo& link);
  93
  94             // Handles forward navigation within the HTML stack
  95             bool HistoryForward();
  96
  97             // Handles backwards navigation within the HTML stack
  98             bool HistoryBack();
  99
 100             // Broadcast a message to all applets on the page
 101             void SendMessage(wxEvent& msg);
 102
 103             // Register a cookie of data in the applet manager
 104             bool RegisterCookie(const wxString& name,wxObject *cookie);
 105
 106             // UnRegister a cookie of data in the applet manager
 107             bool UnRegisterCookie(const wxString& name);
 108
 109             // Find a cookie of data given it's public name
 110             wxObject *FindCookie(const wxString& name);
 111     };
 112
 113 #endif // __WX_APPLET_WINDOW_H
 114