home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / tutsamp / perclien / listsink.h < prev    next >
C/C++ Source or Header  |  1997-08-05  |  5KB  |  132 lines
  1. /*+==========================================================================
  2.   File:      LISTSINK.H
  3.  
  4.   Summary:   Include file for the COPageListSink COM object class.
  5.  
  6.              COPageListSink offers a main IUnknown standard interface and
  7.              the custom IPageListSink interface (outgoing connection
  8.              events from COPageList objects). This multiple interface COM
  9.              Object Class is achieved via the technique of nested classes.
  10.              The implementation of the IPageListSink interface is nested
  11.              inside of the COPageListSink Class.
  12.  
  13.              For a comprehensive tutorial code tour of this module's
  14.              contents and offerings see the tutorial PERCLIEN.HTM
  15.              file. For more specific technical details on the internal
  16.              workings see the comments dispersed throughout the module's
  17.              source code.
  18.  
  19.   Functions: .
  20.  
  21.   Classes:   COPageListSink.
  22.  
  23.   Origin:    5-25-97: atrent - Editor-inheritance from SINK.H in the
  24.              STOCLIEN Tutorial Code Sample. [Revised]
  25.  
  26. ----------------------------------------------------------------------------
  27.   This file is part of the Microsoft COM Tutorial Code Samples.
  28.  
  29.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  30.  
  31.   This source code is intended only as a supplement to Microsoft
  32.   Development Tools and/or on-line documentation.  See these other
  33.   materials for detailed information regarding Microsoft code samples.
  34.  
  35.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  36.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  37.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  38.   PARTICULAR PURPOSE.
  39. ==========================================================================+*/
  40.  
  41. #if !defined(LISTSINK_H)
  42. #define LISTSINK_H
  43.  
  44. #ifdef __cplusplus
  45.  
  46.  
  47. /*O+O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O+++O
  48.   ObjectClass: COPageListSink
  49.  
  50.   Summary:     The main Sink COM object class for COPageListSink COM
  51.                objects. COM objects of this class offer the IPageListSink
  52.                sink interface supporting various PageList events. The
  53.                mulitple interfaces on this COM object are constructed via
  54.                the nested interface classes technique.
  55.  
  56.   Interfaces:  IUnknown
  57.                  Standard interface providing COM object features.
  58.                IPageListSink
  59.                  Sink interface for PageList events.
  60.  
  61.   Aggregation: Yes, COPageListSink COM Objects are aggregatable by passing
  62.                a non-NULL pUnkOuter IUnknown pointer into the constructor.
  63. O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O---O-O*/
  64. class COPageListSink : public IUnknown
  65. {
  66.   public:
  67.     // Main Object Constructor & Destructor.
  68.     COPageListSink(IUnknown* pUnkOuter, CGuiList* pGuiList);
  69.     ~COPageListSink(void);
  70.  
  71.     // IUnknown methods. Main object, non-delegating.
  72.     STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  73.     STDMETHODIMP_(ULONG) AddRef(void);
  74.     STDMETHODIMP_(ULONG) Release(void);
  75.  
  76.   private:
  77.     // We declare nested class interface implementations here.
  78.  
  79.     class CImpIPageListSink : public IPageListSink
  80.     {
  81.       public:
  82.         // Interface Implementation Constructor & Destructor.
  83.         CImpIPageListSink(COPageListSink* pCO, IUnknown* pUnkOuter);
  84.         ~CImpIPageListSink(void);
  85.  
  86.         // IUnknown methods.
  87.         STDMETHODIMP         QueryInterface(REFIID, PPVOID);
  88.         STDMETHODIMP_(ULONG) AddRef(void);
  89.         STDMETHODIMP_(ULONG) Release(void);
  90.  
  91.         // IPageListSink methods.
  92.         STDMETHODIMP         Loaded(void);
  93.         STDMETHODIMP         Saved(void);
  94.         STDMETHODIMP         Cleared(void);
  95.         STDMETHODIMP         PageAdded(INT iPage);
  96.         STDMETHODIMP         PageDeleted(INT iPage);
  97.         STDMETHODIMP         PageSet(INT iPage);
  98.  
  99.       private:
  100.         // Data private to this interface implementation of IPageList.
  101.         COPageListSink*  m_pCO;          // Parent Object back pointer.
  102.         IUnknown*        m_pUnkOuter;    // Outer unknown for Delegation.
  103.     };
  104.  
  105.     // Make the otherwise private and nested IPageListSink interface
  106.     // implementation a friend to COM object instantiations of this
  107.     // COPageListSink COM object class.
  108.     friend CImpIPageListSink;
  109.  
  110.     // Private data of COPageListSink COM objects.
  111.  
  112.     // Nested IPageListSink implementation instantiation.  This
  113.     // IPageListSink interface is instantiated inside this COPageListSink
  114.     // object as a native interface.
  115.     CImpIPageListSink    m_ImpIPageListSink;
  116.  
  117.     // Main Object reference count.
  118.     ULONG                m_cRefs;
  119.  
  120.     // Outer unknown (aggregation delegation). Used when this COM object
  121.     // is being aggregated.
  122.     IUnknown*            m_pUnkOuter;
  123.  
  124.     // Pointer to the main object that can service the Sink events.
  125.     CGuiList*            m_pGuiList;
  126. };
  127.  
  128. #endif // __cplusplus
  129.  
  130.  
  131. #endif // LISTSINK_H
  132.