Back to index

lightning-sunbird  0.9+nobinonly
nsAEDocumentClass.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 
00040 #ifndef __AEDOCUMENTCLASS__
00041 #define __AEDOCUMENTCLASS__
00042 
00043 #include "nsAEGenericClass.h"
00044 
00045 
00046 typedef WindowPtr    DocumentReference;          // for now, we'll refer to document by their window
00047 
00048 
00049 class AEDocumentClass : public AEGenericClass
00050 {
00051        friend class AECoreClass;
00052        
00053 private:
00054        typedef AEGenericClass      Inherited;
00055        
00056 protected:
00057        // only the AECoreClass can instantiate us
00058                                           AEDocumentClass();
00059                                           ~AEDocumentClass();
00060 
00061        void                               GetDocumentFromApp(         DescType                    desiredClass,        // cDocument
00062                                                                                     const AEDesc*        containerToken,      // null container
00063                                                                                     DescType                    containerClass,       // cApplication
00064                                                                                     DescType                    keyForm,
00065                                                                                     const AEDesc*        keyData,
00066                                                                                     AEDesc*                     resultToken);        // specified Document is returned in result
00067 
00068        virtual void                GetItemFromContainer(              DescType                    desiredClass,
00069                                                                                     const AEDesc*        containerToken,
00070                                                                                     DescType                    containerClass, 
00071                                                                                     DescType                    keyForm,
00072                                                                                     const AEDesc*        keyData,
00073                                                                                     AEDesc*                     resultToken);
00074 
00075 public:
00076 
00077        static pascal OSErr         DocumentAccessor(                  DescType                    desiredClass,        // cDocument
00078                                                                                     const AEDesc*        containerToken,      // null container
00079                                                                                     DescType                    containerClass,      // cApplication
00080                                                                                     DescType                    keyForm,
00081                                                                                     const AEDesc*        keyData,
00082                                                                                     AEDesc*                     resultToken,         // specified Document is returned in result
00083                                                                                     long                        refCon);
00084 
00085        static pascal OSErr         PropertyAccessor(                  DescType                    desiredClass,
00086                                                                                     const AEDesc*        containerToken,
00087                                                                                     DescType                    containerClass,
00088                                                                                     DescType                    keyForm,
00089                                                                                     const AEDesc*        keyData,
00090                                                                                     AEDesc*                     resultToken,
00091                                                                                     long                        refCon);
00092 
00093        void                               ProcessFormRelativePostition(      const AEDesc*               anchorToken,
00094                                                                                     const AEDesc*        keyData,
00095                                                                                     DocumentReference*   document);
00096 
00097        void                               CloseWindowSaving(                 AEDesc*                     token,
00098                                                                                     const AEDesc*        saving,
00099                                                                                     AEDesc*                     savingIn);
00100        
00101 protected:
00102 
00103        // ----------------------------------------------------------------------------
00104        //     Get and Set methods for objects and list. Note that the object methods are pure virtual
00105        // ----------------------------------------------------------------------------
00106        virtual void                GetDataFromObject(const AEDesc *token, AEDesc *desiredTypes, AEDesc *data);
00107        void                               GetDataFromList(AEDesc *srcList, AEDesc *desiredTypes, AEDesc *dstList);
00108 
00109        virtual void                SetDataForObject(const AEDesc *token, AEDesc *data);
00110        void                               SetDataForList(const AEDesc *token, AEDesc *data);
00111 
00112        virtual void                CreateSelfSpecifier(const AEDesc *token, AEDesc *outSpecifier);
00113 
00114        virtual Boolean                    CanSetProperty(DescType propertyCode);
00115        virtual Boolean                    CanGetProperty(DescType propertyCode);
00116 
00117 
00118        void                               SetDocumentProperties(DocumentReference document, AEDesc *propertyRecord);
00119 
00120        DocumentReference           GetDocumentReferenceFromToken(const AEDesc *token);            // these can all throw
00121        DocumentReference           GetDocumentByName(ConstStr255Param docName);
00122        DocumentReference           GetDocumentByIndex(long index);
00123        DocumentReference           GetDocumentByID(long docID);
00124        
00125        DocumentReference           GetNextDocument(DocumentReference docRef);
00126        DocumentReference           GetPreviousDocument(DocumentReference docRef);
00127 
00128 public:
00129        static long                        CountDocuments();
00130 
00131 };
00132 
00133 
00134 long          GetDocumentID(DocumentReference docRef);
00135 long          GetDocumentIndex(DocumentReference docRef);
00136 void          GetDocumentName(DocumentReference docRef, Str63 docName);
00137 Boolean       DocumentIsModified(DocumentReference docRef);
00138 
00139 
00140 #endif /* __AEDOCUMENTCLASS__ */