src/Utils/MiscUI/BaseWindow.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2007, 2010 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20 #include <string>
  21
  22
  23 /**
  24  * \ingroup Utils
  25  * Loads a string from the application resources.
  26  */
  27 class ResString
  28 {
  29     enum { MAX_RESSTRING = 1024 };
  30 public:
  31     ResString (HINSTANCE hInst, int resId);
  32     operator TCHAR const * () const { return _buf; }
  33 private:
  34     TCHAR _buf [MAX_RESSTRING + 1];
  35 };
  36
  37 /**
  38  * \ingroup Utils
  39  * A base window class.
  40  * Provides separate window message handlers for every window object based on
  41  * this class.
  42  */
  43 class CWindow
  44 {
  45 public:
  46     virtual bool RegisterWindow(UINT style, HICON hIcon, HCURSOR hCursor, HBRUSH hbrBackground,
  47         LPCTSTR lpszMenuName, LPCTSTR lpszClassName, HICON hIconSm);
  48     virtual bool RegisterWindow(CONST WNDCLASSEX* wcx);
  49
  50     /// static message handler to put in WNDCLASSEX structure
  51     static LRESULT CALLBACK stWinMsgHandler(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam);
  52
  53     /**
  54      * Sets the window title.
  55      */
  56     void SetWindowTitle(const std::wstring& sTitle)
  57     {
  58         sWindowTitle = sTitle;
  59     };
  60
  61     void SetRegistryPath(const std::wstring& sPath)
  62     {
  63         size_t slashPos = sPath.find_last_of('\\');
  64         sRegistryPath = sPath.substr(0, slashPos);
  65         sRegistryValue = sPath.substr(slashPos+1);
  66     }
  67
  68     /**
  69      * Sets the transparency of the window.
  70      * \remark note that this also sets the WS_EX_LAYERED style!
  71      */
  72     void SetTransparency(BYTE alpha, COLORREF color = 0xFF000000);
  73
  74     virtual bool Create();
  75     virtual bool Create(DWORD dwStyles, HWND hParent = NULL, RECT* rect = NULL);
  76     virtual bool CreateEx(DWORD dwExStyles, DWORD dwStyles, HWND hParent = NULL, RECT* rect = NULL);
  77
  78     //void MsgLoop();
  79     bool IsWindowClosed() const { return bWindowClosed; };
  80
  81     operator HWND() const {return m_hwnd;}
  82 protected:
  83     HINSTANCE hResource;
  84     HWND m_hwnd;
  85     bool bWindowClosed;
  86     std::wstring sClassName;
  87     std::wstring sWindowTitle;
  88     std::wstring sRegistryPath;
  89     std::wstring sRegistryValue;
  90     bool bWindowRestored;
  91
  92     //constructor
  93     CWindow(HINSTANCE hInst, CONST WNDCLASSEX* wcx = NULL) : m_hwnd(NULL)
  94         , hResource(NULL)
  95         , bWindowClosed(FALSE)
  96         , bWindowRestored(false)
  97     {
  98         hResource = hInst;
  99         if (wcx != NULL)
 100             RegisterWindow(wcx);
 101     };
 102
 103     // the real message handler
 104     virtual LRESULT CALLBACK WinMsgHandler(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam) = 0;
 105
 106     // returns a pointer the window (stored as the WindowLong)
 107     inline static CWindow * GetObjectFromWindow(HWND hWnd)
 108     {
 109         return (CWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
 110     }
 111 };
 112