// TortoiseSVN - a Windows shell extension for easy version control

// Copyright (C) 2003-2006, 2021 - TortoiseSVN

// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
#pragma once

/**
 * \ingroup Utils
 * Guard class for the system's wait cursor. Works very much like the CWaitCursor
 * class from MFC, but has additional functions to show or hide the wait cursor
 * when needed.
 *
 * Simply instantiate an object of this class to make the wait cursor visible.
 * When the objects gets destructed for any reason, the wait cursor is automatically
 * hidden.
 */
class CWaitCursorEx
{
public:
    CWaitCursorEx(bool startVisible = true);
    ~CWaitCursorEx();

    void Show(); //!< Show the hourglass cursor if not already visible
    void Hide(); //!< Hide the hourglass cursor if not already hidden

private:
    bool m_bVisible;
};