Back to index

lightning-sunbird  0.9+nobinonly
nsAEWordClass.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 __AEWORDCLASS__
00041 #define __AEWORDCLASS__
00042 
00043 #include "AEGenericClass.h"
00044 
00045 class AEWordClass : public AEGenericClass
00046 {
00047        friend class AECoreClass;
00048 
00049 private:
00050        typedef AEGenericClass      Inherited;
00051 
00052 public:
00053                                           AEWordClass();
00054                                           ~AEWordClass();
00055 
00056 
00057        virtual void                GetItemFromContainer(       DescType                    desiredClass,
00058                                                                              const AEDesc*        containerToken,
00059                                                                              DescType                    containerClass, 
00060                                                                              DescType                    keyForm,
00061                                                                              const AEDesc*        keyData,
00062                                                                              AEDesc*                     resultToken);
00063 
00064        virtual void                CountObjects(               DescType                    desiredType,
00065                                                                              DescType                    containerClass,
00066                                                                              const AEDesc *              container,
00067                                                                              long *               result);
00068 
00069        // ----------------------------------------------------------------------------
00070        //     Methods for creating self and container specifiers
00071        // ----------------------------------------------------------------------------
00072 
00073        virtual void                CreateSelfSpecifier(const AEDesc *token, AEDesc *outSpecifier);
00074 
00075        virtual void                GetDataFromObject(const AEDesc *token, AEDesc *desiredTypes, AEDesc *data);
00076        virtual void                SetDataForObject(const AEDesc *token, AEDesc *data);
00077 
00078        virtual Boolean                    CanSetProperty(DescType propertyCode);
00079        virtual Boolean                    CanGetProperty(DescType propertyCode);
00080 
00081 };
00082 
00083 
00084 class AEWordIterator : public AEUnnamedClassIterator
00085 {
00086 public:                                   AEWordIterator()
00087                                           : AEUnnamedClassIterator(cWord)
00088                                           {
00089                                           }
00090 
00091        virtual UInt32                     GetNumItems(const AEDesc* containerToken);
00092        virtual ItemRef                    GetIndexedItemReference(const AEDesc* containerToken, TAEListIndex itemIndex);
00093        
00094        virtual TAEListIndex        GetIndexFromItemID(const AEDesc* containerToken, ItemID itemID);
00095 
00096        virtual ItemID                     GetIndexedItemID(const AEDesc* containerToken, TAEListIndex itemIndex);
00097 
00098        // conversion routines.
00099        virtual ItemID                     GetIDFromReference(const AEDesc* containerToken, ItemRef itemRef);
00100        virtual ItemRef                    GetReferenceFromID(const AEDesc* containerToken, ItemID itemID);
00101 
00102        virtual ItemID                     GetItemIDFromToken(const AEDesc* token);
00103        virtual void                SetItemIDInCoreToken(const AEDesc* containerToken, CoreTokenRecord* tokenRecord, ItemID itemID);
00104 
00105 };
00106 
00107 
00108 #endif // __AEWORDCLASS__
00109