xap_CocoaAppController.h

Go to the documentation of this file.

/* -*- mode: C++; tab-width: 4; c-basic-offset: 4; -*- */

/* AbiSource Application Framework
 * Copyright (C) 2003 Hubert Figuiere
 * Copyright (C) 2004 Francis James Franklin
 * Copyright (C) 2009 Hubert Figuiere
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef XAP_COCOAAPPCONTROLLER_H
#define XAP_COCOAAPPCONTROLLER_H

#import <Cocoa/Cocoa.h>

#include "xap_CocoaPlugin.h"

class AV_View;
class XAP_Frame;

@class EV_CocoaMenuDelegate;

@class AP_CocoaPlugin_MenuIDRef;

@interface XAP_CocoaApplication : NSApplication
{
    //
}
- (void)terminate:(id)sender;
- (void)orderFrontStandardAboutPanel:(id)sender;
- (void)orderFrontPreferencesPanel:(id)sender;
- (void)openContextHelp:(id)sender;
- (void)sendEvent:(NSEvent *)anEvent;
@end

enum XAP_CocoaAppMenu_Id
{
    XAP_CocoaAppMenu_AbiWord = 0,
    XAP_CocoaAppMenu_File,
    XAP_CocoaAppMenu_Edit,
    XAP_CocoaAppMenu_View,
    XAP_CocoaAppMenu_Insert,
    XAP_CocoaAppMenu_Format,
    XAP_CocoaAppMenu_Tools,
    XAP_CocoaAppMenu_Table,
    XAP_CocoaAppMenu_Window,
    XAP_CocoaAppMenu_Help,
    XAP_CocoaAppMenu_count__
};

@interface XAP_CocoaAppController : NSObject
{
    IBOutlet NSMenu *       oMenu_AbiWord;

    IBOutlet NSMenuItem *   oMenuItem_AboutAbiWord;
    IBOutlet NSMenuItem *   oMenuItem_Preferences;

    IBOutlet NSMenu *       oMenu_File;
    IBOutlet NSMenu *       oMenu_Edit;
    IBOutlet NSMenu *       oMenu_View;
    IBOutlet NSMenu *       oMenu_Insert;
    IBOutlet NSMenu *       oMenu_Format;
    IBOutlet NSMenu *       oMenu_Tools;
    IBOutlet NSMenu *       oMenu_Table;
    IBOutlet NSMenu *       oMenu_Window;
    IBOutlet NSMenu *       oMenu_Help;

    IBOutlet NSMenuItem *   oMenuItem_File;
    IBOutlet NSMenuItem *   oMenuItem_Edit;
    IBOutlet NSMenuItem *   oMenuItem_View;
    IBOutlet NSMenuItem *   oMenuItem_Insert;
    IBOutlet NSMenuItem *   oMenuItem_Format;
    IBOutlet NSMenuItem *   oMenuItem_Tools;
    IBOutlet NSMenuItem *   oMenuItem_Table;
    IBOutlet NSMenuItem *   oMenuItem_Window;
    IBOutlet NSMenuItem *   oMenuItem_Help;

    IBOutlet NSMenuItem *   oMenuItem_AbiWordHelp;

    NSMenu *                m_PanelMenu;
    NSMenu *                m_ContextMenu;

    NSMenu *                m_AppMenu[XAP_CocoaAppMenu_count__];
    NSMenuItem *            m_AppItem[XAP_CocoaAppMenu_count__];

    NSMutableDictionary *   m_MenuIDRefDictionary;

    NSMutableArray *        m_Plugins;
    NSMutableArray *        m_PluginsTools;

    NSMenuItem *            m_PluginsToolsSeparator;

    NSMutableArray *        m_FilesRequestedDuringLaunch;

    NSMutableArray *        m_ToolProviders;

    BOOL            m_bApplicationLaunching;
    BOOL            m_bAutoLoadPluginsAfterLaunch;

    AV_View *       m_pViewCurrent;
    XAP_Frame *     m_pFrameCurrent;

    AV_View *       m_pViewPrevious;
    XAP_Frame *     m_pFramePrevious;
}
+ (XAP_CocoaAppController*)sharedAppController;

- (id)init;
- (void)dealloc;

- (void)setAutoLoadPluginsAfterLaunch:(BOOL)autoLoadPluginsAfterLaunch;

- (BOOL)application:(NSApplication *)sender delegateHandlesKey:(NSString *)key;

- (void)applicationWillFinishLaunching:(NSNotification *)aNotification;
- (void)applicationDidFinishLaunching:(NSNotification *)aNotification;

- (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender;
- (void)applicationWillTerminate:(NSNotification *)aNotification;

- (BOOL)application:(NSApplication *)theApplication openFile:(NSString *)filename;
- (BOOL)application:(NSApplication *)theApplication openTempFile:(NSString *)filename;
- (BOOL)application:(NSApplication *)theApplication printFile:(NSString *)filename;
- (BOOL)applicationOpenUntitledFile:(NSApplication *)theApplication;
- (BOOL)applicationOpenFile:(NSApplication *)theApplication;

- (id)dockFileNew:(id)sender;
- (id)dockFileOpen:(id)sender;

/* - (NSMenu *)applicationDockMenu:(NSApplication *)sender; */

