ITTransientStatusWindow.h

   1 /*
   2  *      ITKit
   3  *  ITTransientStatusWindow
   4  *    NSWindow subclass for quick display of status information.
   5  *    Similar to volume/brightness/eject bezel key windows.
   6  *
   7  *  Original Author : Matt Judy <mjudy@ithinksw.com>
   8  *   Responsibility : Matt Judy <mjudy@ithinksw.com>
   9  *   Responsibility : Joseph Spiros <joseph.spiros@ithinksw.com>
  10  *      Contributor : Kent Sutherland <joseph.spiros@ithinksw.com>
  11  *
  12  *  Copyright (c) 2002 - 2003 iThink Software.
  13  *  All Rights Reserved
  14  *
  15  */
  16
  17
  18 #import <Cocoa/Cocoa.h>
  19 #import "ITWindowPositioning.h"
  20 #import "ITWindowEffect.h"
  21
  22 #define DEFAULT_EXIT_DELAY  3.0
  23
  24
  25 @class ITTextField;
  26 @class ITGrayRoundedView;
  27 @class ITWindowEffect;
  28
  29
  30 typedef enum {
  31     ITTransientStatusWindowExitOnCommand,
  32     ITTransientStatusWindowExitAfterDelay,
  33 } ITTransientStatusWindowExitMode;
  34
  35
  36 typedef enum {
  37     ITTransientStatusWindowNoBackground,
  38     ITTransientStatusWindowRounded,
  39     ITTransientStatusWindowSquare,
  40     ITTransientStatusWindowMetal,
  41     ITTransientStatusWindowMetalUtility,
  42     ITTransientStatusWindowAquaUtility
  43 } ITTransientStatusWindowBackgroundType;
  44
  45
  46 @interface ITTransientStatusWindow : NSWindow <ITWindowPositioning , ITWindowMotility> {
  47
  48     ITWindowVisibilityState                _visibilityState;
  49     ITTransientStatusWindowExitMode        _exitMode;
  50     float                                  _exitDelay;
  51     ITTransientStatusWindowBackgroundType  _backgroundType;
  52     ITWindowEffect                        *_entryEffect;
  53     ITWindowEffect                        *_exitEffect;
  54     double                                 _effectProgress;
  55     ITVerticalWindowPosition               _verticalPosition;
  56     ITHorizontalWindowPosition             _horizontalPosition;
  57     float                                  _screenPadding;
  58 //    int                                    _screenNumber;
  59
  60     BOOL _reallyIgnoresEvents;
  61
  62     NSTimer *_exitTimer;
  63
  64     NSView *_contentSubView;
  65 }
  66
  67 + (id)sharedWindow;
  68
  69 - (id)initWithContentView:(NSView *)contentView
  70                  exitMode:(ITTransientStatusWindowExitMode)exitMode
  71            backgroundType:(ITTransientStatusWindowBackgroundType)backgroundType;
  72
  73 - (void)appear:(id)sender;
  74 - (void)vanish:(id)sender;
  75
  76 - (ITWindowVisibilityState)visibilityState;
  77 - (void)setVisibilityState:(ITWindowVisibilityState)newState;
  78
  79 - (ITTransientStatusWindowExitMode)exitMode;
  80 - (void)setExitMode:(ITTransientStatusWindowExitMode)newMode;
  81
  82 - (float)exitDelay;
  83 - (void)setExitDelay:(float)seconds;
  84
  85 - (ITTransientStatusWindowBackgroundType)backgroundType;
  86 - (void)setBackgroundType:(ITTransientStatusWindowBackgroundType)newType;
  87
  88 - (ITVerticalWindowPosition)verticalPosition;
  89 - (void)setVerticalPosition:(ITVerticalWindowPosition)newPosition;
  90
  91 - (ITHorizontalWindowPosition)horizontalPosition;
  92 - (void)setHorizontalPosition:(ITHorizontalWindowPosition)newPosition;
  93
  94 - (float)effectProgress;
  95 - (void)setEffectProgress:(float)newProgress;
  96
  97 - (ITWindowEffect *)entryEffect;
  98 - (void)setEntryEffect:(ITWindowEffect *)newEffect;
  99
 100 - (ITWindowEffect *)exitEffect;
 101 - (void)setExitEffect:(ITWindowEffect *)newEffect;
 102
 103
 104 @end