widget/src/windows/IEnumFE.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38
  39 #ifndef _IENUMFE_H_
  40 #define _IENUMFE_H_
  41 #include <ole2.h>
  42
  43 /*
  44  * IEnumFORMATETC object that is created from
  45  * IDataObject::EnumFormatEtc.  This object lives on its own,
  46  * that is, QueryInterface only knows IUnknown and IEnumFormatEtc,
  47  * nothing more.  We still use an outer unknown for reference
  48  * counting, because as long as this enumerator lives, the data
  49  * object should live, thereby keeping the application up.
  50  */
  51
  52 class CEnumFormatEtc;
  53 typedef class CEnumFormatEtc *LPCEnumFormatEtc;
  54
  55 class CEnumFormatEtc : public IEnumFORMATETC
  56     {
  57     private:
  58         ULONG           mRefCnt;      // Object reference count
  59         ULONG           mCurrentInx;  // Current element
  60         ULONG           mNumFEs;      // Number of FORMATETCs in us
  61         LPFORMATETC     mFEList;      // Source of FORMATETCs
  62         ULONG           mMaxNumFEs;   // Max number of us
  63
  64     public:
  65         CEnumFormatEtc(ULONG, LPFORMATETC);
  66         CEnumFormatEtc(ULONG aMaxSize);
  67         ~CEnumFormatEtc(void);
  68
  69         //IUnknown members that delegate to m_pUnkOuter.
  70         STDMETHODIMP         QueryInterface(REFIID, LPVOID*);
  71         STDMETHODIMP_(ULONG) AddRef(void);
  72         STDMETHODIMP_(ULONG) Release(void);
  73
  74         //IEnumFORMATETC members
  75         STDMETHODIMP Next(ULONG, LPFORMATETC, ULONG *);
  76         STDMETHODIMP Skip(ULONG);
  77         STDMETHODIMP Reset(void);
  78         STDMETHODIMP Clone(IEnumFORMATETC **);
  79
  80         // Extra Methods
  81         void AddFE(LPFORMATETC);
  82         bool InsertFEAt(LPFORMATETC, ULONG);
  83     };
  84
  85
  86 #endif //_IENUMFE_H_