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 STOCLIEN.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:    6-10-96: atrent - Editor-inheritance from BALL.CPP in
  19.              the CONSERVE Tutorial Code Sample.
  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 IPAPER.H and PAPGUIDS.H for the common paper-related
  39.     Interface class, GUID, and CLSID specifications.
  40.   We include PAPFILE.H because it has the C++ class used for compound file
  41.     storage of drawing paper data.
  42.   We include GUIPAPER.H because it declares the class for the main C++
  43.     object that can service the Sink events.
  44.   We include SINK.H because it has the class COPaperSink declarations.
  45. ---------------------------------------------------------------------------*/
  46. #include <windows.h>
  47. #include <ole2.h>
  48. #include <olectl.h>
  49. #include <apputil.h>
  50. #include <ipaper.h>
  51. #include <papguids.h>
  52. #include "papfile.h"
  53. #include "guipaper.h"
  54. #include "sink.h"
  55. /*---------------------------------------------------------------------------
  56.   COPaperSink's implementation of its main COM object class including
  57.   Constructor, Destructor, QueryInterface, AddRef, and Release.
  58. ---------------------------------------------------------------------------*/
  59. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  60.   Method:   COPaperSink::COPaperSink
  61.   Summary:  COPaperSink Constructor. Note the member initializer:
  62.             "m_ImpIPaperSink(this, pUnkOuter)" which is used to pass the
  63.             'this' and pUnkOuter pointers of this constructor function to
  64.             the constructor in the instantiation of the implementation of
  65.             the CImpIPaperSink interface (which is nested inside this
  66.             present COPaperSink Object Class).
  67.   Args:     IUnknown* pUnkOuter,
  68.               Pointer to the the outer Unknown.  NULL means this COM Object
  69.               is not being Aggregated.  Non NULL means it is being created
  70.               on behalf of an outside COM object that is reusing it via
  71.               aggregation.
  72.             CGuiPaper* pGuiPaper)
  73.               Pointer to the main C++ object that can service the PaperSink
  74.               events.
  75.   Modifies: m_cRefs, m_pUnkOuter, m_pGuiPaper.
  76.   Returns:  void
  77. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  78. COPaperSink::COPaperSink(
  79.   IUnknown* pUnkOuter,
  80.   CGuiPaper* pGuiPaper) :
  81.   m_ImpIPaperSink(this, pUnkOuter)
  82. {
  83.   // Zero the COM object's reference count.
  84.   m_cRefs = 0;
  85.   // No AddRef necessary if non-NULL, as we're nested.
  86.   m_pUnkOuter = pUnkOuter;
  87.   // Assign the pointer to the Sink service C++ object.
  88.   m_pGuiPaper = pGuiPaper;
  89.   return;
  90. }
  91. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  92.   Method:   COPaperSink::~COPaperSink
  93.   Summary:  COPaperSink Destructor.
  94.   Args:     void
  95.   Returns:  void
  96. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  97. COPaperSink::~COPaperSink(void)
  98. {
  99.   return;
  100. }
  101. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  102.   Method:   COPaperSink::QueryInterface
  103.   Summary:  QueryInterface of the COPaperSink non-delegating
  104.             IUnknown implementation.
  105.   Args:     REFIID riid,
  106.               [in] GUID of the Interface being requested.
  107.             PPVOID ppv)
  108.               [out] Address of the caller's pointer variable that will
  109.               receive the requested interface pointer.
  110.   Returns:  HRESULT
  111. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  112. STDMETHODIMP COPaperSink::QueryInterface(
  113.                REFIID riid,
  114.                PPVOID ppv)
  115. {
  116.   HRESULT hr = E_NOINTERFACE;
  117.   *ppv = NULL;
  118.   if (IID_IUnknown == riid)
  119.     *ppv = this;
  120.   else if (IID_IPaperSink == riid)
  121.     *ppv = &m_ImpIPaperSink;
  122.   if (NULL != *ppv)
  123.   {
  124.     // We've handed out a pointer to the interface so obey the COM rules
  125.     // and AddRef the reference count.
  126.     ((LPUNKNOWN)*ppv)->AddRef();
  127.     hr = NOERROR;
  128.   }
  129.   return (hr);
  130. }
  131. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  132.   Method:   COPaperSink::AddRef
  133.   Summary:  AddRef of the COPaperSink non-delegating IUnknown
  134.             implementation.
  135.   Args:     void
  136.   Modifies: m_cRefs.
  137.   Returns:  ULONG
  138.               New value of m_cRefs (COM object's reference count).
  139. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  140. STDMETHODIMP_(ULONG) COPaperSink::AddRef(void)
  141. {
  142.   ULONG cRefs;
  143.   cRefs = ++m_cRefs;
  144.   return cRefs;
  145. }
  146. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  147.   Method:   COPaperSink::Release
  148.   Summary:  Release of the COPaperSink non-delegating IUnknown
  149.             implementation.
  150.   Args:     void
  151.   Modifies: m_cRefs.
  152.   Returns:  ULONG
  153.               New value of m_cRefs (COM object's reference count).
  154. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  155. STDMETHODIMP_(ULONG) COPaperSink::Release(void)
  156. {
  157.   ULONG cRefs;
  158.   cRefs = --m_cRefs;
  159.   if (0 == cRefs)
  160.   {
  161.     // We artificially bump the main ref count to prevent reentrancy
  162.     // via the main object destructor.  Not really needed in this
  163.     // COPaperSink but a good practice because we are aggregatable and
  164.     // may at some point in the future add something entertaining like
  165.     // some Releases to the COPaperSink destructor.
  166.     m_cRefs++;
  167.     delete this;
  168.   }
  169.   return cRefs;
  170. }
  171. /*---------------------------------------------------------------------------
  172.   COPaperSink's nested implementation of the IPaperSink interface
  173.   including Constructor, Destructor, QueryInterface, AddRef, Release,
  174.   Locked, Unlocked, Loaded, Saved, InkStart, InkDraw, InkStop, Erased,
  175.   and Resized. Methods in this interface are called by COM objects on
  176.   the server side to send notifications to the client.
  177. ---------------------------------------------------------------------------*/
  178. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  179.   Method:   COPaperSink::CImpIPaperSink::CImpIPaperSink
  180.   Summary:  Constructor for the CImpIPaperSink interface instantiation.
  181.   Args:     COPaperSink* pBackObj,
  182.               Back pointer to the parent outer object.
  183.             IUnknown* pUnkOuter
  184.               Pointer to the outer Unknown.  For delegation.
  185.   Modifies: m_pBackObj, m_pUnkOuter.
  186.   Returns:  void
  187. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  188. COPaperSink::CImpIPaperSink::CImpIPaperSink(
  189.   COPaperSink* pBackObj,
  190.   IUnknown* pUnkOuter)
  191. {
  192.   // Init the Back Object Pointer to point to the parent object.
  193.   m_pBackObj = pBackObj;
  194.   // Init the CImpIPaperSink interface's delegating Unknown pointer.  We
  195.   // use the Back Object pointer for IUnknown delegation here if we are
  196.   // not being aggregated.  If we are being aggregated we use the supplied
  197.   // pUnkOuter for IUnknown delegation.  In either case the pointer
  198.   // assignment requires no AddRef because the CImpIPaperSink lifetime is
  199.   // quaranteed by the lifetime of the parent object in which
  200.   // CImpIPaperSink is nested.
  201.   if (NULL == pUnkOuter)
  202.     m_pUnkOuter = pBackObj;
  203.   else
  204.     m_pUnkOuter = pUnkOuter;
  205.   return;
  206. }
  207. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  208.   Method:   COPaperSink::CImpIPaperSink::~CImpIPaperSink
  209.   Summary:  Destructor for the CImpIPaperSink interface instantiation.
  210.   Args:     void
  211.   Returns:  void
  212. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  213. COPaperSink::CImpIPaperSink::~CImpIPaperSink(void)
  214. {
  215.   return;
  216. }
  217. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  218.   Method:   COPaperSink::CImpIPaperSink::QueryInterface
  219.   Summary:  The QueryInterface IUnknown member of this IPaperSink interface
  220.             implementation that delegates to m_pUnkOuter, whatever it is.
  221.   Args:     REFIID riid,
  222.               [in] GUID of the Interface being requested.
  223.             PPVOID ppv)
  224.               [out] Address of the caller's pointer variable that will
  225.               receive the requested interface pointer.
  226.   Returns:  HRESULT
  227.               Returned by the delegated outer QueryInterface call.
  228. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  229. STDMETHODIMP COPaperSink::CImpIPaperSink::QueryInterface(
  230.                REFIID riid,
  231.                PPVOID ppv)
  232. {
  233.   // Delegate this call to the outer object's QueryInterface.
  234.   return m_pUnkOuter->QueryInterface(riid, ppv);
  235. }
  236. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  237.   Method:   COPaperSink::CImpIPaperSink::AddRef
  238.   Summary:  The AddRef IUnknown member of this IPaperSink interface
  239.             implementation that delegates to m_pUnkOuter, whatever it is.
  240.   Args:     void
  241.   Returns:  ULONG
  242.               Returned by the delegated outer AddRef call.
  243. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  244. STDMETHODIMP_(ULONG) COPaperSink::CImpIPaperSink::AddRef(void)
  245. {
  246.   // Delegate this call to the outer object's AddRef.
  247.   return m_pUnkOuter->AddRef();
  248. }
  249. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  250.   Method:   COPaperSink::CImpIPaperSink::Release
  251.   Summary:  The Release IUnknown member of this IPaperSink interface
  252.             implementation that delegates to m_pUnkOuter, whatever it is.
  253.   Args:     void
  254.   Returns:  ULONG
  255.               Returned by the delegated outer Release call.
  256. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  257. STDMETHODIMP_(ULONG) COPaperSink::CImpIPaperSink::Release(void)
  258. {
  259.   // Delegate this call to the outer object's Release.
  260.   return m_pUnkOuter->Release();
  261. }
  262. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  263.   Method:   COPaperSink::CImpIPaperSink::Locked
  264.   Summary:  The COPaper object was locked by a client.
  265.   Args:     void
  266.   Returns:  HRESULT
  267.               Standard result code. NOERROR for success.
  268. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  269. STDMETHODIMP COPaperSink::CImpIPaperSink::Locked(
  270.                void)
  271. {
  272.   HRESULT hr = E_NOTIMPL;
  273.   // For future evolution.
  274.   return hr;
  275. }
  276. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  277.   Method:   COPaperSink::CImpIPaperSink::Unlocked
  278.   Summary:  The COPaper object was Unlocked by a client.
  279.   Args:     void
  280.   Returns:  HRESULT
  281.               Standard result code. NOERROR for success.
  282. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  283. STDMETHODIMP COPaperSink::CImpIPaperSink::Unlocked(
  284.                void)
  285. {
  286.   HRESULT hr = E_NOTIMPL;
  287.   // For future evolution.
  288.   return hr;
  289. }
  290. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  291.   Method:   COPaperSink::CImpIPaperSink::Loaded
  292.   Summary:  The COPaper object's ink drawing data was loaded from a
  293.             client's compound file.
  294.   Args:     void
  295.   Returns:  HRESULT
  296.               Standard result code. NOERROR for success.
  297. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  298. STDMETHODIMP COPaperSink::CImpIPaperSink::Loaded(
  299.                void)
  300. {
  301.   HRESULT hr;
  302.   // We have been notified that a load was done. Thus, a whole new array
  303.   // of ink data must be displayed in a cleared window of this client.
  304.   m_pBackObj->m_pGuiPaper->ClearWin();
  305.   hr = m_pBackObj->m_pGuiPaper->PaintWin();
  306.   return hr;
  307. }
  308. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  309.   Method:   COPaperSink::CImpIPaperSink::Saved
  310.   Summary:  The COPaper object's drawing paper data was saved to a
  311.             client's compound file.
  312.   Args:     void
  313.   Returns:  HRESULT
  314.               Standard result code. NOERROR for success.
  315. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  316. STDMETHODIMP COPaperSink::CImpIPaperSink::Saved(
  317.                void)
  318. {
  319.   HRESULT hr = E_NOTIMPL;
  320.   // For future evolution.
  321.   return hr;
  322. }
  323. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  324.   Method:   COPaperSink::CImpIPaperSink::InkStart
  325.   Summary:  Client is being told to start a display ink drawing sequence.
  326.   Args:     SHORT nX,
  327.               X coordinate of the start point.
  328.             SHORT nY,
  329.               Y coordinate of the start point.
  330.             SHORT nWidth,
  331.               Ink Width in pixels.
  332.             COLORREF crInkColor)
  333.               RGB Ink color to be used in the subsequent inking sequence.
  334.   Returns:  HRESULT
  335.               Standard result code. NOERROR for success.
  336. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  337. STDMETHODIMP COPaperSink::CImpIPaperSink::InkStart(
  338.                                             SHORT nX,
  339.                                             SHORT nY,
  340.                                             SHORT nWidth,
  341.                                             COLORREF crInkColor)
  342. {
  343.   // Turn off ink saving to the COPaper object.
  344.   m_pBackObj->m_pGuiPaper->InkSaving(FALSE);
  345.   // Play the data back to the CGuiPaper for display only.
  346.   m_pBackObj->m_pGuiPaper->InkWidth(nWidth);
  347.   m_pBackObj->m_pGuiPaper->InkColor(crInkColor);
  348.   m_pBackObj->m_pGuiPaper->InkStart(nX, nY);
  349.   return NOERROR;
  350. }
  351. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  352.   Method:   COPaperSink::CImpIPaperSink::InkDraw
  353.   Summary:  Client is being told to draw/display ink drawing sequence data.
  354.   Args:     SHORT nX,
  355.               X coordinate of the start point.
  356.             SHORT nY,
  357.               Y coordinate of the start point.
  358.   Returns:  HRESULT
  359.               Standard result code. NOERROR for success.
  360. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  361. STDMETHODIMP COPaperSink::CImpIPaperSink::InkDraw(
  362.                                             SHORT nX,
  363.                                             SHORT nY)
  364. {
  365.   // Play the data back to the CGuiPaper for display only.
  366.   m_pBackObj->m_pGuiPaper->InkDraw(nX, nY);
  367.   return NOERROR;
  368. }
  369. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  370.   Method:   COPaperSink::CImpIPaperSink::InkStop
  371.   Summary:  Client is being told to stop an ink drawing sequence.
  372.   Args:     SHORT nX,
  373.               X coordinate of the start point.
  374.             SHORT nY,
  375.               Y coordinate of the start point.
  376.   Returns:  HRESULT
  377.               Standard result code. NOERROR for success.
  378. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  379. STDMETHODIMP COPaperSink::CImpIPaperSink::InkStop(
  380.                                             SHORT nX,
  381.                                             SHORT nY)
  382. {
  383.   // Stop the play of the data back to the CGuiPaper for display.
  384.   m_pBackObj->m_pGuiPaper->InkStop(nX, nY);
  385.   // Turn Ink Data saving back on.
  386.   m_pBackObj->m_pGuiPaper->InkSaving(TRUE);
  387.   return NOERROR;
  388. }
  389. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  390.   Method:   COPaperSink::CImpIPaperSink::Erased
  391.   Summary:  The COPaper object's drawing paper data was erased by a client.
  392.   Args:     void
  393.   Returns:  HRESULT
  394.               Standard result code. NOERROR for success.
  395. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  396. STDMETHODIMP COPaperSink::CImpIPaperSink::Erased(
  397.                void)
  398. {
  399.   HRESULT hr = E_NOTIMPL;
  400.   // For future evolution.
  401.   return hr;
  402. }
  403. /*M+M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M+++M
  404.   Method:   COPaperSink::CImpIPaperSink::Resized
  405.   Summary:  The COPaper object's drawing rectangle was resized by a client.
  406.   Args:     SHORT nWidth,
  407.               Rectangle width in pixels.
  408.             SHORT nHeight)
  409.               Rectangle height in pixels.
  410.   Returns:  HRESULT
  411.               Standard result code. NOERROR for success.
  412. M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M---M-M*/
  413. STDMETHODIMP COPaperSink::CImpIPaperSink::Resized(
  414.                SHORT nWidth,
  415.                SHORT nHeight)
  416. {
  417.   HRESULT hr = E_NOTIMPL;
  418.   // For future evolution.
  419.   return hr;
  420. }