IlvStudio Class Reference

Editor class. More...

#include <ivstudio/studio.h>

Inheritance diagram for IlvStudio:

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

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

addContainerInfo()

void IlvStudio::addContainerInfo

(

IlvStContainerInfo *

info

)

Adds informations about a subclass of container.

Parameters

info	The informations about the container subclass.

addOptionFile()

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.

buffers()

IlvStBuffers& IlvStudio::buffers

(

)

Returns the buffers.

Returns

The object which manages all Rogue Wave Views Studio buffers.

execute()

IlvStError* IlvStudio::execute	(	const char *	commandName,
		IlAny	caller = 0,
		IlvStCommand *	command = 0,
		IlAny	data = 0
	)

Execute a command.

Parameters

commandName	The command name.
caller	The object which requested to execute this command.
command	The command.
data	The user data.

Returns

null if successful, otherwise returns an instance of IlvStError.

getDisplay()

IlvDisplay* IlvStudio::getDisplay

(

)

const

Returns the display.

Returns

The display.

getPanel()

IlvStPanelHandler* IlvStudio::getPanel

(

const char *

name

)

const

Returns a panel.

Parameters

name	The panel name.

Returns

The panel if found, otherwise, returns null.

getRegisteredCallback()

IlvGraphicCallback IlvStudio::getRegisteredCallback

(

const char *

name

)

const

Returns a callback.

Parameters

name	The callback name.

Returns

The callback function if it was found, or null if there is no such registered callback.

getSelection()

IlvGraphic* IlvStudio::getSelection

(

)

const

Returns the selected graphic object.

Returns

The selected graphic object.

initialize()

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.

inspector()

IlvStInspector& IlvStudio::inspector

(

)

Returns the object that manages the inspectors.

Returns

The object which manages all Rogue Wave Views Studio inspectors.

isBad()

IlBoolean IlvStudio::isBad

(

)

const

Tests if the initialization was successful.

Returns

IlFalse if the initialization was a success, or IlTrue if a problem occurred.

mainLoop()

virtual void IlvStudio::mainLoop ( )

virtual

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

This function must call after the parseArguments() function.

modes()

IlvStModes& IlvStudio::modes

(

)

Returns the edition modes.

Returns

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

options()

IlvStOptions& IlvStudio::options

(

)

Returns the options.

Returns

The object which manages all Rogue Wave Views Studio options.

parseArguments()

virtual void IlvStudio::parseArguments ( )

virtual

Called to parse the arguments.

This function must call after the initialize() function.

registerCallback()

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

Registers a callback.

Parameters

name	The callback name.
callback	The callback function.

registerCommand()

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.

unregisterCallback()

void IlvStudio::unregisterCallback

(

const char *

name

)

Unregisters a callback.

Parameters

name	The callback name.