IlvStExtension Class Reference

Extension class. More...

#include <ivstudio/studext.h>

Inheritance diagram for IlvStExtension:

Public Member Functions
	IlvStExtension (const char *name, IlvStudio *editor)
IlvStudio *	getEditor () const
	Returns the instance of the editor that is being extended. More...
virtual IlBoolean	initializeBuffers ()
	Called to initialize the buffers. More...
virtual IlBoolean	initializeCommandDescriptors ()
	Called to initialize the command descriptors. More...
virtual IlBoolean	initializeInspectors ()
	Called to initialize the inspectors. More...
virtual IlBoolean	initializeModes ()
	Called to initialize the editing modes. More...
virtual IlBoolean	initializePanels ()
	Called to initialize the panels. More...
virtual IlBoolean	postInitialize ()
	Called just after the initialization. More...
virtual IlBoolean	preInitialize ()
	Called before the begin of the initialization. More...
Public Member Functions inherited from IlvStNamedObject
const char *	getName () const
	Returns the name of the object. More...
virtual void	setName (const char *name)
	Sets the name of the object. More...

Detailed Description

Extension class.

Library: ivstudio

To add some new features to Rogue Wave Views Studio, you need to define a new extension. To initialize a new extension and add it to Rogue Wave Views Studio, you have to derive a class from IlvStExtension defining a set of methods that will be invoked in a predefined sequence.
Note: An extension must not be explicitly deleted.

See also

IlvStudio.

Constructor & Destructor Documentation

IlvStExtension()

IlvStExtension::IlvStExtension	(	const char *	name,
		IlvStudio *	editor
	)

Short Initializes an instance of IlvStExtension.

This constructor adds the new instance to the extension list of the editor. You must create an instance of your extension before initializing the Studio instance. When the editor is deleted, this instance is deleted. An extension must not be explicitly deleted.

Parameters

name	The extension name.
editor	The instance of the editor that is being extended.

Member Function Documentation

getEditor()

IlvStudio* IlvStExtension::getEditor

(

)

const

Returns the instance of the editor that is being extended.

Returns

The instance of the editor that is being extended.

initializeBuffers()

virtual IlBoolean IlvStExtension::initializeBuffers ( )

virtual

Called to initialize the buffers.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

initializeCommandDescriptors()

virtual IlBoolean IlvStExtension::initializeCommandDescriptors ( )

virtual

Called to initialize the command descriptors.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

initializeInspectors()

virtual IlBoolean IlvStExtension::initializeInspectors ( )

virtual

Called to initialize the inspectors.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

initializeModes()

virtual IlBoolean IlvStExtension::initializeModes ( )

virtual

Called to initialize the editing modes.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

initializePanels()

virtual IlBoolean IlvStExtension::initializePanels ( )

virtual

Called to initialize the panels.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

postInitialize()

virtual IlBoolean IlvStExtension::postInitialize ( )

virtual

Called just after the initialization.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.

preInitialize()

virtual IlBoolean IlvStExtension::preInitialize ( )

virtual

Called before the begin of the initialization.

Returns

IlTrue if everything works fine or IlFalse if initialization must be stopped.