/core/externals/google-toolbox-for-mac/AppKit/GTMLargeTypeWindow.h

 1//
 2//  GTMLargeTypeWindow.h
 3//
 4//  Copyright 2008 Google Inc.
 5//
 6//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
 7//  use this file except in compliance with the License.  You may obtain a copy
 8//  of the License at
 9// 
10//  http://www.apache.org/licenses/LICENSE-2.0
11// 
12//  Unless required by applicable law or agreed to in writing, software
13//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
15//  License for the specific language governing permissions and limitations under
16//  the License.
17//
18
19#import <Cocoa/Cocoa.h>
20
21// GTMLargeTypeWindow displays a block of text in a large panel window much
22// like Address Book displays phone numbers. It will also display an image
23// so you can pop up "alerts" similar to the way BBEdit does when you attempt
24// to do a find and find nothing. It will fade in and out appropriately when
25// ordered forward or backward.
26// A typical fire-and-forget type usage would be:
27// GTMLargeTypeWindow *window
28//   = [[[GTMLargeTypeWindow alloc] initWithString:@"Foo"] autorelease];
29// [window makeKeyAndOrderFront:nil];
30
31// NB This class appears to have a problem with GC on 10.5.6 and below.
32// Radar 6137322 CIFilter crashing when run with GC enabled
33// This appears to be an Apple bug with GC.
34// We do a copy animation that causes things to crash, but only with GC
35// on. Currently I have left this enabled in GTMLargeTypeWindow pending
36// info from Apple on the bug. It's hard to reproduce, and only appears
37// at this time on our test machines. 
38// Dual-Core Intel Xeon with ATI Radeon X1300
39
40@interface GTMLargeTypeWindow : NSPanel
41
42// Setter and getter for the copy animation duration. Default value is .5s.
43// Note that this affects all windows.
44+ (NSTimeInterval)copyAnimationDuration;
45+ (void)setCopyAnimationDuration:(NSTimeInterval)duration;
46
47// Setter and getter for the fade animation duration. Default value is .3s.
48// Note that this affects all windows.
49+ (NSTimeInterval)fadeAnimationDuration;
50+ (void)setFadeAnimationDuration:(NSTimeInterval)duration;
51
52// Creates a display window with |string| displayed.
53// Formats |string| as best as possible to fill the screen.
54- (id)initWithString:(NSString *)string;
55// Creates a display window with |attrString| displayed.
56// Expects you to format it as you want it to appear.
57- (id)initWithAttributedString:(NSAttributedString *)attrString;
58// Creates a display window with |image| displayed.
59// Make sure you set the image size to what you want
60- (id)initWithImage:(NSImage*)image;
61// Creates a display window with |view| displayed.
62- (id)initWithContentView:(NSView *)view;
63
64// Copy the text out of the window if appropriate. This is normally called
65// as part of the responder chain so that the user can copy the displayed text
66// using cmd-c.
67- (void)copy:(id)sender;
68
69
70@end