XAP_CocoaAppController Class Reference

#import <xap_CocoaAppController.h>

List of all members.

Public Member Functions
(id)	- init
(void)	- dealloc
(void)	- setAutoLoadPluginsAfterLaunch:
(BOOL)	- application:delegateHandlesKey:
(void)	- applicationWillFinishLaunching:
(void)	- applicationDidFinishLaunching:
(NSApplicationTerminateReply)	- applicationShouldTerminate:
(void)	- applicationWillTerminate:
(BOOL)	- application:openFile:
(BOOL)	- application:openTempFile:
(BOOL)	- application:printFile:
(BOOL)	- applicationOpenUntitledFile:
(BOOL)	- applicationOpenFile:
(id)	- dockFileNew:
(id)	- dockFileOpen:
(void)	- setAboutTitle:
(void)	- setPrefsTitle:
(void)	- setCHelpTitle:
(void)	- setTitle:forMenu:
(const char *)	- keyEquivalentForMenuID:modifierMask:
(NSMenu *)	- panelMenu
(NSMenu *)	- contextMenu
(void)	- appendPanelItem:
(void)	- appendContextItem:
(void)	- appendItem:toMenu:
(void)	- clearContextMenu
(void)	- clearMenu:
(void)	- clearAllMenus
(void)	- reappendPluginMenuItems
(void)	- appendPluginMenuItem:
(void)	- removePluginMenuItem:
(void)	- setCurrentView:inFrame:
(void)	- resetCurrentView:inFrame:
(void)	- unsetCurrentView:inFrame:
(AV_View *)	- currentView
(XAP_Frame *)	- currentFrame
(AV_View *)	- previousView
(XAP_Frame *)	- previousFrame
(void)	- notifyFrameViewChange
(XAP_CocoaPlugin *)	- loadPlugin:
	Load .Abi bundle plugin at path.
(NSArray *)	- plugins
(BOOL)	- deactivateAllPlugins
	Checks to see whether the plugins can deactivate, and, if they can, deactivates them.
(BOOL)	- deactivatePlugin:overridePlugin:
	Checks to see whether the plugins can deactivate, and, if they can, deactivates them.
(void)	- addRef:forMenuID:
	This provides a mechanism for associating XAP_CocoaPlugin_MenuItem objects with a given menu ID.
(AP_CocoaPlugin_MenuIDRef *)	- refForMenuID:
	This provides a mechanism for finding XAP_CocoaPlugin_MenuItem objects associated with a given menu ID.
(void)	- removeRefForMenuID:
	This provides a mechanism for removing XAP_CocoaPlugin_MenuItem objects associated with a given menu ID.
(NSArray *)	- toolProviders
	Get a list of all the tool providers.
(id< NSObject, XAP_CocoaPlugin_ToolProvider >)	- toolProvider:
	Find a tool provider by name.
Static Public Member Functions
(XAP_CocoaAppController *)	+ sharedAppController
Protected Attributes
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

---

Member Function Documentation

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

This provides a mechanism for associating XAP_CocoaPlugin_MenuItem objects with a given menu ID.

References m_MenuIDRefDictionary.

Referenced by AP_CocoaPlugin_ContextMenuItem::initWithLabel:.

- (void) appendContextItem:

(NSMenuItem *)

item

References m_ContextMenu.

Referenced by EV_CocoaMenu::addToAppMenu.

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

References m_AppMenu, XAP_CocoaAppMenu_AbiWord, XAP_CocoaAppMenu_count__, XAP_CocoaAppMenu_Edit, XAP_CocoaAppMenu_File, XAP_CocoaAppMenu_Format, XAP_CocoaAppMenu_Help, XAP_CocoaAppMenu_Insert, XAP_CocoaAppMenu_Table, XAP_CocoaAppMenu_Tools, XAP_CocoaAppMenu_View, and XAP_CocoaAppMenu_Window.

Referenced by EV_CocoaMenu::addToAppMenu.

- (void) appendPanelItem:

(NSMenuItem *)

item

References m_PanelMenu.

Referenced by XAP_CocoaToolPalette::windowDidLoad, and XAP_CocoaPreviewPanel::windowDidLoad.

- (void) appendPluginMenuItem:

(NSMenuItem *)

menuItem

References m_AppMenu, and m_PluginsTools.

Referenced by XAP_CocoaPlugin::appendMenuItem:.

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

References UT_UNUSED.

- (BOOL) application:		(NSApplication *)	theApplication
openFile:		(NSString *)	filename

