git.sesse.net Git - vlc/blob - modules/gui/macosx/Windows.m

   1 /*****************************************************************************
   2  * Windows.m: MacOS X interface module
   3  *****************************************************************************
   4  * Copyright (C) 2012 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Felix Paul Kühne <fkuehne -at- videolan -dot- org>
   8  *          David Fuhrmann <david dot fuhrmann at googlemail dot com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #import "Windows.h"
  26 #import "intf.h"
  27 #import "CoreInteraction.h"
  28
  29 /*****************************************************************************
  30  * VLCWindow
  31  *
  32  *  Missing extension to NSWindow
  33  *****************************************************************************/
  34
  35 @implementation VLCWindow
  36 - (id)initWithContentRect:(NSRect)contentRect styleMask:(NSUInteger)styleMask
  37                   backing:(NSBackingStoreType)backingType defer:(BOOL)flag
  38 {
  39     self = [super initWithContentRect:contentRect styleMask:styleMask backing:backingType defer:flag];
  40     if (self) {
  41         /* we don't want this window to be restored on relaunch */
  42         if (!OSX_SNOW_LEOPARD)
  43             [self setRestorable:NO];
  44     }
  45     return self;
  46 }
  47
  48 - (void)setCanBecomeKeyWindow: (BOOL)canBecomeKey
  49 {
  50     b_isset_canBecomeKeyWindow = YES;
  51     b_canBecomeKeyWindow = canBecomeKey;
  52 }
  53
  54 - (BOOL)canBecomeKeyWindow
  55 {
  56     if (b_isset_canBecomeKeyWindow)
  57         return b_canBecomeKeyWindow;
  58
  59     return [super canBecomeKeyWindow];
  60 }
  61
  62 - (void)setCanBecomeMainWindow: (BOOL)canBecomeMain
  63 {
  64     b_isset_canBecomeMainWindow = YES;
  65     b_canBecomeMainWindow = canBecomeMain;
  66 }
  67
  68 - (BOOL)canBecomeMainWindow
  69 {
  70     if (b_isset_canBecomeMainWindow)
  71         return b_canBecomeMainWindow;
  72
  73     return [super canBecomeMainWindow];
  74 }
  75
  76 - (void)closeAndAnimate: (BOOL)animate
  77 {
  78     NSInvocation *invoc;
  79
  80     if (!animate) {
  81         [super close];
  82         return;
  83     }
  84
  85     invoc = [NSInvocation invocationWithMethodSignature:[super methodSignatureForSelector:@selector(close)]];
  86     [invoc setTarget: self];
  87
  88     if (![self isVisible] || [self alphaValue] == 0.0) {
  89         [super close];
  90         return;
  91     }
  92
  93     [self orderOut: self animate: YES callback: invoc];
  94 }
  95
  96 - (void)orderOut: (id)sender animate: (BOOL)animate
  97 {
  98     NSInvocation *invoc = [NSInvocation invocationWithMethodSignature:[super methodSignatureForSelector:@selector(orderOut:)]];
  99     [invoc setTarget: self];
 100     [invoc setArgument: sender atIndex: 0];
 101     [self orderOut: sender animate: animate callback: invoc];
 102 }
 103
 104 - (void)orderOut: (id)sender animate: (BOOL)animate callback:(NSInvocation *)callback
 105 {
 106     NSViewAnimation *anim;
 107     NSViewAnimation *current_anim;
 108     NSMutableDictionary *dict;
 109
 110     if (!animate) {
 111         [self orderOut: sender];
 112         return;
 113     }
 114
 115     dict = [[NSMutableDictionary alloc] initWithCapacity:2];
 116
 117     [dict setObject:self forKey:NSViewAnimationTargetKey];
 118
 119     [dict setObject:NSViewAnimationFadeOutEffect forKey:NSViewAnimationEffectKey];
 120     anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict, nil]];
 121     [dict release];
 122
 123     [anim setAnimationBlockingMode:NSAnimationNonblocking];
 124     [anim setDuration:0.9];
 125     [anim setFrameRate:30];
 126     [anim setUserInfo: callback];
 127
 128     @synchronized(self) {
 129         current_anim = self->o_current_animation;
 130
 131         if ([[[current_anim viewAnimations] objectAtIndex:0] objectForKey: NSViewAnimationEffectKey] == NSViewAnimationFadeOutEffect && [current_anim isAnimating]) {
 132             [anim release];
 133         } else {
 134             if (current_anim) {
 135                 [current_anim stopAnimation];
 136                 [anim setCurrentProgress:1.0 - [current_anim currentProgress]];
 137                 [current_anim release];
 138             }
 139             else
 140                 [anim setCurrentProgress:1.0 - [self alphaValue]];
 141             self->o_current_animation = anim;
 142             [anim startAnimation];
 143         }
 144     }
 145 }
 146
 147 - (void)orderFront: (id)sender animate: (BOOL)animate
 148 {
 149     NSViewAnimation *anim;
 150     NSViewAnimation *current_anim;
 151     NSMutableDictionary *dict;
 152
 153     if (!animate) {
 154         [super orderFront: sender];
 155         [self setAlphaValue: 1.0];
 156         return;
 157     }
 158
 159     if (![self isVisible]) {
 160         [self setAlphaValue: 0.0];
 161         [super orderFront: sender];
 162     }
 163     else if ([self alphaValue] == 1.0) {
 164         [super orderFront: self];
 165         return;
 166     }
 167
 168     dict = [[NSMutableDictionary alloc] initWithCapacity:2];
 169
 170     [dict setObject:self forKey:NSViewAnimationTargetKey];
 171
 172     [dict setObject:NSViewAnimationFadeInEffect forKey:NSViewAnimationEffectKey];
 173     anim = [[NSViewAnimation alloc] initWithViewAnimations:[NSArray arrayWithObjects:dict, nil]];
 174     [dict release];
 175
 176     [anim setAnimationBlockingMode:NSAnimationNonblocking];
 177     [anim setDuration:0.5];
 178     [anim setFrameRate:30];
 179
 180     @synchronized(self) {
 181         current_anim = self->o_current_animation;
 182
 183         if ([[[current_anim viewAnimations] objectAtIndex:0] objectForKey: NSViewAnimationEffectKey] == NSViewAnimationFadeInEffect && [current_anim isAnimating]) {
 184             [anim release];
 185         } else {
 186             if (current_anim) {
 187                 [current_anim stopAnimation];
 188                 [anim setCurrentProgress:1.0 - [current_anim currentProgress]];
 189                 [current_anim release];
 190             }
 191             else
 192                 [anim setCurrentProgress:[self alphaValue]];
 193             self->o_current_animation = anim;
 194             [self orderFront: sender];
 195             [anim startAnimation];
 196         }
 197     }
 198 }
 199
 200 - (void)animationDidEnd:(NSAnimation*)anim
 201 {
 202     if ([self alphaValue] <= 0.0) {
 203         NSInvocation * invoc;
 204         [super orderOut: nil];
 205         [self setAlphaValue: 1.0];
 206         if ((invoc = [anim userInfo]))
 207             [invoc invoke];
 208     }
 209 }
 210
 211 @end
 212
 213
 214 /*****************************************************************************
 215  * VLCVideoWindowCommon
 216  *
 217  *  Common code for main window, detached window and extra video window
 218  *****************************************************************************/
 219
 220 @implementation VLCVideoWindowCommon
 221
 222 @synthesize controlsBar=o_controls_bar;
 223
 224 #pragma mark -
 225 #pragma mark Init
 226
 227 - (id)initWithContentRect:(NSRect)contentRect styleMask:(NSUInteger)styleMask
 228                   backing:(NSBackingStoreType)backingType defer:(BOOL)flag
 229 {
 230     b_dark_interface = config_GetInt(VLCIntf, "macosx-interfacestyle");
 231
 232     if (b_dark_interface) {
 233         styleMask = NSBorderlessWindowMask;
 234 #ifdef MAC_OS_X_VERSION_10_7
 235         if (!OSX_SNOW_LEOPARD)
 236             styleMask |= NSResizableWindowMask;
 237 #endif
 238     }
 239
 240     self = [super initWithContentRect:contentRect styleMask:styleMask
 241                               backing:backingType defer:flag];
 242
 243     /* we want to be moveable regardless of our style */
 244     [self setMovableByWindowBackground: YES];
 245
 246     return self;
 247 }
 248
 249 - (void)setTitle:(NSString *)title
 250 {
 251     if (b_dark_interface && o_titlebar_view)
 252         [o_titlebar_view setWindowTitle: title];
 253
 254     [super setTitle: title];
 255 }
 256
 257 #pragma mark -
 258 #pragma mark zoom / minimize / close
 259
 260 - (BOOL)validateMenuItem:(NSMenuItem *)menuItem
 261 {
 262     SEL s_menuAction = [menuItem action];
 263
 264     if ((s_menuAction == @selector(performClose:)) || (s_menuAction == @selector(performMiniaturize:)) || (s_menuAction == @selector(performZoom:)))
 265         return YES;
 266
 267     return [super validateMenuItem:menuItem];
 268 }
 269
 270 - (BOOL)windowShouldClose:(id)sender
 271 {
 272     return YES;
 273 }
 274
 275 - (void)performClose:(id)sender
 276 {
 277     if (!([self styleMask] & NSTitledWindowMask)) {
 278         [[NSNotificationCenter defaultCenter] postNotificationName:NSWindowWillCloseNotification object:self];
 279
 280         [self orderOut: sender];
 281     } else
 282         [super performClose: sender];
 283 }
 284
 285 - (void)performMiniaturize:(id)sender
 286 {
 287     if (!([self styleMask] & NSTitledWindowMask))
 288         [self miniaturize: sender];
 289     else
 290         [super performMiniaturize: sender];
 291 }
 292
 293 - (void)performZoom:(id)sender
 294 {
 295     if (!([self styleMask] & NSTitledWindowMask))
 296         [self customZoom: sender];
 297     else
 298         [super performZoom: sender];
 299 }
 300
 301 - (void)zoom:(id)sender
 302 {
 303     if (!([self styleMask] & NSTitledWindowMask))
 304         [self customZoom: sender];
 305     else
 306         [super zoom: sender];
 307 }
 308
 309 /**
 310  * Given a proposed frame rectangle, return a modified version
 311  * which will fit inside the screen.
 312  *
 313  * This method is based upon NSWindow.m, part of the GNUstep GUI Library, licensed under LGPLv2+.
 314  *    Authors:  Scott Christley <scottc@net-community.com>, Venkat Ajjanagadde <venkat@ocbi.com>,
 315  *              Felipe A. Rodriguez <far@ix.netcom.com>, Richard Frith-Macdonald <richard@brainstorm.co.uk>
 316  *    Copyright (C) 1996 Free Software Foundation, Inc.
 317  */
 318 - (NSRect) customConstrainFrameRect: (NSRect)frameRect toScreen: (NSScreen*)screen
 319 {
 320     NSRect screenRect = [screen visibleFrame];
 321     float difference;
 322
 323     /* Move top edge of the window inside the screen */
 324     difference = NSMaxY (frameRect) - NSMaxY (screenRect);
 325     if (difference > 0) {
 326         frameRect.origin.y -= difference;
 327     }
 328
 329     /* If the window is resizable, resize it (if needed) so that the
 330      bottom edge is on the screen or can be on the screen when the user moves
 331      the window */
 332     difference = NSMaxY (screenRect) - NSMaxY (frameRect);
 333     if (_styleMask & NSResizableWindowMask) {
 334         float difference2;
 335
 336         difference2 = screenRect.origin.y - frameRect.origin.y;
 337         difference2 -= difference;
 338         // Take in account the space between the top of window and the top of the
 339         // screen which can be used to move the bottom of the window on the screen
 340         if (difference2 > 0) {
 341             frameRect.size.height -= difference2;
 342             frameRect.origin.y += difference2;
 343         }
 344
 345         /* Ensure that resizing doesn't makewindow smaller than minimum */
 346         difference2 = [self minSize].height - frameRect.size.height;
 347         if (difference2 > 0) {
 348             frameRect.size.height += difference2;
 349             frameRect.origin.y -= difference2;
 350         }
 351     }
 352
 353     return frameRect;
 354 }
 355
 356 #define DIST 3
 357
 358 /**
 359  Zooms the receiver.   This method calls the delegate method
 360  windowShouldZoom:toFrame: to determine if the window should
 361  be allowed to zoom to full screen.
 362  *
 363  * This method is based upon NSWindow.m, part of the GNUstep GUI Library, licensed under LGPLv2+.
 364  *    Authors:  Scott Christley <scottc@net-community.com>, Venkat Ajjanagadde <venkat@ocbi.com>,
 365  *              Felipe A. Rodriguez <far@ix.netcom.com>, Richard Frith-Macdonald <richard@brainstorm.co.uk>
 366  *    Copyright (C) 1996 Free Software Foundation, Inc.
 367  */
 368 - (void) customZoom: (id)sender
 369 {
 370     NSRect maxRect = [[self screen] visibleFrame];
 371     NSRect currentFrame = [self frame];
 372
 373     if ([[self delegate] respondsToSelector: @selector(windowWillUseStandardFrame:defaultFrame:)]) {
 374         maxRect = [[self delegate] windowWillUseStandardFrame: self defaultFrame: maxRect];
 375     }
 376
 377     maxRect = [self customConstrainFrameRect: maxRect toScreen: [self screen]];
 378
 379     // Compare the new frame with the current one
 380     if ((abs(NSMaxX(maxRect) - NSMaxX(currentFrame)) < DIST)
 381         && (abs(NSMaxY(maxRect) - NSMaxY(currentFrame)) < DIST)
 382         && (abs(NSMinX(maxRect) - NSMinX(currentFrame)) < DIST)
 383         && (abs(NSMinY(maxRect) - NSMinY(currentFrame)) < DIST)) {
 384         // Already in zoomed mode, reset user frame, if stored
 385         if ([self frameAutosaveName] != nil) {
 386             [self setFrame: previousSavedFrame display: YES animate: YES];
 387             [self saveFrameUsingName: [self frameAutosaveName]];
 388         }
 389         return;
 390     }
 391
 392     if ([self frameAutosaveName] != nil) {
 393         [self saveFrameUsingName: [self frameAutosaveName]];
 394         previousSavedFrame = [self frame];
 395     }
 396
 397     [self setFrame: maxRect display: YES animate: YES];
 398 }
 399
 400 #pragma mark -
 401 #pragma mark Accessibility stuff
 402
 403 - (NSArray *)accessibilityAttributeNames
 404 {
 405     if (!b_dark_interface || !o_titlebar_view)
 406         return [super accessibilityAttributeNames];
 407
 408     static NSMutableArray *attributes = nil;
 409     if (attributes == nil) {
 410         attributes = [[super accessibilityAttributeNames] mutableCopy];
 411         NSArray *appendAttributes = [NSArray arrayWithObjects: NSAccessibilitySubroleAttribute,
 412                                      NSAccessibilityCloseButtonAttribute,
 413                                      NSAccessibilityMinimizeButtonAttribute,
 414                                      NSAccessibilityZoomButtonAttribute,
 415                                      nil];
 416
 417         for(NSString *attribute in appendAttributes) {
 418             if (![attributes containsObject:attribute])
 419                 [attributes addObject:attribute];
 420         }
 421     }
 422     return attributes;
 423 }
 424
 425 - (id)accessibilityAttributeValue: (NSString*)o_attribute_name
 426 {
 427     if (b_dark_interface && o_titlebar_view) {
 428         VLCMainWindowTitleView *o_tbv = o_titlebar_view;
 429
 430         if ([o_attribute_name isEqualTo: NSAccessibilitySubroleAttribute])
 431             return NSAccessibilityStandardWindowSubrole;
 432
 433         if ([o_attribute_name isEqualTo: NSAccessibilityCloseButtonAttribute])
 434             return [[o_tbv closeButton] cell];
 435
 436         if ([o_attribute_name isEqualTo: NSAccessibilityMinimizeButtonAttribute])
 437             return [[o_tbv minimizeButton] cell];
 438
 439         if ([o_attribute_name isEqualTo: NSAccessibilityZoomButtonAttribute])
 440             return [[o_tbv zoomButton] cell];
 441     }
 442
 443     return [super accessibilityAttributeValue: o_attribute_name];
 444 }
 445
 446 @end