src/Utils/MiscUI/HintListCtrl.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2007 - 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
  21 /**
  22  * \ingroup Utils
  23  * Allows to show a hint text on a list control, basically hiding the list control
  24  * content. Can be used for example during lengthy operations (showing "please wait")
  25  * or to indicate why the list control is empty (showing "no data available").
  26  */
  27 class CHintListCtrl : public CListCtrl
  28 {
  29         DECLARE_DYNAMIC(CHintListCtrl)
  30 public:
  31         CHintListCtrl();
  32         ~CHintListCtrl();
  33
  34         void ShowText(const CString& sText, bool forceupdate = false);
  35         void ClearText();
  36         bool HasText() const {return !m_sText.IsEmpty();}
  37
  38 private:
  39         CString                 m_sText;
  40         DECLARE_MESSAGE_MAP()
  41         afx_msg void OnPaint();
  42 };