developer/VSSDK/VisualStudioIntegration/Tools/Wizards/Templates/VC/MyToolWindow.h

   1 //
   2 // MyToolWindow.h
   3 //
   4 // This file contains the implementation of a tool window that hosts a .NET user control
   5 //
   6
   7 #pragma once
   8
   9 #include <AtlWin.h>
  10 #include <VSLWindows.h>
  11
  12 #include "..\%ProjectName%UI\Resource.h"
  13
  14 class %ProjectClass%WindowPane :
  15     public CComObjectRootEx<CComSingleThreadModel>,
  16         public VsWindowPaneFromResource<%ProjectClass%WindowPane, IDD_%ProjectClass%_DLG>,
  17         public VsWindowFrameEventSink<%ProjectClass%WindowPane>,
  18         public VSL::ISupportErrorInfoImpl<
  19                 InterfaceSupportsErrorInfoList<IVsWindowPane,
  20                 InterfaceSupportsErrorInfoList<IVsWindowFrameNotify,
  21                 InterfaceSupportsErrorInfoList<IVsWindowFrameNotify3> > > >
  22 {
  23         VSL_DECLARE_NOT_COPYABLE(%ProjectClass%WindowPane)
  24
  25 protected:
  26
  27         // Protected constructor called by CComObject<%ProjectClass%WindowPane>::CreateInstance.
  28         %ProjectClass%WindowPane() :
  29                  VsWindowPaneFromResource()
  30         {}
  31
  32         ~%ProjectClass%WindowPane() {}
  33
  34 public:
  35
  36 BEGIN_COM_MAP(%ProjectClass%WindowPane)
  37         COM_INTERFACE_ENTRY(IVsWindowPane)
  38         COM_INTERFACE_ENTRY(IVsWindowFrameNotify)
  39         COM_INTERFACE_ENTRY(IVsWindowFrameNotify3)
  40         COM_INTERFACE_ENTRY(ISupportErrorInfo)
  41 END_COM_MAP()
  42
  43 BEGIN_MSG_MAP(%ProjectClass%WindowPane)
  44         COMMAND_HANDLER(IDC_CLICKME_BTN, BN_CLICKED, OnButtonClick)
  45 END_MSG_MAP()
  46
  47         // Function called by VsVsWindowPaneFromResource at the end of SetSite; at this point the
  48         // window pane is constructed and sited and can be used, so this is where we can initialize
  49         // the event sink by siting it.
  50         void PostSited(IVsPackageEnums::SetSiteResult /*result*/)
  51         {
  52                 VsWindowFrameEventSink<%ProjectClass%WindowPane>::SetSite(GetVsSiteCache());
  53         }
  54
  55         // Callback function called by ToolWindowBase when the size of the window changes.
  56         void OnFrameSize(int x, int y, int w, int h)
  57         {
  58                 // Center button.
  59                 CWindow button(this->GetDlgItem(IDC_CLICKME_BTN));
  60                 RECT buttonRectangle;
  61                 button.GetWindowRect(&buttonRectangle);
  62
  63                 OffsetRect(&buttonRectangle, -buttonRectangle.left, -buttonRectangle.top);
  64
  65                 int iLeft = (w - buttonRectangle.right) / 2;
  66                 if (iLeft <= 0)
  67                 {
  68                         iLeft = 5;
  69                 }
  70
  71                 int iTop = (h - buttonRectangle.bottom) / 2;
  72                 if (iTop <= 0)
  73                 {
  74                         iTop = 5;
  75                 }
  76
  77                 button.SetWindowPos(NULL, iLeft, iTop, 0, 0, SWP_NOSIZE);
  78         }
  79
  80         LRESULT OnButtonClick(WORD /*wNotifyCode*/, WORD /*wID*/, HWND /*hWndCtl*/, BOOL& bHandled)
  81         {
  82                 // Load the message from the resources.
  83                 CComBSTR strMessage;
  84                 VSL_CHECKBOOL_GLE(strMessage.LoadStringW(_AtlBaseModule.GetResourceInstance(), IDS_BUTTONCLICK_MESSAGE));
  85
  86                 // Get the title of the message box (it is the same as the tool window's title).
  87                 CComBSTR strTitle;
  88                 VSL_CHECKBOOL_GLE(strTitle.LoadStringW(_AtlBaseModule.GetResourceInstance(), IDS_WINDOW_TITLE));
  89
  90                 // Get the UI Shell service.
  91                 CComPtr<IVsUIShell> spIVsUIShell = GetVsSiteCache().GetCachedService<IVsUIShell, SID_SVsUIShell>();
  92                 LONG lResult;
  93                 VSL_CHECKHRESULT(spIVsUIShell->ShowMessageBox(0, GUID_NULL, strTitle, strMessage, NULL, 0, OLEMSGBUTTON_OK, OLEMSGDEFBUTTON_FIRST, OLEMSGICON_INFO, FALSE, &lResult));
  94
  95                 bHandled = TRUE;
  96                 return 0;
  97         }
  98 };
  99
 100
 101 class %ProjectClass%ToolWindow :
 102         public VSL::ToolWindowBase<%ProjectClass%ToolWindow>
 103 {
 104 public:
 105         // Constructor of the tool window object.
 106         // The goal of this constructor is to initialize the base class with the site cache
 107         // of the owner package.
 108         %ProjectClass%ToolWindow(const PackageVsSiteCache& rPackageVsSiteCache):
 109                 ToolWindowBase(rPackageVsSiteCache)
 110         {
 111         }
 112
 113         // Caption of the tool window.
 114         const wchar_t* const GetCaption() const
 115         {
 116                 static CStringW strCaption;
 117                 // Avoid to load the string from the resources more that once.
 118                 if (0 == strCaption.GetLength())
 119                 {
 120                         VSL_CHECKBOOL_GLE(
 121                                 strCaption.LoadStringW(_AtlBaseModule.GetResourceInstance(), IDS_WINDOW_TITLE));
 122                 }
 123                 return strCaption;
 124         }
 125
 126         // Creation flags for this tool window.
 127         VSCREATETOOLWIN GetCreationFlags() const
 128         {
 129                 return CTW_fInitNew|CTW_fForceCreate;
 130         }
 131
 132         // Return the GUID of the persintence slot for this tool window.
 133         const GUID& GetToolWindowGuid() const
 134         {
 135                 return CLSID_guidPersistanceSlot;
 136         }
 137
 138         IUnknown* GetViewObject()
 139         {
 140                 // Should only be called once per-instance
 141                 VSL_CHECKBOOLEAN_EX(m_spView == NULL, E_UNEXPECTED, IDS_E_GETVIEWOBJECT_CALLED_AGAIN);
 142
 143                 // Create the object that implements the window pane for this tool window.
 144                 CComObject<%ProjectClass%WindowPane>* pViewObject;
 145                 VSL_CHECKHRESULT(CComObject<%ProjectClass%WindowPane>::CreateInstance(&pViewObject));
 146
 147                 // Get the pointer to IUnknown for the window pane.
 148                 HRESULT hr = pViewObject->QueryInterface(IID_IUnknown, (void**)&m_spView);
 149                 if (FAILED(hr))
 150                 {
 151                         // If QueryInterface failed, then there is something wrong with the object.
 152                         // Delete it and throw an exception for the error.
 153                         delete pViewObject;
 154                         VSL_CHECKHRESULT(hr);
 155                 }
 156
 157                 return m_spView;
 158         }
 159
 160         // This method is called by the base class after the tool window is created.
 161         // We use it to set the icon for this window.
 162         void PostCreate()
 163         {
 164                 CComVariant srpvt;
 165                 srpvt.vt = VT_I4;
 166                 srpvt.intVal = IDB_FRAME_IMAGES;
 167                 // We don't want to make the window creation fail only becuase we can not set
 168                 // the icon, so we will not throw if SetProperty fails.
 169                 if (SUCCEEDED(GetIVsWindowFrame()->SetProperty(VSFPROPID_BitmapResource, srpvt)))
 170                 {
 171                         srpvt.intVal = 1;
 172                         GetIVsWindowFrame()->SetProperty(VSFPROPID_BitmapIndex, srpvt);
 173                 }
 174         }
 175
 176 private:
 177         CComPtr<IUnknown> m_spView;
 178 };