Back to index

lightning-sunbird  0.9+nobinonly
MRJPage.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 1998
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either of the GNU General Public License Version 2 or later (the "GPL"),
00025  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 /*
00038        MRJPage.h
00039        
00040        Encapsulates the MRJ data structure.
00041        
00042        by Patrick C. Beard.
00043  */
00044 
00045 #ifndef __TYPES__
00046 #include <Types.h>
00047 #endif
00048 
00049 #ifndef CALL_NOT_IN_CARBON
00050        #define CALL_NOT_IN_CARBON 1
00051 #endif
00052 
00053 #include "JManager.h"
00054 
00055 // For now.
00056 typedef struct OpaqueJMAppletPageRef*     JMAppletPageRef;
00057 
00058 class MRJSession;
00059 
00060 struct MRJPageAttributes {
00061        UInt32 documentID;
00062        const char* codeBase;
00063        const char* archive;
00064        Boolean mayScript;
00065 };
00066 
00067 class MRJPage {
00068 public:
00069        MRJPage(MRJSession* session, UInt32 documentID, const char* codeBase, const char* archive, Boolean mayScript);
00070        MRJPage(MRJSession* session, const MRJPageAttributes& attributes);
00071        ~MRJPage();
00072        
00073        // Pages are reference counted.
00074        UInt16 AddRef(void);
00075        UInt16 Release(void);
00076        
00077        JMAppletPageRef getPageRef() { return mPageRef; }
00078        
00079        UInt32 getDocumentID() { return mDocumentID; }
00080        const char* getCodeBase() { return mCodeBase; }
00081        const char* getArchive() { return mArchive; }
00082        Boolean getMayScript() { return mMayScript; }
00083 
00084        // Creating AWTContexts.
00085        Boolean createContext(JMAWTContextRef* outContext,
00086                                                  const JMAWTContextCallbacks * callbacks,
00087                                                  JMClientData data);
00088 
00089     // Accessing the list of instances.
00090     static MRJPage* getFirstPage(void);
00091     MRJPage* getNextPage(void);
00092 
00093 private:
00094        void pushPage();
00095        void popPage();
00096 
00097 private:
00098        UInt16 mRefCount;
00099        MRJPage* mNextPage;
00100        MRJSession* mSession;
00101        JMAppletPageRef mPageRef;
00102        UInt32 mDocumentID;
00103        char* mCodeBase;
00104        char* mArchive;
00105        Boolean mMayScript;  
00106 };