Mozilla/mozilla/camino/src/browser/BrowserWindowController.h
bryner%netscape.com eeab335d51 Merging changes from CHIMERA_M1_0_1_BRANCH.
git-svn-id: svn://10.0.0.236/trunk@135978 18797224-902f-48f8-a5cc-f745e15eee43
2003-01-08 06:33:05 +00:00

341 lines
11 KiB
Objective-C

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#import <Cocoa/Cocoa.h>
#import "BrowserWrapper.h"
#import "Find.h"
#import "BookmarksToolbar.h"
#include "nsIBrowserHistory.h"
class nsIURIFixup;
class nsIBrowserHistory;
class nsIDOMEvent;
class nsIDOMNode;
//
// ThrobberHandler
//
// A helper class that handles animating the throbber when it's alive. It starts
// automatically when you init it. To get it to stop, call |stopThrobber|. Calling
// |release| is not enough because the timer used to animate the images holds a strong
// ref back to the handler so it won't go away unless you break that cycle manually with
// |stopThrobber|.
//
// This class must be separate from BrowserWindowController else the
// same thing will happen there and the timer will cause it to stay alive and continue
// loading the webpage even though the window has gone away.
//
@interface ThrobberHandler : NSObject
{
NSTimer* mTimer;
NSArray* mImages;
unsigned int mFrame;
}
// public
- (id)initWithToolbarItem:(NSToolbarItem*)inButton images:(NSArray*)inImages;
- (void)stopThrobber;
// internal
- (void)startThrobber;
- (void)pulseThrobber:(id)aSender;
@end
typedef enum
{
eNewTabEmpty,
eNewTabAboutBlank,
eNewTabHomepage
} ENewTabContents;
@class BookmarksDataSource;
@class HistoryDataSource;
@class BrowserTabView;
@class PageProxyIcon;
@class BrowserContentView;
@class BrowserTabViewItem;
@interface BrowserWindowController : NSWindowController<Find>
{
IBOutlet BrowserTabView* mTabBrowser;
IBOutlet NSDrawer* mSidebarDrawer;
IBOutlet NSTabView* mSidebarTabView;
IBOutlet NSTabView* mSidebarSourceTabView;
IBOutlet NSView* mLocationToolbarView;
IBOutlet NSTextField* mURLBar;
IBOutlet NSTextField* mStatus;
IBOutlet NSProgressIndicator* mProgress; // STRONG reference
IBOutlet NSImageView* mLock;
IBOutlet NSWindow* mLocationSheetWindow;
IBOutlet NSTextField* mLocationSheetURLField;
IBOutlet NSView* mStatusBar; // contains the status text, progress bar, and lock
IBOutlet PageProxyIcon* mProxyIcon;
IBOutlet BrowserContentView* mContentView;
IBOutlet BookmarksDataSource* mSidebarBookmarksDataSource;
IBOutlet HistoryDataSource* mHistoryDataSource;
IBOutlet BookmarksToolbar* mPersonalToolbar;
IBOutlet NSWindow* mAddBookmarkSheetWindow;
IBOutlet NSTextField* mAddBookmarkTitleField;
IBOutlet NSPopUpButton* mAddBookmarkFolderField;
IBOutlet NSButton* mAddBookmarkCheckbox;
// Context menu outlets.
IBOutlet NSMenu* mPageMenu;
IBOutlet NSMenu* mImageMenu;
IBOutlet NSMenu* mInputMenu;
IBOutlet NSMenu* mLinkMenu;
IBOutlet NSMenu* mImageLinkMenu;
IBOutlet NSMenu* mTabMenu;
// Context menu item outlets
IBOutlet NSMenuItem* mBackItem;
IBOutlet NSMenuItem* mForwardItem;
IBOutlet NSMenuItem* mCopyItem;
NSToolbarItem* mSidebarToolbarItem;
NSToolbarItem* mBookmarkToolbarItem;
BOOL mInitialized;
NSString* mPendingURL;
NSString* mPendingReferrer;
BOOL mPendingActivate;
BrowserWrapper* mBrowserView;
BOOL mMoveReentrant;
BOOL mClosingWindow;
BOOL mShouldAutosave;
BOOL mShouldLoadHomePage;
BOOL mDrawerCachedFrame;
NSRect mCachedFrameBeforeDrawerOpen; // This is used by the drawer to figure out if the window should
// be returned to its original position when the drawer closes.
NSRect mCachedFrameAfterDrawerOpen;
unsigned int mChromeMask; // Indicates which parts of the window to show (e.g., don't show toolbars)
// Context menu members.
int mContextMenuFlags;
nsIDOMEvent* mContextMenuEvent;
nsIDOMNode* mContextMenuNode;
// Cached bookmark ds used when adding through a sheet
BookmarksDataSource* mCachedBMDS;
// Throbber state variables.
ThrobberHandler* mThrobberHandler;
NSArray* mThrobberImages;
// Funky field editor for URL bar
NSTextView *mURLFieldEditor;
// cached superview for progress meter so we know where to add/remove it. This
// could be an outlet, but i figure it's easier to get it at runtime thereby saving
// someone from messing up in the nib when making changes.
NSView* mProgressSuperview; // WEAK ptr
nsIURIFixup* mURIFixer; // [STRONG] should be nsCOMPtr, but can't
nsIBrowserHistory* mGlobalHistory; // [STRONG] should be nsCOMPtr, but can't
}
- (void)dealloc;
- (id)getTabBrowser;
- (BOOL)newTabsAllowed;
- (BrowserWrapper*)getBrowserWrapper;
- (void)loadURL:(NSString*)aURLSpec referrer:(NSString*)aReferrer activate:(BOOL)activate;
- (void)updateLocationFields:(NSString *)locationString;
- (void)updateSiteIcons:(NSImage *)siteIconImage;
- (void)updateToolbarItems;
- (void)loadingStarted;
- (void)loadingDone;
- (void)focusURLBar;
// call to update the image of the lock icon with a value from nsIWebProgressListener
- (void)updateLock:(unsigned int)securityState;
- (void)performAppropriateLocationAction;
- (IBAction)goToLocationFromToolbarURLField:(id)sender;
- (void)beginLocationSheet;
- (IBAction)endLocationSheet:(id)sender;
- (IBAction)cancelLocationSheet:(id)sender;
- (IBAction)cancelAddBookmarkSheet:(id)sender;
- (IBAction)endAddBookmarkSheet:(id)sender;
- (void)cacheBookmarkDS:(BookmarksDataSource*)aDS;
- (NSSize)windowWillResize:(NSWindow *)sender toSize:(NSSize)proposedFrameSize;
- (IBAction)viewSource:(id)aSender; // focussed frame or page
- (IBAction)viewPageSource:(id)aSender; // top-level page
- (void)saveDocument:(BOOL)focusedFrame filterView:(NSView*)aFilterView;
- (void)saveURL:(NSView*)aFilterView url: (NSString*)aURLSpec suggestedFilename: (NSString*)aFilename;
- (IBAction)printDocument:(id)aSender;
- (IBAction)pageSetup:(id)aSender;
- (IBAction)performSearch:(id)aSender;
- (IBAction)sendURL:(id)aSender;
- (void)startThrobber;
- (void)stopThrobber;
- (void)clickThrobber:(id)aSender;
- (IBAction)biggerTextSize:(id)aSender;
- (IBAction)smallerTextSize:(id)aSender;
- (void)getInfo:(id)sender;
- (BOOL)canGetInfo;
- (BOOL)shouldShowBookmarkToolbar;
- (void)addBookmarkExtended: (BOOL)aIsFromMenu isFolder:(BOOL)aIsFolder URL:(NSString*)aURL title:(NSString*)aTitle;
- (IBAction)manageBookmarks: (id)aSender;
- (IBAction)manageHistory: (id)aSender;
- (void)importBookmarks: (NSString*)aURLSpec;
- (IBAction)toggleSidebar:(id)aSender;
- (BOOL)bookmarksAreVisible:(BOOL)inRequireSelection;
- (void)createNewTab:(ENewTabContents)contents;
- (IBAction)newTab:(id)sender;
- (IBAction)closeCurrentTab:(id)sender;
- (IBAction)previousTab:(id)sender;
- (IBAction)nextTab:(id)sender;
- (IBAction)closeSendersTab:(id)sender;
- (IBAction)closeOtherTabs:(id)sender;
- (IBAction)reloadSendersTab:(id)sender;
- (IBAction)moveTabToNewWindow:(id)sender;
- (IBAction)back:(id)aSender;
- (IBAction)forward:(id)aSender;
- (IBAction)reload:(id)aSender;
- (IBAction)stop:(id)aSender;
- (IBAction)home:(id)aSender;
- (IBAction)frameToNewWindow:(id)sender;
- (IBAction)frameToNewTab:(id)sender;
- (IBAction)frameToThisWindow:(id)sender;
- (void)openNewWindowWithURL: (NSString*)aURLSpec referrer:(NSString*)aReferrer loadInBackground: (BOOL)aLoadInBG;
- (void)openNewWindowWithGroup: (nsIContent*)aFolderContent loadInBackground: (BOOL)aLoadInBG;
- (void)openNewTabWithURL: (NSString*)aURLSpec referrer: (NSString*)aReferrer loadInBackground: (BOOL)aLoadInBG;
- (void)openTabGroup:(NSArray*)urlArray replaceExistingTabs:(BOOL)replaceExisting;
-(BrowserTabViewItem*)createNewTabItem;
- (void)closeBrowserWindow:(BrowserWrapper*)inBrowser;
-(void)autosaveWindowFrame;
-(void)disableAutosave;
-(void)disableLoadPage;
-(void)setChromeMask:(unsigned int)aMask;
-(unsigned int)chromeMask;
-(id)getAddBookmarkSheetWindow;
-(id)getAddBookmarkTitle;
-(id)getAddBookmarkFolder;
-(id)getAddBookmarkCheckbox;
// Called when a context menu should be shown.
- (void)onShowContextMenu:(int)flags domEvent:(nsIDOMEvent*)aEvent domNode:(nsIDOMNode*)aNode;
- (NSMenu*)getContextMenu;
// Context menu methods
- (IBAction)openLinkInNewWindow:(id)aSender;
- (IBAction)openLinkInNewTab:(id)aSender;
- (void)openLinkInNewWindowOrTab: (BOOL)aUseWindow;
- (IBAction)savePageAs:(id)aSender;
- (IBAction)saveFrameAs:(id)aSender;
- (IBAction)saveLinkAs:(id)aSender;
- (IBAction)saveImageAs:(id)aSender;
- (IBAction)viewOnlyThisImage:(id)aSender;
- (IBAction)bookmarkPage: (id)aSender;
- (IBAction)bookmarkLink: (id)aSender;
- (IBAction)copyLinkLocation:(id)aSender;
- (IBAction)copyImage:(id)sender;
- (IBAction)copyImageLocation:(id)sender;
- (BookmarksToolbar*) bookmarksToolbar;
- (NSProgressIndicator*) progressIndicator;
- (void) showProgressIndicator;
- (void) hideProgressIndicator;
- (BOOL) isResponderGeckoView:(NSResponder*) responder;
// called when the internal window focus has changed
// this allows us to dispatch activate and deactivate events as necessary
- (void) focusChangedFrom:(NSResponder*) oldResponder to:(NSResponder*) newResponder;
// Called to get cached versions of our security icons
+ (NSImage*) insecureIcon;
+ (NSImage*) secureIcon;
+ (NSImage*) brokenIcon;
// cache the toolbar defaults we parse from a plist
+ (NSArray*) toolbarDefaults;
// Accessor to get the sidebar drawer
- (NSDrawer *)sidebarDrawer;
// Accessor to get the proxy icon view
- (PageProxyIcon *)proxyIconView;
// Accessor for the bm data source
- (BookmarksDataSource*)bookmarksDataSource;
@end