PGDocumentController.h

/* Copyright © 2007-2008 The Sequential Project. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal with the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
1. Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimers.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimers in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of The Sequential Project nor the names of its
   contributors may be used to endorse or promote products derived from
   this Software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS WITH THE SOFTWARE. */
#import <Cocoa/Cocoa.h>

// Models
#import "PGPrefObject.h"
@class PGDocument;
@class PGResourceIdentifier;
@class PGBookmark;

// Controllers
@class PGDisplayController;
@class PGFullscreenController;
@class PGExifPanelController;
@class PGTimerPanelController;
@class PGActivityPanelController;

extern NSString *const PGAntialiasWhenUpscalingKey;
extern NSString *const PGAnimatesImagesKey;
extern NSString *const PGRoundsImageCornersKey;
extern NSString *const PGAutozoomsWindowsKey;
extern NSString *const PGOnlyAutozoomsSingleImagesKey;
extern NSString *const PGBackgroundColorKey;
extern NSString *const PGBackgroundPatternKey;
extern NSString *const PGMouseClickActionKey;
extern NSString *const PGEscapeKeyMappingKey;

enum {
	PGNextPreviousAction = 0,
	PGLeftRightAction    = 1,
	PGRightLeftAction    = 2
};
enum {
	PGFullscreenMapping = 0,
	PGQuitMapping       = 1
};

OSType PGHFSTypeCodeForPseudoFileType(NSString *type);
NSString *PGPseudoFileTypeForHFSTypeCode(OSType type); // NSFileTypeForHFSTypeCode() uses a private format that's different from what appears in our Info.plist file under CFBundleTypeOSTypes.

@interface PGDocumentController : NSResponder
{
	@private
	IBOutlet NSMenuItem              *precedingSwitchItem;
	IBOutlet NSMenuItem              *switchToPathFinder;
	IBOutlet NSMenuItem              *switchToFinder;
	IBOutlet NSMenuItem              *precedingRevealItem;
	IBOutlet NSMenuItem              *revealInPathFinder;
	IBOutlet NSMenuItem              *revealInFinder;
	IBOutlet NSMenuItem              *revealInBrowser;
	         NSCountedSet           *_runningApps;
	         BOOL                    _revealsInBrowser;

	IBOutlet NSMenu                  *recentMenu;
	         NSMenuItem             *_recentMenuSeparatorItem;

	IBOutlet NSMenuItem              *toggleFullscreen;
	IBOutlet NSMenuItem              *toggleInfo;
	IBOutlet NSMenuItem              *toggleThumbnails;

	IBOutlet NSMenuItem              *rotate90CC;
	IBOutlet NSMenuItem              *rotate270CC;
	IBOutlet NSMenuItem              *rotate180;
	IBOutlet NSMenuItem              *mirrorHorz;
	IBOutlet NSMenuItem              *mirrorVert;

	IBOutlet NSMenuItem              *fitToView;
	IBOutlet NSMenuItem              *zoomIn;

	IBOutlet NSMenuItem              *pageMenuItem;
	IBOutlet NSMenu                  *defaultPageMenu;
	IBOutlet NSMenuItem              *firstPage;
	IBOutlet NSMenuItem              *previousPage;
	IBOutlet NSMenuItem              *nextPage;
	IBOutlet NSMenuItem              *lastPage;

	IBOutlet NSMenu                  *windowsMenu;
	IBOutlet NSMenuItem              *windowsMenuSeparator;
	IBOutlet NSMenuItem              *selectPreviousDocument;
	IBOutlet NSMenuItem              *selectNextDocument;

	         BOOL                    _prefsLoaded;
	         NSArray                *_recentDocumentIdentifiers;
	         BOOL                    _fullscreen;

	         PGDocument             *_currentDocument;
	         NSMutableArray         *_documents;
	         PGFullscreenController *_fullscreenController;
	         BOOL                    _inFullscreen;

