Interface for the main window of an application. More...

#include <ilviews/appframe/mainwitf.h>

Inheritance diagram for IlvDvMainWindowInterface:

Public Member Functions
virtual IlvDvContainerHandler *	createContainerHandler (IlvDvDocTemplate *docTpl, IlUInt viewTemplateIndex=0) const =0
	Gets a view container handler. More...

virtual void	dockBarSet (IlvDvBarSet *barSet, IlBoolean update=IlTrue)=0
	Docks a set of bars. More...

virtual IlvDvDocViewInterface *	getActiveView () const
	Gets the active view of the window. More...

virtual IlvDvViewContainerInterface *	getActiveViewContainer () const =0
	Returns the active document view container. More...

virtual IlvDvApplication *	getDvApplication () const =0
	Gets the application that owns the window. More...

virtual const IlvGadgetContainer *	getGadgetContainer () const =0
	Gets the top container of the window. More...

virtual IlvGadgetContainer *	getGadgetContainer ()=0
	Gets the top container of the window. More...

virtual IlvToolBar *	getMenuBar () const =0
	Returns the menu bar of the window. More...

virtual IlvToolBar *	getToolBar (const IlSymbol *barName) const =0
	Retrieves a bar with the given name from the window. More...

virtual void	initialize ()
	Initializes the window. More...

virtual IlBoolean	isShowingTooltips () const
	Shows tooltips for menu items. More...

virtual IlBoolean	isUsingBigIcons () const
	Shows menu item icons in large size. More...

virtual void	readOptions (const IlvDvOptions *options)
	Reads options. More...

virtual void	removeBarSet (const IlvDvBarSet *barSet, IlBoolean update=IlTrue)=0
	Removes a set of bars. More...

virtual void	saveConfiguration (const IlvDvBarSet &barSet)
	Saves the location of a set of dockable bars. More...

virtual void	setDvApplication (IlvDvApplication *application)=0
	Sets the application that owns the window to the parameter application.

virtual void	setStatusLabel (const char *text)
	Changes the text displayed in the status bar to the text given as the parameter. More...

virtual void	showWindow (IlBoolean show=IlTrue)
	Shows the window. More...

virtual void	updateOptions (IlvDvOptions *options)
	Updates options. More...

virtual IlBoolean	withShortcuts () const
	Shows the action accelerators in tooltips. More...

Public Member Functions inherited from IlvDvInterface
IlBoolean	callMethod (const IlSymbol methodName, IlvDvValue returnedValue,...)
	Generic method for calling a method that is exported in a class interface. More...

IlvDvValue &	getFieldValue (const IlSymbol *fieldName, IlvDvValue &value) const
	Gets a field value. More...

virtual IlBoolean	isProcessingAction (const IlSymbol *methodName) const
	Returns `IlTrue` if the given action can be processed by the class. More...

virtual IlBoolean	processAction (const IlSymbol *actionName)
	Processes an action. More...

virtual IlBoolean	refreshAction (const IlSymbol actionName, IlvDvActionDescriptor desc) const
	Refresh all the menu items that reference the action given by the parameter actionName. More...

void	setFieldValue (const IlSymbol *fieldName, const IlvDvValue &value)
	Sets a field value. More...

Detailed Description

Interface for the main window of an application.

Library: ilvappframe

This class is the interface for the main window of an Application Framework application. It does not usually have to be overridden because Application Framework provides the IlvDvDockableMainWindow subclass. This subclass provides all the standard MDI window management and extended dockable bar services needed to make a professional application GUI.

However, it can be useful to inherit this class for specific uses, such as integrating Application Framework into an existing application in order to make it more powerful. In this case, you need to link the existing main window with the Application Framework document management services. To do this, the existing main window class must first inherit from the IlvDvMainWindowInterface class to override pure methods. Then, the main window class must be instantiated by the application, by overriding the method createMainWindow of the IlvDvApplication class.

See also: IlvDvApplication; IlvDvDocTemplate

Member Function Documentation

◆ createContainerHandler()

virtual IlvDvContainerHandler* IlvDvMainWindowInterface::createContainerHandler	(	IlvDvDocTemplate *	docTpl,
		IlUInt	viewTemplateIndex = `0`
	)		const

pure virtual

Gets a view container handler.

This handler will be called by document templates to create and handle view containers.

Returns: The new view container handler.

See also: IlvDvContainerHandler

Implemented in IlvDvDockableMainWindow.

◆ dockBarSet()

virtual void IlvDvMainWindowInterface::dockBarSet	(	IlvDvBarSet *	barSet,
		IlBoolean	update = `IlTrue`
	)

pure virtual

Docks a set of bars.

Called by a document template to dock its set of toolbars within the window.

Parameters

barSet	Specifies the set of toolbars.
update	If `IlTrue`, the window must be updated.

See also: IlvDvBarSet

Implemented in IlvDvDockableMainWindow.

◆ getActiveView()

virtual IlvDvDocViewInterface* IlvDvMainWindowInterface::getActiveView ( ) const

virtual

Gets the active view of the window.

By default, it returns the active view of the active view container.

Returns: The active view of the window.

See also: getActiveViewContainer()

◆ getActiveViewContainer()

virtual IlvDvViewContainerInterface* IlvDvMainWindowInterface::getActiveViewContainer ( ) const

pure virtual

Returns the active document view container.

Returns: The active document view container.

Implemented in IlvDvDockableMainWindow.

◆ getDvApplication()

virtual IlvDvApplication* IlvDvMainWindowInterface::getDvApplication ( ) const

pure virtual

Gets the application that owns the window.

Returns: The application that owns the window.

Implemented in IlvDvDockableMainWindow.

◆ getGadgetContainer() [1/2]

