IlvStExtension Class Reference

Extension class. More...

#include <ivstudio/studext.h>

Inheritance diagram for IlvStExtension:

List of all members.

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

---

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	(	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

IlvStudio* IlvStExtension::getEditor

(

)

const

Returns the instance of the editor that is being extended.

Returns:

The instance of the editor that is being extended.

virtual IlBoolean IlvStExtension::initializeBuffers

(

)

[virtual]

Called to initialize the buffers.

Returns:

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

virtual IlBoolean IlvStExtension::initializeCommandDescriptors

(

)

[virtual]

Called to initialize the command descriptors.

Returns:

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

virtual IlBoolean IlvStExtension::initializeInspectors

(

)

[virtual]

Called to initialize the inspectors.

Returns:

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

virtual IlBoolean IlvStExtension::initializeModes

(

)

[virtual]

Called to initialize the editing modes.

Returns:

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

virtual IlBoolean IlvStExtension::initializePanels

(

)

[virtual]

Called to initialize the panels.

Returns:

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

virtual IlBoolean IlvStExtension::postInitialize

(

)

[virtual]

Called just after the initialization.

Returns:

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

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.