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 / chap20 / patron / tenant.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-05-03  |  7.8 KB  |  255 lines
  1. /*
  2.  * TENANT.H
  3.  * Patron Chapter 20
  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.     //CHAPTER20MOD
  103.     TENANTTYPE_LINKEDOBJECT,
  104.     TENANTTYPE_LINKEDFILE,
  105.     TENANTTYPE_LINKEDOBJECTFROMDATA
  106.     //End CHAPTER20MOD
  107.     } TENANTTYPE, *PTENANTTYPE;
  108.  
  109.  
  110. //State flags
  111. #define TENANTSTATE_DEFAULT      0x00000000
  112. #define TENANTSTATE_SELECTED     0x00000001
  113. #define TENANTSTATE_OPEN         0x00000002
  114. //CHAPTER20MOD
  115. #define TENANTSTATE_SHOWTYPE     0x00000004
  116. //End CHAPTER20MOD
  117.  
  118.  
  119. /*
  120.  * Persistent information we need to save for each tenant, which is
  121.  * done in the tenant list instead of with each tenant.  Since this
  122.  * is a small structure it's best not to blow another stream for it
  123.  * (overhead).
  124.  */
  125. typedef struct tagTENANTINFO
  126.     {
  127.     DWORD       dwID;
  128.     RECTL       rcl;
  129.     FORMATETC   fe;             //Excludes ptd
  130.     short       fSetExtent;     //Call IOleObject::SetExtent on Run
  131.     } TENANTINFO, *PTENANTINFO;
  132.  
  133.  
  134. class CTenant : public IUnknown
  135.     {
  136.     friend CImpIOleClientSite;
  137.     friend CImpIAdviseSink;
  138.  
  139.     private:
  140.         HWND            m_hWnd;         //Pages window
  141.         DWORD           m_dwID;         //Persistent DWORD ID
  142.         DWORD           m_cOpens;       //Count calls to Open
  143.  
  144.         BOOL            m_fInitialized; //Something here?
  145.         LPUNKNOWN       m_pObj;         //The object here
  146.         LPSTORAGE       m_pIStorage;    //Sub-storage for tenant
  147.  
  148.         FORMATETC       m_fe;           //Used to create the object
  149.         DWORD           m_dwState;      //State flags
  150.         RECTL           m_rcl;          //Space of this object
  151.         CLSID           m_clsID;        //Object class (for statics)
  152.         BOOL            m_fSetExtent;   //Call SetExtent on next run
  153.  
  154.         class CPages   *m_pPG;          //Pages window
  155.  
  156.         TENANTTYPE      m_tType;            //Type identifier
  157.         ULONG           m_cRef;             //We're an object now
  158.         LPOLEOBJECT     m_pIOleObject;      //IOleObject on m_pObj
  159.         LPVIEWOBJECT2   m_pIViewObject2;    //IViewObject2 on m_pObj
  160.         ULONG           m_grfMisc;          //OLEMISC flags
  161.         BOOL            m_fRepaintEnabled;  //No redundant paints
  162.  
  163.         //Our interfaces
  164.         PCImpIOleClientSite m_pImpIOleClientSite;
  165.         PCImpIAdviseSink    m_pImpIAdviseSink;
  166.  
  167.         //CHAPTER20MOD
  168.         LPMONIKER       m_pmkFile;  //For IOleClientSite::GetMoniker
  169.         //End CHAPTER20MOD
  170.  
  171.     //CHAPTER20MOD
  172.     /*
  173.      * This flag is used exculsively by the implementation of
  174.      * IOleUILinkContainer on the page we're in for the Links
  175.      * Dialog. Since we never use it ourselves, public here
  176.      * is no big deal.
  177.      */
  178.     public:
  179.         BOOL            m_fLinkAvail;
  180.     //End CHAPTER20MOD
  181.  
  182.     protected:
  183.         BOOL    ObjectInitialize(LPUNKNOWN, LPFORMATETC, DWORD);
  184.         HRESULT CreateStatic(LPDATAOBJECT, LPFORMATETC
  185.             , LPUNKNOWN *);
  186.  
  187.     public:
  188.         CTenant(DWORD, HWND, CPages *);
  189.         ~CTenant(void);
  190.  
  191.         //Gotta have an IUnknown for delegation
  192.         STDMETHODIMP QueryInterface(REFIID, PPVOID);
  193.         STDMETHODIMP_(ULONG) AddRef(void);
  194.         STDMETHODIMP_(ULONG) Release(void);
  195.  
  196.         DWORD       GetID(void);
  197.         UINT        GetStorageName(LPOLESTR);
  198.         void        StorageGet(LPSTORAGE *);
  199.         UINT        Create(TENANTTYPE, LPVOID, LPFORMATETC, PPOINTL
  200.                         , LPSIZEL, LPSTORAGE, PPATRONOBJECT, DWORD);
  201.         BOOL        Load(LPSTORAGE, PTENANTINFO);
  202.         void        GetInfo(PTENANTINFO);
  203.         BOOL        Open(LPSTORAGE);
  204.         void        Close(BOOL);
  205.         BOOL        Update(void);
  206.         void        Destroy(LPSTORAGE);
  207.  
  208.         void        Select(BOOL);
  209.         void        ShowAsOpen(BOOL);
  210.         void        ShowYourself(void);
  211.         void        AddVerbMenu(HMENU, UINT);
  212.         TENANTTYPE  TypeGet(void);
  213.         void        CopyEmbeddedObject(LPDATAOBJECT, LPFORMATETC
  214.                         , PPOINTL);
  215.         //CHAPTER20MOD
  216.         void        ShowObjectType(BOOL);
  217.         void        NotifyOfRename(LPTSTR, LPMONIKER);
  218.         //End CHAPTER20MOD
  219.  
  220.         BOOL        Activate(LONG);
  221.         void        Draw(HDC, DVTARGETDEVICE *, HDC, int, int
  222.                         , BOOL, BOOL);
  223.         void        Repaint(void);
  224.         void        Invalidate(void);
  225.  
  226.         void        ObjectClassFormatAndIcon(LPCLSID, LPWORD
  227.                         , LPTSTR *, HGLOBAL *, LPTSTR *);
  228.         BOOL        SwitchOrUpdateAspect(HGLOBAL, BOOL);
  229.         void        EnableRepaint(BOOL);
  230.  
  231.         //CHAPTER20MOD
  232.         BOOL        FIsSelected(void);
  233.         BOOL        ConvertToStatic(void);
  234.         //End CHAPTER20MOD
  235.  
  236.         void        ObjectGet(LPUNKNOWN *);
  237.         void        FormatEtcGet(LPFORMATETC, BOOL);
  238.         void        SizeGet(LPSIZEL, BOOL);
  239.         void        SizeSet(LPSIZEL, BOOL, BOOL);
  240.         void        RectGet(LPRECTL, BOOL);
  241.         void        RectSet(LPRECTL, BOOL, BOOL);
  242.     };
  243.  
  244.  
  245. typedef CTenant *PCTenant;
  246.  
  247. //Return codes for Create
  248. #define CREATE_FAILED               0
  249. #define CREATE_GRAPHICONLY          1
  250. #define CREATE_PLACEDOBJECT         2
  251.  
  252.  
  253.  
  254. #endif //_TENANT_H_
  255.