virtual const IlvGadgetContainer* IlvDvMainWindowInterface::getGadgetContainer ( ) const

pure virtual

Gets the top container of the window.

Usually, it returns the window itself.

Returns: The top container of the window.

Implemented in IlvDvDockableMainWindow.

◆ getGadgetContainer() [2/2]

virtual IlvGadgetContainer* IlvDvMainWindowInterface::getGadgetContainer ( )

pure virtual

Gets the top container of the window.

Usually, it returns the window itself.

Returns: The top container of the window.

Implemented in IlvDvDockableMainWindow.

◆ getMenuBar()

virtual IlvToolBar* IlvDvMainWindowInterface::getMenuBar ( ) const

pure virtual

Returns the menu bar of the window.

Returns: The menu bar of the window. It can return 0.

Implemented in IlvDvDockableMainWindow.

◆ getToolBar()

virtual IlvToolBar* IlvDvMainWindowInterface::getToolBar ( const IlSymbol * barName ) const

pure virtual

Retrieves a bar with the given name from the window.

Returns the bar owned by the window whose name is given by the parameter barName.

Returns: The bar with the given name from the window. It can return 0 if no bars with the given name were found.

Implemented in IlvDvDockableMainWindow.

◆ initialize()

virtual void IlvDvMainWindowInterface::initialize ( )

virtual

Initializes the window.

Called by the application once it has created the window and the window options have been read. This method must be overridden to add initialization code.
For example, the IlvDvDockableMainWindow class overrides this method to tag the Windows popup menu that will be used for adding new window titles.

Reimplemented in IlvDvDockableMainWindow.

◆ isShowingTooltips()

virtual IlBoolean IlvDvMainWindowInterface::isShowingTooltips ( ) const

virtual

Shows tooltips for menu items.

Returns IlTrue if tooltips must be displayed for menu items in the window toolbars. Otherwise, it returns IlFalse. By default, it returns IlTrue.

Returns: IlTrue if tooltips must be displayed for menu items in the window toolbars. Otherwise, it returns IlFalse.

Reimplemented in IlvDvDockableMainWindow.

◆ isUsingBigIcons()

virtual IlBoolean IlvDvMainWindowInterface::isUsingBigIcons ( ) const

virtual

Shows menu item icons in large size.

Returns IlTrue if the menu item icons must be displayed in large size. If it returns IlFalse, icons are displayed in normal size. By default, it return IlFalse.

Returns: IlTrue if the menu item icons must be displayed in large size. Otherwise, it returns IlFalse.

Reimplemented in IlvDvDockableMainWindow.

◆ readOptions()

virtual void IlvDvMainWindowInterface::readOptions ( const IlvDvOptions * options )

virtual

Reads options.

Called to make the window read options that it had saved during the previous session.
It is redefined by the IlvDvDockableMainWindow subclass to read the location and state of bars that were saved the last time the application closed.

Reimplemented in IlvDvDockableMainWindow.

◆ removeBarSet()

virtual void IlvDvMainWindowInterface::removeBarSet	(	const IlvDvBarSet *	barSet,
		IlBoolean	update = `IlTrue`
	)

pure virtual

Removes a set of bars.

Called by a document template to remove a set of toolbars.

Parameters

barSet	Specifies the set of toolbars.
update	If `IlTrue`, the window must be updated.

See also: IlvDvBarSet

Implemented in IlvDvDockableMainWindow.

◆ saveConfiguration()

virtual void IlvDvMainWindowInterface::saveConfiguration ( const IlvDvBarSet & barSet )

virtual

Saves the location of a set of dockable bars.

Called to save the location of bars within the bar set given by the parameter barSet.

See also: IlvDvBarSet

Reimplemented in IlvDvDockableMainWindow.

◆ setStatusLabel()

virtual void IlvDvMainWindowInterface::setStatusLabel ( const char * text )

virtual

Changes the text displayed in the status bar to the text given as the parameter.

For example, it is called when menu items are highlighted to display the description of the corresponding actions.

Reimplemented in IlvDvDockableMainWindow.

◆ showWindow()

virtual void IlvDvMainWindowInterface::showWindow ( IlBoolean show = IlTrue )

virtual

Shows the window.

Called by the application to show or hide the window. By default, this method shows or hides the gadget container returned by the getGadgetContainer() method, depending on the value of the parameter show.

Reimplemented in IlvDvDockableMainWindow.

◆ updateOptions()

virtual void IlvDvMainWindowInterface::updateOptions ( IlvDvOptions * options )

virtual

Updates options.

Called to make the window update the application options that it had saved during the previous session.
It is redefined by the IlvDvDockableMainWindow subclass to save the current location and state of its bars.

Reimplemented in IlvDvDockableMainWindow.

◆ withShortcuts()

virtual IlBoolean IlvDvMainWindowInterface::withShortcuts ( ) const

virtual

Shows the action accelerators in tooltips.

Returns IlTrue if action accelerators must be shown in the menu item tooltips. By default, it returns IlTrue.

Returns: IlTrue if action accelerators must be shown in the menu item tooltips. Otherwise, it returns IlFalse.

Reimplemented in IlvDvDockableMainWindow.

Public Member Functions

Detailed Description

Member Function Documentation

◆ createContainerHandler()

◆ dockBarSet()

◆ getActiveView()

◆ getActiveViewContainer()

◆ getDvApplication()

◆ getGadgetContainer() [1/2]

◆ getGadgetContainer() [2/2]

◆ getMenuBar()

◆ getToolBar()

◆ initialize()

◆ isShowingTooltips()

◆ isUsingBigIcons()

◆ readOptions()

◆ removeBarSet()

◆ saveConfiguration()

◆ setStatusLabel()

◆ showWindow()

◆ updateOptions()

◆ withShortcuts()