home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / inole2 / chap21 / patron / tenant.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-05-03  |  7.8 KB  |  250 lines
  1. /*
  2.  * TENANT.H
  3.  * Patron Chapter 21
  4.  *
  5.  * Definitions and function prototypes for the CTenant class
  6.  *
  7.  * Copyright (c)1993-1995 Microsoft Corporation, All Rights Reserved
  8.  *
  9.  * Kraig Brockschmidt, Microsoft
  10.  * Internet  :  kraigb@microsoft.com
  11.  * Compuserve:  >INTERNET:kraigb@microsoft.com
  12.  */
  13.  
  14.  
  15. #ifndef _TENANT_H_
  16. #define _TENANT_H_
  17.  
  18.  
  19. class CImpIOleClientSite : public IOleClientSite
  20.     {
  21.     protected:
  22.         ULONG               m_cRef;
  23.         class CTenant      *m_pTen;
  24.         LPUNKNOWN           m_pUnkOuter;
  25.  
  26.     public:
  27.         CImpIOleClientSite(class CTenant *, LPUNKNOWN);
  28.         ~CImpIOleClientSite(void);
  29.  
  30.         STDMETHODIMP QueryInterface(REFIID, PPVOID);
  31.         STDMETHODIMP_(ULONG) AddRef(void);
  32.         STDMETHODIMP_(ULONG) Release(void);
  33.  
  34.         STDMETHODIMP SaveObject(void);
  35.         STDMETHODIMP GetMoniker(DWORD, DWORD, LPMONIKER *);
  36.         STDMETHODIMP GetContainer(LPOLECONTAINER *);
  37.         STDMETHODIMP ShowObject(void);
  38.         STDMETHODIMP OnShowWindow(BOOL);
  39.         STDMETHODIMP RequestNewObjectLayout(void);
  40.     };
  41.  
  42. typedef CImpIOleClientSite *PCImpIOleClientSite;
  43.  
  44.  
  45.  
  46. class CImpIAdviseSink : public IAdviseSink
  47.     {
  48.     protected:
  49.         ULONG               m_cRef;
  50.         class CTenant      *m_pTen;
  51.         LPUNKNOWN           m_pUnkOuter;
  52.  
  53.     public:
  54.         CImpIAdviseSink(class CTenant *, LPUNKNOWN);
  55.         ~CImpIAdviseSink(void);
  56.  
  57.         STDMETHODIMP QueryInterface(REFIID, PPVOID);
  58.         STDMETHODIMP_(ULONG) AddRef(void);
  59.         STDMETHODIMP_(ULONG) Release(void);
  60.  
  61.         STDMETHODIMP_(void)  OnDataChange(LPFORMATETC, LPSTGMEDIUM);
  62.         STDMETHODIMP_(void)  OnViewChange(DWORD, LONG);
  63.         STDMETHODIMP_(void)  OnRename(LPMONIKER);
  64.         STDMETHODIMP_(void)  OnSave(void);
  65.         STDMETHODIMP_(void)  OnClose(void);
  66.     };
  67.  
  68.  
  69. typedef CImpIAdviseSink *PCImpIAdviseSink;
  70.  
  71.  
  72.  
  73. /*
  74.  * Tenant class describing an individual piece of data in a page.
  75.  * It knows where it sits, what object is inside of it, and what
  76.  * its idenitifer is such that it can find it's storage within a
  77.  * page.
  78.  */
  79.  
  80. //Patron Objects clipboard format
  81. typedef struct tagPATRONOBJECT
  82.     {
  83.     POINTL      ptl;        //Location of object
  84.     POINTL      ptlPick;    //Pick point from drag-drop operation
  85.     SIZEL       szl;        //Extents of object (absolute)
  86.     FORMATETC   fe;         //Actual object format
  87.     } PATRONOBJECT, *PPATRONOBJECT;
  88.  
  89.  
  90.  
  91. //Values for hit-testing, drawing, and resize-tracking tenants
  92. #define CXYHANDLE       5
  93.  
  94. //Tenant types (not persistent, but determined at load time)
  95. typedef enum
  96.     {
  97.     TENANTTYPE_NULL=0,
  98.     TENANTTYPE_STATIC,
  99.     TENANTTYPE_EMBEDDEDOBJECT,
  100.     TENANTTYPE_EMBEDDEDFILE,
  101.     TENANTTYPE_EMBEDDEDOBJECTFROMDATA,
  102.     TENANTTYPE_LINKEDOBJECT,
  103.     TENANTTYPE_LINKEDFILE,
  104.     TENANTTYPE_LINKEDOBJECTFROMDATA
  105.     } TENANTTYPE, *PTENANTTYPE;
  106.  
  107.  
  108. //State flags
  109. #define TENANTSTATE_DEFAULT      0x00000000
  110. #define TENANTSTATE_SELECTED     0x00000001
  111. #define TENANTSTATE_OPEN         0x00000002
  112. #define TENANTSTATE_SHOWTYPE     0x00000004
  113.  
  114. /*
  115.  * Persistent information we need to save for each tenant, which is
  116.  * done in the tenant list instead of with each tenant.  Since this
  117.  * is a small structure it's best not to blow another stream for it
  118.  * (overhead).
  119.  */
  120. typedef struct tagTENANTINFO
  121.     {
  122.     DWORD       dwID;
  123.     RECTL       rcl;
  124.     FORMATETC   fe;             //Excludes ptd
  125.     short       fSetExtent;     //Call IOleObject::SetExtent on Run
  126.     } TENANTINFO, *PTENANTINFO;
  127.  
  128.  
  129. class CTenant : public IUnknown
  130.     {
  131.     friend CImpIOleClientSite;
  132.     friend CImpIAdviseSink;
  133.  
  134.     private:
  135.         HWND            m_hWnd;         //Pages window
  136.         DWORD           m_dwID;         //Persistent DWORD ID
  137.         DWORD           m_cOpens;       //Count calls to Open
  138.  
  139.         BOOL            m_fInitialized; //Something here?
  140.         LPUNKNOWN       m_pObj;         //The object here
  141.         LPSTORAGE       m_pIStorage;    //Sub-storage for tenant
  142.  
  143.         FORMATETC       m_fe;           //Used to create the object
  144.         DWORD           m_dwState;      //State flags
  145.         RECTL           m_rcl;          //Space of this object
  146.         CLSID           m_clsID;        //Object class (for statics)
  147.         BOOL            m_fSetExtent;   //Call SetExtent on next run
  148.  
  149.         class CPages   *m_pPG;          //Pages window
  150.  
  151.         TENANTTYPE      m_tType;            //Type identifier
  152.         ULONG           m_cRef;             //We're an object now
  153.         LPOLEOBJECT     m_pIOleObject;      //IOleObject on m_pObj
  154.         LPVIEWOBJECT2   m_pIViewObject2;    //IViewObject2 on m_pObj
  155.         ULONG           m_grfMisc;          //OLEMISC flags
  156.         BOOL            m_fRepaintEnabled;  //No redundant paints
  157.  
  158.         //Our interfaces
  159.         PCImpIOleClientSite m_pImpIOleClientSite;
  160.         PCImpIAdviseSink    m_pImpIAdviseSink;
  161.  
  162.         //CHAPTER21MOD
  163.         LPMONIKER       m_pmk;          //Relative moniker
  164.         LPMONIKER       m_pmkFile;      //Container document moniker
  165.         //End CHAPTER21MOD
  166.  
  167.     /*
  168.      * This flag is used exculsively by the implementation of
  169.      * IOleUILinkContainer on the page we're in for the Links
  170.      * Dialog. Since we never use it ourselves, public here
  171.      * is no big deal.
  172.      */
  173.     public:
  174.         BOOL            m_fLinkAvail;
  175.  
  176.     protected:
  177.         BOOL    ObjectInitialize(LPUNKNOWN, LPFORMATETC, DWORD);
  178.         HRESULT CreateStatic(LPDATAOBJECT, LPFORMATETC
  179.             , LPUNKNOWN *);
  180.  
  181.     public:
  182.         CTenant(DWORD, HWND, CPages *);
  183.         ~CTenant(void);
  184.  
  185.         //Gotta have an IUnknown for delegation
  186.         STDMETHODIMP QueryInterface(REFIID, PPVOID);
  187.         STDMETHODIMP_(ULONG) AddRef(void);
  188.         STDMETHODIMP_(ULONG) Release(void);
  189.  
  190.         DWORD       GetID(void);
  191.         UINT        GetStorageName(LPOLESTR);
  192.         void        StorageGet(LPSTORAGE *);
  193.         UINT        Create(TENANTTYPE, LPVOID, LPFORMATETC, PPOINTL
  194.                         , LPSIZEL, LPSTORAGE, PPATRONOBJECT, DWORD);
  195.         BOOL        Load(LPSTORAGE, PTENANTINFO);
  196.         void        GetInfo(PTENANTINFO);
  197.         BOOL        Open(LPSTORAGE);
  198.         void        Close(BOOL);
  199.         BOOL        Update(void);
  200.         void        Destroy(LPSTORAGE);
  201.  
  202.         void        Select(BOOL);
  203.         void        ShowAsOpen(BOOL);
  204.         void        ShowYourself(void);
  205.         void        AddVerbMenu(HMENU, UINT);
  206.         TENANTTYPE  TypeGet(void);
  207.         void        CopyEmbeddedObject(LPDATAOBJECT, LPFORMATETC
  208.                         , PPOINTL);
  209.         void        ShowObjectType(BOOL);
  210.  
  211.         //CHAPTER21MOD
  212.         void        CopyLinkedObject(LPDATAOBJECT, LPFORMATETC
  213.                         , PPOINTL);
  214.         void        NotifyOfRename(LPTSTR, LPMONIKER, LPMONIKER);
  215.         //End CHAPTER21MOD
  216.  
  217.         BOOL        Activate(LONG);
  218.         void        Draw(HDC, DVTARGETDEVICE *, HDC, int, int
  219.                         , BOOL, BOOL);
  220.         void        Repaint(void);
  221.         void        Invalidate(void);
  222.  
  223.         void        ObjectClassFormatAndIcon(LPCLSID, LPWORD
  224.                         , LPTSTR *, HGLOBAL *, LPTSTR *);
  225.         BOOL        SwitchOrUpdateAspect(HGLOBAL, BOOL);
  226.         void        EnableRepaint(BOOL);
  227.  
  228.         BOOL        FIsSelected(void);
  229.         BOOL        ConvertToStatic(void);
  230.  
  231.         void        ObjectGet(LPUNKNOWN *);
  232.         void        FormatEtcGet(LPFORMATETC, BOOL);
  233.         void        SizeGet(LPSIZEL, BOOL);
  234.         void        SizeSet(LPSIZEL, BOOL, BOOL);
  235.         void        RectGet(LPRECTL, BOOL);
  236.         void        RectSet(LPRECTL, BOOL, BOOL);
  237.     };
  238.  
  239.  
  240. typedef CTenant *PCTenant;
  241.  
  242. //Return codes for Create
  243. #define CREATE_FAILED               0
  244. #define CREATE_GRAPHICONLY          1
  245. #define CREATE_PLACEDOBJECT         2
  246.  
  247.  
  248.  
  249. #endif //_TENANT_H_
  250.