Back to index

lightning-sunbird  0.9+nobinonly
nsAESpyglassSuiteHandler.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Simon Fraser <sfraser@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsAESpyglassSuiteHandler_h_
00040 #define nsAESpyglassSuiteHandler_h_
00041 
00042 
00043 #include "nsAEUtils.h"
00044 
00045 class nsDocLoadObserver;
00046 
00047 class AESpyglassSuiteHandler
00048 {
00049 public:
00050        enum {
00051               kSuiteSignature                                  = 'WWW!',
00052                             
00053               kOpenURLEvent                             = 'OURL',                   // OpenURL
00054               kRegisterURLEchoEvent              = 'RGUE',                   // Register URL echo handler
00055               kUnregisterURLEchoEvent     = 'UNRU',                   // Unregister URL echo handler
00056 
00057 // the following are unhandled in Mozilla
00058               kRegisterViewerEvent               = 'RGVW',                   // RegisterViewer
00059               kUnregisterViewerEvent      = 'UNRV',                   // UnregisterViewer
00060               kShowFileEvent                                   = 'SHWF',                   // ShowFile
00061               kParseAnchorEvent                  = 'PRSA',                   // ParseAnchor
00062               kSpyActivateEvent                  = 'ACTV',                   // Activate
00063               kSpyListWindowsEvent        = 'LSTW',                   // ListWindows
00064               kGetWindowInfoEvent         = 'WNFO',                   // GetWindowInfo
00065               kRegisterWinCloseEvent      = 'RGWC',                   // RegisterWindowClose
00066               kUnregisterWinCloseEvent    = 'UNRC',                   // UnregisterWindowClose
00067               kRegisterProtocolEvent             = 'RGPR',                   // RegisterProtocol
00068               kUnregisterProtocolEvent    = 'UNRP',                   // UnregisterProtocol
00069               kCancelProgressEvent        = 'CNCL',                   // Cancel download
00070               kFindURLEvent                             = 'FURL',                   // Find the URL for the file
00071 
00072 // Spyglass send events
00073 
00074               kSpyglassSendSignature      = 'WWW?',
00075               kSendURLEchoEvent                  = 'URLE'
00076 
00077        };
00078 
00079        // event params
00080        enum {
00081               kParamSaveToFileDest        = 'INTO',            // FSSpec save to file
00082               kParamOpenInWindow          = 'WIND',            // long, target window (window ID)
00083               kParamOpenFlags                    = 'FLGS',            // long, Binary: any combination of 1, 2 and 4 is allowed: 1 and 2 mean force reload the document. 4 is ignored
00084               kParamPostData                     = 'POST',            // text, Form posting data
00085               kParamPostType                     = 'MIME',            // text, MIME type of the posting data. Defaults to application/x-www-form-urlencoded
00086               kParamProgressApp                  = 'PROG'             // 'psn ', Application that will display progress
00087        };
00088        
00089                                           AESpyglassSuiteHandler();
00090                                           ~AESpyglassSuiteHandler();
00091 
00092        void                               HandleSpyglassSuiteEvent(const AppleEvent *appleEvent, AppleEvent *reply);   // throws OSErrs
00093 
00094 protected:
00095 
00096        void                               HandleOpenURLEvent(const AppleEvent *appleEvent, AppleEvent *reply);
00097        
00098        void                               HandleRegisterURLEchoEvent(const AppleEvent *appleEvent, AppleEvent *reply);
00099        void                               HandleUnregisterURLEchoEvent(const AppleEvent *appleEvent, AppleEvent *reply);
00100 
00101 protected:
00102 
00103     nsDocLoadObserver*  mDocObserver;
00104     
00105 };
00106 
00107 
00108 
00109 #endif // nsAESpyglassSuiteHandler_h_