References XAP_App::getApp(), XAP_CocoaModule::hasPluginExtension(), IEFT_Unknown, XAP_Frame::loadDocument(), XAP_CocoaModule::loadPlugin(), m_bApplicationLaunching, m_FilesRequestedDuringLaunch, XAP_App::newFrame(), XAP_Frame::show(), UT_DEBUGMSG, UT_OK, and UT_UNUSED.

Referenced by application:openTempFile:, application:printFile:, and applicationDidFinishLaunching:.

- (BOOL) application:		(NSApplication *)	theApplication
openTempFile:		(NSString *)	filename

References application:openFile:, and UT_DEBUGMSG.

- (BOOL) application:		(NSApplication *)	theApplication
printFile:		(NSString *)	filename

References application:openFile:, and UT_DEBUGMSG.

- (void) applicationDidFinishLaunching:

(NSNotification *)

aNotification

References XAP_CocoaToolProvider::AbiWordToolProvider, application:openFile:, applicationOpenUntitledFile:, BOOL(), XAP_App::getApp(), XAP_CocoaApp::getCocoaMenuBar(), XAP_CocoaModule::hasPluginExtension(), XAP_CocoaToolPalette::instance:, XAP_CocoaModule::loadAllPlugins(), m_AppItem, m_AppMenu, m_bApplicationLaunching, m_bAutoLoadPluginsAfterLaunch, m_FilesRequestedDuringLaunch, m_ToolProviders, oMenu_Edit, oMenu_File, oMenu_Format, oMenu_Help, oMenu_Insert, oMenu_Table, oMenu_Tools, oMenu_View, oMenu_Window, oMenuItem_Edit, oMenuItem_File, oMenuItem_Format, oMenuItem_Help, oMenuItem_Insert, oMenuItem_Table, oMenuItem_Tools, oMenuItem_View, oMenuItem_Window, UT_DEBUGMSG, and UT_UNUSED.

- (BOOL) applicationOpenFile:

(NSApplication *)

theApplication

References EV_EditMethodContainer::findEditMethodByName(), EV_EditMethod::Fn(), XAP_App::getApp(), XAP_App::getEditMethodContainer(), and UT_UNUSED.

Referenced by dockFileOpen:, and XAP_CocoaApplication::sendEvent:.

- (BOOL) applicationOpenUntitledFile:

(NSApplication *)

theApplication

References EV_EditMethodContainer::findEditMethodByName(), EV_EditMethod::Fn(), XAP_App::getApp(), XAP_App::getEditMethodContainer(), m_bApplicationLaunching, UT_DEBUGMSG, and UT_UNUSED.

Referenced by applicationDidFinishLaunching:, dockFileNew:, and XAP_CocoaApplication::sendEvent:.

- (NSApplicationTerminateReply) applicationShouldTerminate:

(NSApplication *)

sender

References ev_EditMethod_invoke(), UT_DEBUGMSG, and UT_UNUSED.

- (void) applicationWillFinishLaunching:

(NSNotification *)

aNotification

References UT_UNUSED.

- (void) applicationWillTerminate:

(NSNotification *)

aNotification

References XAP_CocoaToolPalette::close, XAP_CocoaToolPalette::instance:, and UT_UNUSED.

- (void) clearAllMenus

References clearMenu:.

Referenced by EV_CocoaMenu::buildAppMenu.

- (void) clearContextMenu

References m_ContextMenu.

Referenced by EV_CocoaMenu::buildAppMenu.

- (void) clearMenu:

(XAP_CocoaAppMenu_Id)

appMenu

References m_AppMenu, XAP_CocoaAppMenu_AbiWord, XAP_CocoaAppMenu_count__, XAP_CocoaAppMenu_Edit, XAP_CocoaAppMenu_File, XAP_CocoaAppMenu_Format, XAP_CocoaAppMenu_Help, XAP_CocoaAppMenu_Insert, XAP_CocoaAppMenu_Table, XAP_CocoaAppMenu_Tools, XAP_CocoaAppMenu_View, and XAP_CocoaAppMenu_Window.

Referenced by clearAllMenus.

- (NSMenu *) contextMenu

- (XAP_Frame *) currentFrame

Referenced by XAP_CocoaApplication::sendEvent:, and XAP_CocoaToolPalette::windowDidLoad.

- (AV_View *) currentView

Referenced by XAP_CocoaToolPalette::windowDidLoad.

- (BOOL) deactivateAllPlugins

