forked from twitter-archive/twui
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TUIView.h
502 lines (389 loc) · 14.5 KB
/
TUIView.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/*
Copyright 2011 Twitter, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this work except in compliance with the License.
You may obtain a copy of the License in the LICENSE file, or at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#import "TUIResponder.h"
#import "TUIAccessibility.h"
extern NSString * const TUIViewWillMoveToWindowNotification; // both notification's userInfo will contain the new window under the key TUIViewWindow
extern NSString * const TUIViewDidMoveToWindowNotification;
extern NSString * const TUIViewWindow;
extern NSString * const TUIViewFrameDidChangeNotification;
enum {
TUIViewAutoresizingNone = 0,
TUIViewAutoresizingFlexibleLeftMargin = 1 << 0,
TUIViewAutoresizingFlexibleWidth = 1 << 1,
TUIViewAutoresizingFlexibleRightMargin = 1 << 2,
TUIViewAutoresizingFlexibleBottomMargin = 1 << 3,
TUIViewAutoresizingFlexibleHeight = 1 << 4,
TUIViewAutoresizingFlexibleTopMargin = 1 << 5,
};
typedef NSUInteger TUIViewAutoresizing;
#define TUIViewAutoresizingFlexibleSize (TUIViewAutoresizingFlexibleWidth | TUIViewAutoresizingFlexibleHeight)
typedef enum {
TUIViewAnimationCurveEaseInOut,
TUIViewAnimationCurveEaseIn,
TUIViewAnimationCurveEaseOut,
TUIViewAnimationCurveLinear
} TUIViewAnimationCurve;
typedef enum {
TUIViewAnimationTransitionNone,
} TUIViewAnimationTransition;
typedef enum {
TUIViewContentModeCenter,
TUIViewContentModeTop,
TUIViewContentModeBottom,
TUIViewContentModeLeft,
TUIViewContentModeRight,
TUIViewContentModeTopLeft,
TUIViewContentModeTopRight,
TUIViewContentModeBottomLeft,
TUIViewContentModeBottomRight,
TUIViewContentModeScaleToFill,
TUIViewContentModeScaleAspectFit,
TUIViewContentModeScaleAspectFill,
} TUIViewContentMode;
@class TUINSView;
@class TUINSWindow;
@class TUIView;
typedef void(^TUIViewDrawRect)(TUIView *, CGRect);
typedef CGRect(^TUIViewLayout)(TUIView *);
extern CGRect(^TUIViewCenteredLayout)(TUIView*);
@protocol TUIViewDelegate;
/**
Root view class
*/
@interface TUIView : TUIResponder
{
CALayer *_layer;
NSInteger _tag;
NSArray *_textRenderers;
__unsafe_unretained id _currentTextRenderer; // weak
CGPoint startDrag;
__unsafe_unretained id<TUIViewDelegate> _viewDelegate;
TUIViewDrawRect drawRect;
TUIViewLayout layout;
NSString *toolTip;
NSTimeInterval toolTipDelay;
@public
__unsafe_unretained TUINSView *_nsView; // keep this updated, fast way of getting .nsView
struct {
NSInteger lastWidth;
NSInteger lastHeight;
BOOL lastOpaque;
CGContextRef context;
CGRect dirtyRect;
CGFloat lastContentsScale;
} _context;
struct {
unsigned int userInteractionDisabled:1;
unsigned int moveWindowByDragging:1;
unsigned int resizeWindowByDragging:1;
unsigned int didStartMovingByDragging:1;
unsigned int didStartResizeByDragging:1;
unsigned int disableSubpixelTextRendering:1;
unsigned int pasteboardDraggingEnabled:1;
unsigned int pasteboardDraggingIsDragging:1;
unsigned int dragDistanceLock:1;
unsigned int clearsContextBeforeDrawing:1;
unsigned int drawInBackground:1;
unsigned int needsDisplayWhenWindowsKeyednessChanges:1;
unsigned int delegateMouseEntered:1;
unsigned int delegateMouseExited:1;
unsigned int delegateWillDisplayLayer:1;
} _viewFlags;
BOOL isAccessibilityElement;
NSString *accessibilityLabel;
NSString *accessibilityHint;
NSString *accessibilityValue;
TUIAccessibilityTraits accessibilityTraits;
CGRect accessibilityFrame;
NSOperationQueue *drawQueue;
}
/**
Must be a subclass of CALayer. Default is CALayer. Subclasses may override.
@returns the class of the layer to be allocated as the view backing layer.
*/
+ (Class)layerClass;
@property (nonatomic, unsafe_unretained) id<TUIViewDelegate> viewDelegate;
/**
Designated initializer
*/
- (id)initWithFrame:(CGRect)frame;
/**
Default is YES. if set to NO, user events (clicks, keys) are ignored and removed from the event queue.
*/
@property (nonatomic,getter=isUserInteractionEnabled) BOOL userInteractionEnabled;
/**
Default is 0
*/
@property (nonatomic) NSInteger tag;
/**
Will always return a non-nil value. Reciever is the layer's delegate.
@returns the reciever's backing layer.
*/
@property (nonatomic,readonly,strong) CALayer *layer;
/**
Supply a block as an alternative to overriding -layoutSubviews
*/
@property (nonatomic, copy) TUIViewLayout layout;
@property (nonatomic, assign) BOOL moveWindowByDragging;
@property (nonatomic, assign) BOOL resizeWindowByDragging;
/**
If set to NO, will disable subpixel antialiasing for text.
*/
@property (nonatomic, assign) BOOL subpixelTextRenderingEnabled; // defaults to YES
/**
Tooltip will pop up if cursor hovers a view for toolTipDelay seconds
*/
@property (nonatomic, strong) NSString *toolTip;
/**
Default is 1.5s
*/
@property (nonatomic, assign) NSTimeInterval toolTipDelay;
@property (nonatomic, assign) TUIViewContentMode contentMode;
/**
If YES, drawing will be done in a background queue. If `drawQueue` is nil, it will be performed in the DISPATCH_QUEUE_PRIORITY_DEFAULT global queue. Note that `-viewWillDisplayLayer:` will still be called on the main thread.
Defaults to NO.
*/
@property (nonatomic, assign) BOOL drawInBackground;
/**
The queue in which drawing should be performed. Only used if `drawInBackground` is YES.
Defaults to nil.
*/
@property (nonatomic, retain) NSOperationQueue *drawQueue;
/**
Make this view the first responder. Returns NO if it fails.
*/
- (BOOL)makeFirstResponder;
/**
* The window become key.
*/
- (void)windowDidBecomeKey;
/**
* The window resigned key.
*/
- (void)windowDidResignKey;
/**
* Does this view need to be redisplayed when the view's window's keyedness changes? If YES, the view will get automatically marked as needing display when the window's keyedness changes. Defaults to NO.
*/
@property (nonatomic, assign) BOOL needsDisplayWhenWindowsKeyednessChanges;
@end
@interface TUIView (TUIViewGeometry)
/**
Animatable. Do not use frame if view is transformed since it will not correctly reflect the actual location of the view. use bounds + center instead.
*/
@property (nonatomic, assign) CGRect frame;
/**
Use bounds/center and not frame if non-identity transform. if bounds dimension is odd, center may be have fractional part
Default bounds is zero origin, frame size. animatable
*/
@property (nonatomic, assign) CGRect bounds;
/**
Center is center of frame. animatable
*/
@property (nonatomic, assign) CGPoint center;
/**
Default is CGAffineTransformIdentity. animatable
*/
@property (nonatomic, assign) CGAffineTransform transform;
/**
Recursively calls -pointInside:withEvent:. point is in frame coordinates (event ignored)
*/
- (TUIView *)hitTest:(CGPoint)point withEvent:(id)event;
/**
Default returns YES if point is in bounds (event ignored)
*/
- (BOOL)pointInside:(CGPoint)point withEvent:(id)event;
- (CGPoint)convertPoint:(CGPoint)point toView:(TUIView *)view;
- (CGPoint)convertPoint:(CGPoint)point fromView:(TUIView *)view;
- (CGRect)convertRect:(CGRect)rect toView:(TUIView *)view;
- (CGRect)convertRect:(CGRect)rect fromView:(TUIView *)view;
/**
Simple resize. default is TUIViewAutoresizingNone
*/
@property (nonatomic, assign) TUIViewAutoresizing autoresizingMask;
/**
@returns 'best' size to fit given size. does not actually resize view. Default is return existing view size
*/
- (CGSize)sizeThatFits:(CGSize)size;
- (void)sizeToFit; // calls sizeThatFits: with current view bounds and changes bounds size.
- (NSArray *)sortedSubviews;
@end
@interface TUIView (TUIViewHierarchy)
@property (nonatomic, readonly) TUIView *superview;
@property (nonatomic, readonly, strong) NSArray *subviews;
/**
Recursive search, handy for debugging.
*/
@property (nonatomic, readonly) NSInteger deepNumberOfSubviews;
- (void)removeFromSuperview;
- (void)insertSubview:(TUIView *)view atIndex:(NSInteger)index;
- (void)addSubview:(TUIView *)view;
- (void)insertSubview:(TUIView *)view belowSubview:(TUIView *)siblingSubview;
- (void)insertSubview:(TUIView *)view aboveSubview:(TUIView *)siblingSubview;
- (void)bringSubviewToFront:(TUIView *)view;
- (void)sendSubviewToBack:(TUIView *)view;
- (void)didAddSubview:(TUIView *)subview;
- (void)willRemoveSubview:(TUIView *)subview;
- (void)willMoveToSuperview:(TUIView *)newSuperview;
- (void)didMoveToSuperview;
- (void)willMoveToWindow:(TUINSWindow *)newWindow;
- (void)didMoveToWindow;
/**
* Returns the closest ancestor that is shared by the receiver and another view,
* or nil if there is no such view.
*/
- (TUIView *)ancestorSharedWithView:(TUIView *)view;
/**
Note: returns YES ff view == reciever
*/
- (BOOL)isDescendantOfView:(TUIView *)view;
/**
Recursive search, includes reciever.
*/
- (TUIView *)viewWithTag:(NSInteger)tag;
/**
Includes reciever.
*/
- (TUIView *)firstSuperviewOfClass:(Class)c;
- (void)setNeedsLayout;
- (void)layoutIfNeeded;
/**
Subclasses may override to layout their subviews. Also see the ^layout property for another mechanism for this.
*/
- (void)layoutSubviews;
@end
@interface TUIView (TUIViewRendering)
/**
Supply a block as an alternative to subclassing and overriding -drawRect:
*/
@property (nonatomic, copy) TUIViewDrawRect drawRect;
/**
Forces an immediate update of the backing view's layer.contents. May be inside an animation block to cross-fade.
*/
- (void)redraw; // forces a 'contents' update immediately - will animate contents if called inside an animation block
/**
Subclasses should override to provide custom drawing. Don't override unless needed, as overriding with a blank implementation incurs overhead (backing stores are allocated and rendered).
You may also provide a block-based drawRect override with the .drawRect property.
*/
- (void)drawRect:(CGRect)rect;
/**
Marks the view as needing display, will happen before the next run loop cycle
*/
- (void)setNeedsDisplay;
- (void)setNeedsDisplayInRect:(CGRect)rect;
/**
Recursive -setNeedsDisplay
*/
- (void)setEverythingNeedsDisplay;
/**
When YES, content and subviews are clipped to the bounds of the view. Default is NO.
*/
@property (nonatomic) BOOL clipsToBounds;
/**
default is nil. Setting this with a color with <1.0 alpha will also set opaque=NO
*/
@property (nonatomic,copy) NSColor *backgroundColor;
/**
animatable. default is 1.0
*/
@property (nonatomic) CGFloat alpha;
/**
default is YES. opaque views must fill their entire bounds or the results are undefined. the active CGContext in drawRect: will not have been cleared and may have non-zeroed pixels
*/
@property (nonatomic,getter=isOpaque) BOOL opaque;
/**
default is NO. doesn't check superviews
*/
@property (nonatomic,getter=isHidden) BOOL hidden;
/**
default is YES. if set to NO, the view must fill its entire bounds, otherwise the view may contain graphical garbage.
*/
@property (nonatomic) BOOL clearsContextBeforeDrawing;
@end
@interface TUIView (TUIViewAnimation)
/**
additional context info passed to will start/did stop selectors. begin/commit can be nested
*/
+ (void)beginAnimations:(NSString *)animationID context:(void *)context;
/**
starts up any animations when the top level animation is commited
*/
+ (void)commitAnimations;
// no getters. if called outside animation block, these setters have no effect.
/**
default = nil
*/
+ (void)setAnimationDelegate:(id)delegate;
/**
default = NULL. -animationWillStart:(NSString *)animationID context:(void *)context
*/
+ (void)setAnimationWillStartSelector:(SEL)selector;
/**
default = NULL. -animationDidStop:(NSString *)animationID finished:(NSNumber *)finished context:(void *)context
*/
+ (void)setAnimationDidStopSelector:(SEL)selector;
/**
default = 0.2
*/
+ (void)setAnimationDuration:(NSTimeInterval)duration;
/**
default = 0.0
*/
+ (void)setAnimationDelay:(NSTimeInterval)delay;
+ (void)setAnimationStartDate:(NSDate *)startDate; // default = now ([NSDate date])
+ (void)setAnimationCurve:(TUIViewAnimationCurve)curve; // default = UIViewAnimationCurveEaseInOut
+ (void)setAnimationRepeatCount:(float)repeatCount; // default = 0.0. May be fractional
+ (void)setAnimationRepeatAutoreverses:(BOOL)repeatAutoreverses; // default = NO. used if repeat count is non-zero
+ (void)setAnimationBeginsFromCurrentState:(BOOL)fromCurrentState; // default = NO. If YES, the current view position is always used for new animations -- allowing animations to "pile up" on each other. Otherwise, the last end state is used for the animation (the default).
+ (void)setAnimationIsAdditive:(BOOL)additive;
+ (void)setAnimationTransition:(TUIViewAnimationTransition)transition forView:(TUIView *)view cache:(BOOL)cache; // current limitation - only one per begin/commit block
+ (void)setAnimationsEnabled:(BOOL)enabled block:(void(^)(void))block;
+ (void)setAnimationsEnabled:(BOOL)enabled; // ignore any attribute changes while set.
+ (BOOL)areAnimationsEnabled;
/**
animate the 'contents' property when set, defaults to NO
*/
+ (void)setAnimateContents:(BOOL)enabled;
+ (BOOL)willAnimateContents;
+ (void)animateWithDuration:(NSTimeInterval)duration animations:(void (^)(void))animations;
+ (void)animateWithDuration:(NSTimeInterval)duration animations:(void (^)(void))animations completion:(void (^)(BOOL finished))completion;
/**
from receiver and all subviews
*/
- (void)removeAllAnimations;
@end
@interface TUIView (TUIViewAppKit)
// TODO: deprecate this in favor of hostView or ancestorTUINSView
@property (nonatomic, assign, setter=setNSView:) TUINSView *nsView;
@property (nonatomic, readonly) TUINSWindow *nsWindow;
/**
doesn't take any transforms into effect
*/
@property (nonatomic, readonly) NSRect frameInNSView;
@property (nonatomic, readonly) NSRect frameOnScreen;
- (CGPoint)localPointForLocationInWindow:(NSPoint)locationInWindow;
- (CGPoint)localPointForEvent:(NSEvent *)event;
/**
@returns whether mouse event occured within the bounds of reciever
*/
- (BOOL)eventInside:(NSEvent *)event;
@end
@protocol TUIViewDelegate <NSObject>
@optional
- (void)view:(TUIView *)v mouseEntered:(NSEvent *)event;
- (void)view:(TUIView *)v mouseExited:(NSEvent *)event;
- (void)viewWillDisplayLayer:(TUIView *)v;
@end
#import "TUIView+Layout.h"
#import "TUIView+Private.h"
#import "TUIView+Event.h"
#import "TUIView+PasteboardDragging.h"