ITWindowEffect.h

   1 /*
   2  *      ITKit
   3  *  ITWindowEffect
   4  *    Protocal and abstract superclass for performing effects on windows.
   5  *
   6  *  Original Author : Matthew Judy <mjudy@ithinksw.com>
   7  *   Responsibility : Matthew Judy <mjudy@ithinksw.com>
   8  *
   9  *  Copyright (c) 2002 - 2003 iThink Software.
  10  *  All Rights Reserved
  11  *
  12  */
  13
  14
  15 #import <Cocoa/Cocoa.h>
  16 #import "ITWindowPositioning.h"
  17
  18 @class ITTransientStatusWindow;
  19
  20 #define EFFECT_FPS 30.0
  21 #define DEFAULT_EFFECT_TIME 0.75
  22
  23
  24 typedef enum {
  25     ITWindowHiddenState,
  26     ITWindowAppearingState,
  27     ITWindowVisibleState,
  28     ITWindowVanishingState
  29 } ITWindowVisibilityState;
  30
  31
  32 @protocol ITWindowEffect
  33 + (NSString *)effectName;
  34 + (NSDictionary *)supportedPositions;
  35 + (unsigned int)listOrder;
  36 - (void)performAppear;
  37 - (void)performVanish;
  38 - (void)cancelAppear;
  39 - (void)cancelVanish;
  40 @end
  41
  42
  43 @protocol ITWindowMotility
  44 - (ITWindowVisibilityState)visibilityState;
  45 - (void)setVisibilityState:(ITWindowVisibilityState)newState;
  46 - (float)effectProgress;
  47 - (void)setEffectProgress:(float)newProgress;
  48 @end
  49
  50
  51 @interface ITWindowEffect : NSObject <ITWindowEffect>
  52 {
  53     ITTransientStatusWindow    *_window;
  54     float                       _effectTime;
  55     float                       _effectSpeed;
  56     ITVerticalWindowPosition    _verticalPosition;
  57     ITHorizontalWindowPosition  _horizontalPosition;
  58     NSTimer                    *_effectTimer;
  59     BOOL                                           __idle;
  60     BOOL                       __shouldReleaseWhenIdle;
  61 }
  62
  63 + (NSArray *)effectClasses;
  64
  65 // Designated initializer
  66 - (id)initWithWindow:(NSWindow *)window;
  67
  68 - (NSWindow *)window;
  69
  70 - (void)setWindow:(NSWindow *)newWindow;
  71
  72 - (void)setWindowVisibility:(ITWindowVisibilityState)visibilityState;
  73
  74 - (float)effectTime;
  75 - (void)setEffectTime:(float)newTime;
  76
  77 - (void)releaseWhenIdle;
  78
  79 @end