Back to index

lightning-sunbird  0.9+nobinonly
nsAETokens.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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 __AETOKENS__
00041 #define __AETOKENS__
00042 
00043 #include "nsAEUtils.h"
00044 
00045 
00046 // ----------------------------------------------------------------------------
00047 // This is the token record used for all tokens in the CORE Suite
00048 // This uses the "kitchen sink" token metaphor: a single token is used to represent
00049 // all objects, and some fields are only appropriate for some objects.
00050 
00051 struct CoreTokenRecord
00052 {
00053        DescType                           dispatchClass;              // the class that will dispatch this class
00054        DescType                           objectClass;         // the actual class of the tokenized object
00055        DescType                           propertyCode;        // property code, or typeNull if not a property token
00056        long                               documentID;
00057        TAEListIndex                elementNumber;
00058        WindowPtr                   window;                     // only used for window objects
00059        
00060        CoreTokenRecord()
00061        :      dispatchClass(typeNull)
00062        ,      objectClass(typeNull)
00063        ,      propertyCode(typeNull)
00064        ,      documentID(0)
00065        ,      elementNumber(0)
00066        ,      window(nil)
00067        {
00068        }
00069 };
00070 
00071 
00072 typedef struct CoreTokenRecord CoreTokenRecord, *CoreTokenPtr, **CoreTokenHandle;
00073 
00074 
00075 
00076 // ConstAETokenDesc
00077 // This is a read-only wrapper for an AEDesc* that can be used
00078 // to read the contents of the token record.
00079 
00080 class ConstAETokenDesc
00081 {
00082 public:
00083                                           ConstAETokenDesc(const AEDesc* token);
00084 
00085 
00086        DescType                    GetDispatchClass() const;
00087        DescType                    GetObjectClass() const;
00088        Boolean                            UsePropertyCode() const;
00089        DescType                    GetPropertyCode() const;
00090               
00091        long                        GetDocumentID() const;
00092        WindowPtr                   GetWindowPtr() const;
00093        TAEListIndex         GetElementNumber() const;
00094 
00095 protected:
00096 
00097        CoreTokenRecord     mTokenRecord;
00098        Boolean                            mTokenWasNull;              // true if we were passed an empty AEDesc
00099 };
00100 
00101 
00102 
00103 // AETokenDesc
00104 // A read-write wrapper for an AEDesc*. Use this if you want to
00105 // update the contents of the AEDesc's data handle
00106 
00107 class AETokenDesc : public ConstAETokenDesc
00108 {
00109 public:
00110                                           AETokenDesc(AEDesc* token);
00111                                           ~AETokenDesc();
00112        
00113        void                        SetDispatchClass(DescType dispatchClass);
00114        void                        SetObjectClass(DescType objectClass);
00115        void                        SetPropertyCode(DescType propertyCode);
00116        void                        SetElementNumber(TAEListIndex number);
00117        void                        SetWindow(WindowPtr wind);
00118 
00119        void                        UpdateDesc();               // update the AEDesc wrapped by this class
00120 
00121        CoreTokenRecord&     GetTokenRecord()     { return mTokenRecord; }
00122        
00123 protected:
00124        
00125        AEDesc*                            mTokenDesc;
00126        
00127 };
00128 
00129 #endif /* __AETOKENS__ */