	         PGExifPanelController     *_exifPanel;
	         PGTimerPanelController    *_timerPanel;
	         PGActivityPanelController *_activityPanel;

	         NSMutableDictionary    *_classesByExtension;
}

+ (PGDocumentController *)sharedDocumentController;

- (IBAction)provideFeedback:(id)sender;
- (IBAction)showPreferences:(id)sender;

- (IBAction)closeAll:(id)sender;

- (IBAction)switchToPathFinder:(id)sender;
- (IBAction)switchToFinder:(id)sender;

- (IBAction)open:(id)sender;
- (IBAction)openURL:(id)sender;
- (IBAction)openRecentDocument:(id)sender;
- (IBAction)clearRecentDocuments:(id)sender;

- (IBAction)changeImageScalingMode:(id)sender; // PGImageScalingMode from [sender tag].
- (IBAction)changeImageScalingConstraint:(id)sender; // PGImageScalingConstraint from [sender tag].
- (IBAction)changeImageScaleFactor:(id)sender; // 2 to the power of [sender tag].

- (IBAction)changeSortOrder:(id)sender; // PGSortOrder from [sender tag].
- (IBAction)changeSortDirection:(id)sender; // PGSortDescendingMask from [sender tag].
- (IBAction)changeSortRepeat:(id)sender; // PGSortOrder from [sender tag].
- (IBAction)changeReadingDirection:(id)sender; // PGReadingDirection from [sender tag].

- (IBAction)toggleExif:(id)sender;
- (IBAction)toggleTimer:(id)sender;
- (IBAction)toggleActivity:(id)sender;
- (IBAction)selectPreviousDocument:(id)sender;
- (IBAction)selectNextDocument:(id)sender;
- (IBAction)activateDocument:(id)sender;

- (IBAction)showKeyboardShortcuts:(id)sender;

- (BOOL)performEscapeKeyAction;
- (BOOL)performToggleFullscreen;
- (BOOL)performToggleInfo;

- (NSArray *)recentDocumentIdentifiers;
- (void)setRecentDocumentIdentifiers:(NSArray *)anArray;
- (unsigned)maximumRecentDocumentCount;

- (PGDisplayController *)displayControllerForNewDocument; // Returns either the shared fullscreen controller or a new regular window controller.
- (BOOL)fullscreen;
- (void)setFullscreen:(BOOL)flag;

- (NSArray *)documents;
- (void)addDocument:(PGDocument *)document;
- (void)removeDocument:(PGDocument *)document;
- (PGDocument *)documentForResourceIdentifier:(PGResourceIdentifier *)ident;
- (PGDocument *)next:(BOOL)flag documentBeyond:(PGDocument *)document;
- (NSMenuItem *)windowsMenuItemForDocument:(PGDocument *)document;

- (NSMenu *)defaultPageMenu;
- (PGPrefObject *)currentPrefObject; // Current doc or +[PGPrefObject globalPrefObject].
- (PGDocument *)currentDocument;
- (void)setCurrentDocument:(PGDocument *)document;

- (id)openDocumentWithContentsOfURL:(NSURL *)URL display:(BOOL)display;
- (id)openDocumentWithBookmark:(PGBookmark *)aBookmark display:(BOOL)display;
- (void)noteNewRecentDocument:(PGDocument *)document;

- (void)handleAppleEvent:(NSAppleEventDescriptor *)event withReplyEvent:(NSAppleEventDescriptor *)replyEvent;

- (void)recentDocumentIdentifierDidChange:(NSNotification *)aNotif;
- (void)workspaceDidLaunchApplication:(NSNotification *)aNotif;
- (void)workspaceDidTerminateApplication:(NSNotification *)aNotif;
- (void)readingDirectionDidChange:(NSNotification *)aNotif;
- (void)showsInfoDidChange:(NSNotification *)aNotif;
- (void)showsThumbnailsDidChange:(NSNotification *)aNotif;

@end