Checks to see whether the plugins can deactivate, and, if they can, deactivates them.

Returns:

Returns false if any of the plugins object.

References BOOL(), XAP_CocoaPlugin::delegate, and m_Plugins.

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

Checks to see whether the plugins can deactivate, and, if they can, deactivates them.

Returns:

Returns false if the plugin objects, unless override is YES.

References XAP_CocoaPlugin::delegate.

- (void) dealloc

References m_ContextMenu, m_FilesRequestedDuringLaunch, m_MenuIDRefDictionary, m_PanelMenu, m_Plugins, m_PluginsTools, m_PluginsToolsSeparator, and m_ToolProviders.

- (id) dockFileNew:

(id)

sender

References applicationOpenUntitledFile:, and UT_UNUSED.

- (id) dockFileOpen:

(id)

sender

References applicationOpenFile:, and UT_UNUSED.

- (id) init

References m_bApplicationLaunching, m_bAutoLoadPluginsAfterLaunch, m_ContextMenu, m_FilesRequestedDuringLaunch, m_MenuIDRefDictionary, m_PanelMenu, m_Plugins, m_PluginsTools, m_PluginsToolsSeparator, m_ToolProviders, and UT_DEBUGMSG.

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

References EV_CocoaKeyEquiv::equiv, EV_CocoaKeyEquiv::menuid, and EV_CocoaKeyEquiv::modifier.

- (XAP_CocoaPlugin *) loadPlugin:

(NSString *)

path

Load .Abi bundle plugin at path.

Returns:

Returns nil on failure.

References m_Plugins.

- (void) notifyFrameViewChange

References XAP_CocoaPlugin::delegate, XAP_CocoaToolPalette::instance:, m_Plugins, and XAP_CocoaToolPalette::setCurrentView:inFrame:.

Referenced by resetCurrentView:inFrame:, setCurrentView:inFrame:, and unsetCurrentView:inFrame:.

- (NSMenu *) panelMenu

- (NSArray *) plugins

Returns:

Returns list of currently loaded plugins.

- (XAP_Frame *) previousFrame

- (AV_View *) previousView

- (void) reappendPluginMenuItems

References m_AppMenu.

- (AP_CocoaPlugin_MenuIDRef *) refForMenuID:

(NSNumber *)

menuid

This provides a mechanism for finding XAP_CocoaPlugin_MenuItem objects associated with a given menu ID.

References m_MenuIDRefDictionary.

Referenced by s_GetMenuItemComputedLabel_Fn(), and s_GetMenuItemState_Fn().

- (void) removePluginMenuItem:

(NSMenuItem *)

menuItem

References m_AppMenu, and m_PluginsTools.

Referenced by XAP_CocoaPlugin::removeMenuItem:.

- (void) removeRefForMenuID:

(NSNumber *)

menuid

This provides a mechanism for removing XAP_CocoaPlugin_MenuItem objects associated with a given menu ID.

References m_MenuIDRefDictionary.

Referenced by AP_CocoaPlugin_ContextMenuItem::dealloc.

- (void) resetCurrentView:		(AV_View *)	view
inFrame:		(XAP_Frame *)	frame

References notifyFrameViewChange.

- (void) setAboutTitle:

(NSString *)

title

References oMenuItem_AboutAbiWord.

Referenced by EV_CocoaMenu::addToAppMenu.

- (void) setAutoLoadPluginsAfterLaunch:

(BOOL)

autoLoadPluginsAfterLaunch

References m_bAutoLoadPluginsAfterLaunch.

- (void) setCHelpTitle:

(NSString *)

title

References oMenuItem_AbiWordHelp.

- (void) setCurrentView:		(AV_View *)	view
inFrame:		(XAP_Frame *)	frame

References XAP_App::clearLastFocussedFrame(), XAP_App::getApp(), notifyFrameViewChange, and XAP_App::rememberFocussedFrame().

- (void) setPrefsTitle:

(NSString *)

title

References oMenuItem_Preferences.

Referenced by EV_CocoaMenu::addToAppMenu.

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

References m_AppItem, XAP_CocoaAppMenu_AbiWord, XAP_CocoaAppMenu_count__, XAP_CocoaAppMenu_Edit, XAP_CocoaAppMenu_File, XAP_CocoaAppMenu_Format, XAP_CocoaAppMenu_Help, XAP_CocoaAppMenu_Insert, XAP_CocoaAppMenu_Table, XAP_CocoaAppMenu_Tools, XAP_CocoaAppMenu_View, and XAP_CocoaAppMenu_Window.

