SINK.CPP
上传用户:bangxh
上传日期:2007-01-31
资源大小:42235k
文件大小:18k
源码类别:

Windows编程

开发平台:

Visual C++

  1. /*+==========================================================================
  2.   File:      SINK.CPP
  3.   Summary:   Implementation file for the COPaperSink COM Object Class.
  4.              Connectable object notifications are handled by COPaperSink.
  5.              COPaperSink offers a main IUnknown interface and the custom
  6.              IPaperSink interface (with the drawing Paper related event
  7.              features). This multiple interface COM Object Class is
  8.              achieved via the technique of nested classes.  The
  9.              implementation of the IPaperSink interface is nested inside
  10.              the COPaperSink Class.
  11.              For a comprehensive tutorial code tour of this module's
  12.              contents and offerings see the tutorial DCOMDRAW.HTM
  13.              file. For more specific technical details on the internal
  14.              workings see the comments dispersed throughout the module's
  15.              source code.
  16.   Classes:   COPaperSink.
  17.   Functions: none.
  18.   Origin:    8-23-97: atrent - Editor-inheritance from BALL.CPP in
  19.              the CONSERVE Tutorial Code Sample. [Revised]
  20. ----------------------------------------------------------------------------
  21.   This file is part of the Microsoft COM Tutorial Code Samples.
  22.   Copyright (C) Microsoft Corporation, 1997.  All rights reserved.
  23.   This source code is intended only as a supplement to Microsoft
  24.   Development Tools and/or on-line documentation.  See these other
  25.   materials for detailed information regarding Microsoft code samples.
  26.   THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
  27.   KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  28.   IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
  29.   PARTICULAR PURPOSE.
  30. ==========================================================================+*/
  31. /*---------------------------------------------------------------------------
  32.   We include WINDOWS.H for all Win32 applications.
  33.   We include OLE2.H because we will be calling the COM/OLE Libraries.
  34.   We include OLECTL.H because it has definitions for connectable objects.
  35.   We include APPUTIL.H because we will be building this application using
  36.     the convenient Virtual Window and Dialog classes and other
  37.     utility functions in the APPUTIL Library (ie, APPUTIL.LIB).
  38.   We include PAPINT.H and PAPGUIDS.H for the common paper-related
  39.     Interface class, GUID, and CLSID specifications.
  40.   We include GUIPAPER.H because it declares the class for the main C++
  41.     object that can service the Sink events.
  42.   We include SINK.H because it has the class COPaperSink declarations.
  43. ---------------------------------------------------------------------------*/
  44. #include <windows.h>
  45. #include <ole2.h>
  46. #include <olectl.h>
  47. #include <apputil.h>
  48. #include <papint.h>
  49. #include <papguids.h>
  50. #include "guipaper.h"
  51. #include "sink.h"
  52. /*---------------------------------------------------------------------------
  53.   COPaperSink's implementation of its main COM object class including
  54.   Constructor, Destructor, QueryInterface, AddRef, and Release.
  55. ---------------------------------------------------------------------------*/
  56. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  57.   Method:   COPaperSink::COPaperSink
  58.   Summary:  COPaperSink Constructor. Note the member initializer:
  59.             "m_ImpIPaperSink(this, pUnkOuter)" which is used to pass the
  60.             'this' and pUnkOuter pointers of this constructor function to
  61.             the constructor in the instantiation of the implementation of
  62.             the CImpIPaperSink interface (which is nested inside this
  63.             present COPaperSink Object Class).
  64.   Args:     IUnknown* pUnkOuter,
  65.               Pointer to the the outer Unknown.  NULL means this COM Object
  66.               is not being Aggregated.  Non NULL means it is being created
  67.               on behalf of an outside COM object that is reusing it via
  68.               aggregation.
  69.             CGuiPaper* pGuiPaper)
  70.               Pointer to the main C++ object that can service the PaperSink
  71.               events.
  72.   Modifies: m_cRefs, m_pUnkOuter, m_pGuiPaper.
  73.   Returns:  void
  74. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  75. COPaperSink::COPaperSink(
  76.   IUnknown* pUnkOuter,
  77.   CGuiPaper* pGuiPaper) :
  78.   m_ImpIPaperSink(this, pUnkOuter)
  79. {
  80.   // Zero the COM object's reference count.
  81.   m_cRefs = 0;
  82.   // No AddRef necessary if non-NULL, as we're nested.
  83.   m_pUnkOuter = pUnkOuter;
  84.   // Assign the pointer to the Sink service C++ object.
  85.   m_pGuiPaper = pGuiPaper;
  86.   return;
  87. }
  88. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  89.   Method:   COPaperSink::~COPaperSink
  90.   Summary:  COPaperSink Destructor.
  91.   Args:     void
  92.   Returns:  void
  93. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  94. COPaperSink::~COPaperSink(void)
  95. {
  96.   return;
  97. }
  98. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  99.   Method:   COPaperSink::QueryInterface
  100.   Summary:  QueryInterface of the COPaperSink non-delegating
  101.             IUnknown implementation.
  102.   Args:     REFIID riid,
  103.               [in] GUID of the Interface being requested.
  104.             PPVOID ppv)
  105.               [out] Address of the caller's pointer variable that will
  106.               receive the requested interface pointer.
  107.   Returns:  HRESULT
  108. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  109. STDMETHODIMP COPaperSink::QueryInterface(
  110.                REFIID riid,
  111.                PPVOID ppv)
  112. {
  113.   HRESULT hr = E_NOINTERFACE;
  114.   *ppv = NULL;
  115.   if (IID_IUnknown == riid)
  116.     *ppv = this;
  117.   else if (IID_IPaperSink == riid)
  118.     *ppv = &m_ImpIPaperSink;
  119.   if (NULL != *ppv)
  120.   {
  121.     // We've handed out a pointer to the interface so obey the COM rules
  122.     // and AddRef the reference count.
  123.     ((LPUNKNOWN)*ppv)->AddRef();
  124.     hr = NOERROR;
  125.   }
  126.   return (hr);
  127. }
  128. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  129.   Method:   COPaperSink::AddRef
  130.   Summary:  AddRef of the COPaperSink non-delegating IUnknown
  131.             implementation.
  132.   Args:     void
  133.   Modifies: m_cRefs.
  134.   Returns:  ULONG
  135.               New value of m_cRefs (COM object's reference count).
  136. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  137. STDMETHODIMP_(ULONG) COPaperSink::AddRef(void)
  138. {
  139.   ULONG cRefs;
  140.   cRefs = ++m_cRefs;
  141.   return cRefs;
  142. }
  143. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  144.   Method:   COPaperSink::Release
  145.   Summary:  Release of the COPaperSink non-delegating IUnknown
  146.             implementation.
  147.   Args:     void
  148.   Modifies: m_cRefs.
  149.   Returns:  ULONG
  150.               New value of m_cRefs (COM object's reference count).
  151. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  152. STDMETHODIMP_(ULONG) COPaperSink::Release(void)
  153. {
  154.   ULONG cRefs;
  155.   cRefs = --m_cRefs;
  156.   if (0 == cRefs)
  157.   {
  158.     // We artificially bump the main ref count to prevent reentrancy
  159.     // via the main object destructor.  Not really needed in this
  160.     // COPaperSink but a good practice because we are aggregatable and
  161.     // may at some point in the future add something entertaining like
  162.     // some Releases to the COPaperSink destructor.
  163.     m_cRefs++;
  164.     delete this;
  165.   }
  166.   return cRefs;
  167. }
  168. /*---------------------------------------------------------------------------
  169.   COPaperSink's nested implementation of the IPaperSink interface
  170.   including Constructor, Destructor, QueryInterface, AddRef, Release,
  171.   Locked, Unlocked, Loaded, Saved, InkStart, InkDraw, InkStop, Erased,
  172.   and Resized. Methods in this interface are called by COM objects on
  173.   the server side to send notifications to the client.
  174. ---------------------------------------------------------------------------*/
  175. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  176.   Method:   COPaperSink::CImpIPaperSink::CImpIPaperSink
  177.   Summary:  Constructor for the CImpIPaperSink interface instantiation.
  178.   Args:     COPaperSink* pCO,
  179.               Back pointer to the parent outer object.
  180.             IUnknown* pUnkOuter
  181.               Pointer to the outer Unknown.  For delegation.
  182.   Modifies: m_pCO, m_pUnkOuter.
  183.   Returns:  void
  184. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  185. COPaperSink::CImpIPaperSink::CImpIPaperSink(
  186.   COPaperSink* pCO,
  187.   IUnknown* pUnkOuter)
  188. {
  189.   // Init the Back Object Pointer to point to the parent object.
  190.   m_pCO = pCO;
  191.   // Init the CImpIPaperSink interface's delegating Unknown pointer.  We
  192.   // use the Back Object pointer for IUnknown delegation here if we are
  193.   // not being aggregated.  If we are being aggregated we use the supplied
  194.   // pUnkOuter for IUnknown delegation.  In either case the pointer
  195.   // assignment requires no AddRef because the CImpIPaperSink lifetime is
  196.   // quaranteed by the lifetime of the parent object in which
  197.   // CImpIPaperSink is nested.
  198.   if (NULL == pUnkOuter)
  199.     m_pUnkOuter = pCO;
  200.   else
  201.     m_pUnkOuter = pUnkOuter;
  202.   return;
  203. }
  204. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  205.   Method:   COPaperSink::CImpIPaperSink::~CImpIPaperSink
  206.   Summary:  Destructor for the CImpIPaperSink interface instantiation.
  207.   Args:     void
  208.   Returns:  void
  209. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  210. COPaperSink::CImpIPaperSink::~CImpIPaperSink(void)
  211. {
  212.   return;
  213. }
  214. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  215.   Method:   COPaperSink::CImpIPaperSink::QueryInterface
  216.   Summary:  The QueryInterface IUnknown member of this IPaperSink interface
  217.             implementation that delegates to m_pUnkOuter, whatever it is.
  218.   Args:     REFIID riid,
  219.               [in] GUID of the Interface being requested.
  220.             PPVOID ppv)
  221.               [out] Address of the caller's pointer variable that will
  222.               receive the requested interface pointer.
  223.   Returns:  HRESULT
  224.               Returned by the delegated outer QueryInterface call.
  225. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  226. STDMETHODIMP COPaperSink::CImpIPaperSink::QueryInterface(
  227.                REFIID riid,
  228.                PPVOID ppv)
  229. {
  230.   // Delegate this call to the outer object's QueryInterface.
  231.   return m_pUnkOuter->QueryInterface(riid, ppv);
  232. }
  233. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  234.   Method:   COPaperSink::CImpIPaperSink::AddRef
  235.   Summary:  The AddRef IUnknown member of this IPaperSink interface
  236.             implementation that delegates to m_pUnkOuter, whatever it is.
  237.   Args:     void
  238.   Returns:  ULONG
  239.               Returned by the delegated outer AddRef call.
  240. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  241. STDMETHODIMP_(ULONG) COPaperSink::CImpIPaperSink::AddRef(void)
  242. {
  243.   // Delegate this call to the outer object's AddRef.
  244.   return m_pUnkOuter->AddRef();
  245. }
  246. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  247.   Method:   COPaperSink::CImpIPaperSink::Release
  248.   Summary:  The Release IUnknown member of this IPaperSink interface
  249.             implementation that delegates to m_pUnkOuter, whatever it is.
  250.   Args:     void
  251.   Returns:  ULONG
  252.               Returned by the delegated outer Release call.
  253. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  254. STDMETHODIMP_(ULONG) COPaperSink::CImpIPaperSink::Release(void)
  255. {
  256.   // Delegate this call to the outer object's Release.
  257.   return m_pUnkOuter->Release();
  258. }
  259. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  260.   Method:   COPaperSink::CImpIPaperSink::Locked
  261.   Summary:  The COPaper object was locked by a client.
  262.   Args:     void
  263.   Returns:  HRESULT
  264.               Standard result code. NOERROR for success.
  265. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  266. STDMETHODIMP COPaperSink::CImpIPaperSink::Locked(
  267.                void)
  268. {
  269.   HRESULT hr = E_NOTIMPL;
  270.   // For future evolution.
  271.   return hr;
  272. }
  273. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  274.   Method:   COPaperSink::CImpIPaperSink::Unlocked
  275.   Summary:  The COPaper object was Unlocked by a client.
  276.   Args:     void
  277.   Returns:  HRESULT
  278.               Standard result code. NOERROR for success.
  279. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  280. STDMETHODIMP COPaperSink::CImpIPaperSink::Unlocked(
  281.                void)
  282. {
  283.   HRESULT hr = E_NOTIMPL;
  284.   // For future evolution.
  285.   return hr;
  286. }
  287. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  288.   Method:   COPaperSink::CImpIPaperSink::Loaded
  289.   Summary:  The COPaper object's ink drawing data was loaded from a
  290.             client's compound file.
  291.   Args:     void
  292.   Returns:  HRESULT
  293.               Standard result code. NOERROR for success.
  294. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  295. STDMETHODIMP COPaperSink::CImpIPaperSink::Loaded(
  296.                void)
  297. {
  298.   HRESULT hr;
  299.   // We have been notified that a load was done. Thus, a whole new array
  300.   // of ink data must be displayed in a cleared window of this client.
  301.   m_pCO->m_pGuiPaper->ClearWin();
  302.   hr = m_pCO->m_pGuiPaper->PaintWin();
  303.   return hr;
  304. }
  305. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  306.   Method:   COPaperSink::CImpIPaperSink::Saved
  307.   Summary:  The COPaper object's drawing paper data was saved to a
  308.             client's compound file.
  309.   Args:     void
  310.   Returns:  HRESULT
  311.               Standard result code. NOERROR for success.
  312. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  313. STDMETHODIMP COPaperSink::CImpIPaperSink::Saved(
  314.                void)
  315. {
  316.   HRESULT hr = E_NOTIMPL;
  317.   // For future evolution.
  318.   return hr;
  319. }
  320. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  321.   Method:   COPaperSink::CImpIPaperSink::InkStart
  322.   Summary:  Client is being told to start a display ink drawing sequence.
  323.   Args:     SHORT nX,
  324.               X coordinate of the start point.
  325.             SHORT nY,
  326.               Y coordinate of the start point.
  327.             SHORT nWidth,
  328.               Ink Width in pixels.
  329.             COLORREF crInkColor)
  330.               RGB Ink color to be used in the subsequent inking sequence.
  331.   Returns:  HRESULT
  332.               Standard result code. NOERROR for success.
  333. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  334. STDMETHODIMP COPaperSink::CImpIPaperSink::InkStart(
  335.                                             SHORT nX,
  336.                                             SHORT nY,
  337.                                             SHORT nWidth,
  338.                                             COLORREF crInkColor)
  339. {
  340.   // Only echo drawing action if we are not the current Master.
  341.   if (!m_pCO->m_pGuiPaper->Master())
  342.   {
  343.     // Play the data back to the CGuiPaper for display only.
  344.     m_pCO->m_pGuiPaper->InkWidth(nWidth);
  345.     m_pCO->m_pGuiPaper->InkColor(crInkColor);
  346.     m_pCO->m_pGuiPaper->InkStart(nX, nY);
  347.   }
  348.   return NOERROR;
  349. }
  350. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  351.   Method:   COPaperSink::CImpIPaperSink::InkDraw
  352.   Summary:  Client is being told to draw/display ink drawing sequence data.
  353.   Args:     SHORT nX,
  354.               X coordinate of the start point.
  355.             SHORT nY,
  356.               Y coordinate of the start point.
  357.   Returns:  HRESULT
  358.               Standard result code. NOERROR for success.
  359. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  360. STDMETHODIMP COPaperSink::CImpIPaperSink::InkDraw(
  361.                                             SHORT nX,
  362.                                             SHORT nY)
  363. {
  364.   // Only echo drawing action if we are not the current Master.
  365.   if (!m_pCO->m_pGuiPaper->Master())
  366.   {
  367.     // Play the data back to the CGuiPaper for display only.
  368.     m_pCO->m_pGuiPaper->InkDraw(nX, nY);
  369.   }
  370.   return NOERROR;
  371. }
  372. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  373.   Method:   COPaperSink::CImpIPaperSink::InkStop
  374.   Summary:  Client is being told to stop an ink drawing sequence.
  375.   Args:     SHORT nX,
  376.               X coordinate of the start point.
  377.             SHORT nY,
  378.               Y coordinate of the start point.
  379.   Returns:  HRESULT
  380.               Standard result code. NOERROR for success.
  381. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  382. STDMETHODIMP COPaperSink::CImpIPaperSink::InkStop(
  383.                                             SHORT nX,
  384.                                             SHORT nY)
  385. {
  386.   // Only echo drawing action if we are not the current Master.
  387.   if (!m_pCO->m_pGuiPaper->Master())
  388.   {
  389.     // Stop the play of the data back to the CGuiPaper for display.
  390.     m_pCO->m_pGuiPaper->InkStop(nX, nY);
  391.   }
  392.   return NOERROR;
  393. }
  394. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  395.   Method:   COPaperSink::CImpIPaperSink::Erased
  396.   Summary:  The COPaper object's drawing paper data was erased by a client.
  397.   Args:     void
  398.   Returns:  HRESULT
  399.               Standard result code. NOERROR for success.
  400. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  401. STDMETHODIMP COPaperSink::CImpIPaperSink::Erased(
  402.                void)
  403. {
  404.   HRESULT hr = E_FAIL;
  405.   // Only echo drawing action if we are not the current Master.
  406.   if (!m_pCO->m_pGuiPaper->Master())
  407.     hr = m_pCO->m_pGuiPaper->Erase();
  408.   return hr;
  409. }
  410. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  411.   Method:   COPaperSink::CImpIPaperSink::Resized
  412.   Summary:  The COPaper object's drawing rectangle was resized by a client.
  413.   Args:     LONG lWidth,
  414.               Rectangle width in pixels.
  415.             LONG lHeight)
  416.               Rectangle height in pixels.
  417.   Returns:  HRESULT
  418.               Standard result code. NOERROR for success.
  419. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  420. STDMETHODIMP COPaperSink::CImpIPaperSink::Resized(
  421.                LONG lWidth,
  422.                LONG lHeight)
  423. {
  424.   HRESULT hr = E_FAIL;
  425.   // Only echo drawing action if we are not the current Master.
  426.   if (!m_pCO->m_pGuiPaper->Master())
  427.     hr = m_pCO->m_pGuiPaper->Resize(lWidth, lHeight);
  428.   return hr;
  429. }