src/Utils/MiscUI/WaitCursorEx.h

   1 // TortoiseSVN - a Windows shell extension for easy version control\r
   2 \r
   3 // Copyright (C) 2003-2006 - Stefan Kueng\r
   4 \r
   5 // This program is free software; you can redistribute it and/or\r
   6 // modify it under the terms of the GNU General Public License\r
   7 // as published by the Free Software Foundation; either version 2\r
   8 // of the License, or (at your option) any later version.\r
   9 \r
  10 // This program is distributed in the hope that it will be useful,\r
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 // GNU General Public License for more details.\r
  14 \r
  15 // You should have received a copy of the GNU General Public License\r
  16 // along with this program; if not, write to the Free Software Foundation,\r
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\r
  18 //\r
  19 #ifndef __WaitCursorEx_h\r
  20 #define __WaitCursorEx_h\r
  21 \r
  22 #pragma once\r
  23 \r
  24 /**\r
  25  * \ingroup Utils\r
  26  * Guard class for the system's wait cursor. Works very much like the CWaitCursor\r
  27  * class from MFC, but has additional functions to show or hide the wait cursor\r
  28  * when needed.\r
  29  * \r
  30  * Simply instantiate an object of this class to make the wait cursor visible.\r
  31  * When the objects gets destructed for any reason, the wait cursor is automatically\r
  32  * hidden.\r
  33  */\r
  34 class CWaitCursorEx\r
  35 {\r
  36 public:\r
  37         CWaitCursorEx(bool start_visible = true);\r
  38         ~CWaitCursorEx();\r
  39 \r
  40         void Show();    //!< Show the hourglass cursor if not already visible\r
  41         void Hide();    //!< Hide the hourglass cursor if not already hidden\r
  42 \r
  43 private:\r
  44         bool m_bVisible;\r
  45 };\r
  46 \r
  47 #endif /*__WaitCursorEx_h*/\r