IlvStudio Class Reference

Editor class. More...

#include <ivstudio/studio.h>

Inherited by IlvPrototypeStudio.

List of all members.

Public Member Functions
	IlvStudio (IlvDisplay *display, int argc=0, char **argv=0)
	Initializes an instance of IlvStudio.
void	addContainerInfo (IlvStContainerInfo *info)
	Adds informations about a subclass of container.
void	addOptionFile (const char *str, IlUInt ndx=(IlUInt)-1)
	Adds an option file.
IlvStBuffers &	buffers ()
	Returns the edition modes.
IlvStError *	execute (const char *cmdName, IlAny caller=0, IlvStCommand *cmd=0, IlAny arg=0)
	Execute a command.
IlvDisplay *	getDisplay () const
	Returns the display.
IlvStPanelHandler *	getPanel (const char *name) const
	Returns a panel.
IlvGraphicCallback	getRegisteredCallback (const char *name) const
	Returns a callback.
IlvGraphic *	getSelection () const
	Returns the selected graphic object.
virtual void	initialize ()
	Called to execute the initialization.
IlvStInspector &	inspector ()
	Returns the object that manages the inspectors.
IlBoolean	isBad () const
	Returns IlFalse if the basic initializations are good.
virtual void	mainLoop ()
	Called to execute the main loop of Rogue Wave Views Studio.
IlvStModes &	modes ()
	Returns the buffers.
IlvStOptions &	options ()
	Returns the options.
virtual void	parseArguments ()
	Called to parse the arguments.
void	registerCallback (const char *name, IlvGraphicCallback cb)
	Registers a callback.
void	registerCommand (const char *name, IlvStCommandConstructor cmd)
	Registers a command.
void	unregisterCallback (const char *name)
	Unregisters a callback.
Friends
class	IlvStBuffers
class	IlvStInspector
class	IlvStModes
class	IlvStOptions

---

Detailed Description

Editor class.

Library: ivstudio

It is the main class of the Rogue Wave Views Studio editor.

---

Constructor & Destructor Documentation

IlvStudio::IlvStudio	(	IlvDisplay *	display,
		int	argc = 0,
		char **	argv = 0
	)

Initializes an instance of IlvStudio.

Parameters:

	display	The display.
	argc	The parameter count.
	argv	The values of the parameters.

---

Member Function Documentation

void IlvStudio::addContainerInfo

(

IlvStContainerInfo *

info

)

Adds informations about a subclass of container.

Parameters:

info

The informations about the container subclass.

void IlvStudio::addOptionFile	(	const char *	str,
		IlUInt	ndx = (IlUInt)-1
	)

Adds an option file.

Adds an option file to the list of option files. The option files are read to initialize and customize Rogue Wave Views Studio.

Parameters:

	str	The file name.
	ndx	The insertion position in the option files list.

IlvStBuffers& IlvStudio::buffers

(

)

Returns the edition modes.

Returns:

The object which manages all Rogue Wave Views Studio edition modes.

IlvStError* IlvStudio::execute	(	const char *	cmdName,
		IlAny	caller = 0,
		IlvStCommand *	cmd = 0,
		IlAny	arg = 0
	)

Execute a command.

Parameters:

	cmdName	The command name.
	called	The object which wants to execute this command.
	cmd	The command.
	arg	The user data.

Returns:

null if successful, otherwise returns an instance of IlvStError.

IlvDisplay* IlvStudio::getDisplay

(

)

const

Returns the display.

Returns:

The display.

IlvStPanelHandler* IlvStudio::getPanel

(

const char *

name

)

const

Returns a panel.

Parameters:

name

The panel name.

Returns:

The panel if found, otherwise, returns null.

IlvGraphicCallback IlvStudio::getRegisteredCallback

(

const char *

name

)

const

Returns a callback.

Parameters:

name

The callback name.

Returns:

The callback if found, otherwise, returns null.

IlvGraphic* IlvStudio::getSelection

(

)

const

Returns the selected graphic object.

Returns:

The selected graphic object.

virtual void IlvStudio::initialize

(

)

[virtual]

Called to execute the initialization.

Before the calling of this function, you must check that the result of the isBad function is IlFalse.

IlvStInspector& IlvStudio::inspector

(

)

Returns the object that manages the inspectors.

Returns:

The object which manages all Rogue Wave Views Studio inspectors.

IlBoolean IlvStudio::isBad

(

)

const

Returns IlFalse if the basic initializations are good.

Returns:

IlFalse if the basic initializations are good, otherwise returns IlTrue.

virtual void IlvStudio::mainLoop

(

)

[virtual]

Called to execute the main loop of Rogue Wave Views Studio.

This function must call after the parseArguments function.

IlvStModes& IlvStudio::modes

(

)

Returns the buffers.

Returns:

The object which manages all Rogue Wave Views Studio buffers.

IlvStOptions& IlvStudio::options

(

)

Returns the options.

Returns:

The object which manages all Rogue Wave Views Studio options.

virtual void IlvStudio::parseArguments

(

)

[virtual]

Called to parse the arguments.

This function must call after the initialize function.

void IlvStudio::registerCallback	(	const char *	name,
		IlvGraphicCallback	cb
	)

Registers a callback.

Parameters:

	name	The callback name.
	cb	The callback.

void IlvStudio::registerCommand	(	const char *	name,
		IlvStCommandConstructor	cmd
	)

Registers a command.

Parameters:

	name	The command name.
	cmd	The function which is called to create an instance of the command.

void IlvStudio::unregisterCallback

(

const char *

name

)

Unregisters a callback.

Parameters:

name

The callback name.