Referenced by EV_CocoaMenu::buildAppMenu.

+ (XAP_CocoaAppController *) sharedAppController

References UT_DEBUGMSG.

- (id< NSObject, XAP_CocoaPlugin_ToolProvider >) toolProvider:

(NSString *)

name

Find a tool provider by name.

(TODO: If plug-ins are registering tool providers, we need to implement a notification system to update toolbar systems.)

Parameters:

name

The name of the tool provider to find.

Returns:

The tool provider, or nil if none is registered with the given name.

References m_ToolProviders.

Referenced by XAP_CocoaPlugin::toolProvider:.

- (NSArray *) toolProviders

Get a list of all the tool providers.

Each tool provider is of type id <NSObject, XAP_CocoaPlugin_ToolProvider>.

Returns:

The tool providers.

Referenced by XAP_CocoaPlugin::toolProviders.

- (void) unsetCurrentView:		(AV_View *)	view
inFrame:		(XAP_Frame *)	frame

References XAP_App::clearLastFocussedFrame(), XAP_App::getApp(), XAP_App::getLastFocussedFrame(), and notifyFrameViewChange.

---

Member Data Documentation

- (NSMenuItem* m_AppItem[XAP_CocoaAppMenu_count__]) [protected]

Referenced by applicationDidFinishLaunching:, and setTitle:forMenu:.

- (NSMenu* m_AppMenu[XAP_CocoaAppMenu_count__]) [protected]

Referenced by appendItem:toMenu:, appendPluginMenuItem:, applicationDidFinishLaunching:, clearMenu:, reappendPluginMenuItems, and removePluginMenuItem:.

- (BOOL) m_bApplicationLaunching [protected]

Referenced by application:openFile:, applicationDidFinishLaunching:, applicationOpenUntitledFile:, and init.

- (BOOL) m_bAutoLoadPluginsAfterLaunch [protected]

Referenced by applicationDidFinishLaunching:, init, and setAutoLoadPluginsAfterLaunch:.

- (NSMenu*) m_ContextMenu [protected]

Referenced by appendContextItem:, clearContextMenu, dealloc, and init.

- (NSMutableArray*) m_FilesRequestedDuringLaunch [protected]

Referenced by application:openFile:, applicationDidFinishLaunching:, dealloc, and init.

- (NSMutableDictionary*) m_MenuIDRefDictionary [protected]

Referenced by addRef:forMenuID:, dealloc, init, refForMenuID:, and removeRefForMenuID:.

- (NSMenu*) m_PanelMenu [protected]

Referenced by appendPanelItem:, dealloc, and init.

- (XAP_Frame*) m_pFrameCurrent [protected]

- (XAP_Frame*) m_pFramePrevious [protected]

- (NSMutableArray*) m_Plugins [protected]

Referenced by deactivateAllPlugins, dealloc, init, loadPlugin:, and notifyFrameViewChange.

- (NSMutableArray*) m_PluginsTools [protected]

Referenced by appendPluginMenuItem:, dealloc, init, and removePluginMenuItem:.

- (NSMenuItem*) m_PluginsToolsSeparator [protected]

Referenced by dealloc, and init.

- (AV_View*) m_pViewCurrent [protected]

- (AV_View*) m_pViewPrevious [protected]

- (NSMutableArray*) m_ToolProviders [protected]

Referenced by applicationDidFinishLaunching:, dealloc, init, and toolProvider:.

- (IBOutlet NSMenu*) oMenu_AbiWord [protected]

- (IBOutlet NSMenu*) oMenu_Edit [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_File [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Format [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Help [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Insert [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Table [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Tools [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_View [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenu*) oMenu_Window [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_AbiWordHelp [protected]

Referenced by setCHelpTitle:.

- (IBOutlet NSMenuItem*) oMenuItem_AboutAbiWord [protected]

Referenced by setAboutTitle:.

- (IBOutlet NSMenuItem*) oMenuItem_Edit [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_File [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Format [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Help [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Insert [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Preferences [protected]

Referenced by setPrefsTitle:.

- (IBOutlet NSMenuItem*) oMenuItem_Table [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Tools [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_View [protected]

Referenced by applicationDidFinishLaunching:.

- (IBOutlet NSMenuItem*) oMenuItem_Window [protected]

Referenced by applicationDidFinishLaunching:.

---

The documentation for this class was generated from the following files:

• xap_CocoaAppController.cpp
• xap_CocoaAppController.h