/* For building the Application Menu
 */
- (void)setAboutTitle:(NSString *)title;
- (void)setPrefsTitle:(NSString *)title;
- (void)setCHelpTitle:(NSString *)title; // context-help

- (void)setTitle:(NSString *)title forMenu:(XAP_CocoaAppMenu_Id)appMenu;

- (const char *)keyEquivalentForMenuID:(int /* XAP_Menu_Id */)menuid modifierMask:(unsigned int *)mask;

- (NSMenu *)panelMenu;
- (NSMenu *)contextMenu;

- (void)appendPanelItem:(NSMenuItem *)item;
- (void)appendContextItem:(NSMenuItem *)item;
- (void)appendItem:(NSMenuItem *)item toMenu:(XAP_CocoaAppMenu_Id)appMenu;

- (void)clearContextMenu;
- (void)clearMenu:(XAP_CocoaAppMenu_Id)appMenu; // except AbiWord & Windows
- (void)clearAllMenus;                          // except AbiWord & Windows


- (void)reappendPluginMenuItems; // for use after rebuilding menus - see XAP_CocoaApp::rebuildMenus()
- (void)appendPluginMenuItem:(NSMenuItem *)menuItem;
- (void)removePluginMenuItem:(NSMenuItem *)menuItem;

/* Do we need this? getLastFocussedFrame() should be tracking this now... [TODO!!]
 */
- (void)setCurrentView:(AV_View *)view inFrame:(XAP_Frame *)frame;
- (void)resetCurrentView:(AV_View *)view inFrame:(XAP_Frame *)frame;
- (void)unsetCurrentView:(AV_View *)view inFrame:(XAP_Frame *)frame;

- (AV_View *)currentView;
- (XAP_Frame *)currentFrame;

- (AV_View *)previousView;
- (XAP_Frame *)previousFrame;

- (void)notifyFrameViewChange; // [re/un]setCurrentView call this

- (XAP_CocoaPlugin *)loadPlugin:(NSString *)path;

- (NSArray *)plugins;

- (BOOL)deactivateAllPlugins;

- (BOOL)deactivatePlugin:(XAP_CocoaPlugin *)plugin overridePlugin:(BOOL)override;

- (void)addRef:(AP_CocoaPlugin_MenuIDRef *)ref forMenuID:(NSNumber *)menuid;

- (AP_CocoaPlugin_MenuIDRef *)refForMenuID:(NSNumber *)menuid;

- (void)removeRefForMenuID:(NSNumber *)menuid;

- (NSArray *)toolProviders;

- (id <NSObject, XAP_CocoaPlugin_ToolProvider>)toolProvider:(NSString *)name;

@end

#endif /* ! XAP_COCOAAPPCONTROLLER_H */