pause_indicator.h

Go to the documentation of this file.

#ifndef PAUSE_INDICATOR_CLASS
#define PAUSE_INDICATOR_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : pause_indicator                                                   *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Indicates visually that a possibly slow activity is occurring and that   *
*  the user should do nothing dangerous (like zapping the app).               *
*                                                                             *
*******************************************************************************
* Copyright (c) 2003-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "winexdll.h"

#include <basis/portable.h>

class WINDOWS_EXTENSIONS_CLASS_STYLE pause_indicator
{
public:
  pause_indicator(window_handle window);
    // places the visual indicator over the "window" until this object is
    // destroyed.  other windows might change that if they're created in
    // the meantime--reassert can be used to put the pause sigil back up.

  ~pause_indicator();
    // removes the visual token for the long-winded activity.

  void reassert();
    // forces the visual indicator back in place if another window has
    // changed the state to a different one.

private:
  window_handle _win;  // where the pause indicator is associated.
  void *_watch;  // holds platform dependent info.
};

#endif

---