src/Utils/MiscUI/WaitCursorEx.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2003-2006 - Stefan Kueng
   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 #ifndef __WaitCursorEx_h
  20 #define __WaitCursorEx_h
  21
  22 #pragma once
  23
  24 /**
  25  * \ingroup Utils
  26  * Guard class for the system's wait cursor. Works very much like the CWaitCursor
  27  * class from MFC, but has additional functions to show or hide the wait cursor
  28  * when needed.
  29  *
  30  * Simply instantiate an object of this class to make the wait cursor visible.
  31  * When the objects gets destructed for any reason, the wait cursor is automatically
  32  * hidden.
  33  */
  34 class CWaitCursorEx
  35 {
  36 public:
  37         CWaitCursorEx(bool start_visible = true);
  38         ~CWaitCursorEx();
  39
  40         void Show();    //!< Show the hourglass cursor if not already visible
  41         void Hide();    //!< Hide the hourglass cursor if not already hidden
  42
  43 private:
  44         bool m_bVisible;
  45 };
  46
  47 #endif /*__WaitCursorEx_h*/