Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Friends
IlvStudio Class Reference

Editor class. More...

#include <ivstudio/studio.h>

Inheritance diagram for IlvStudio:
IlvValueInterface

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...
 
IlvStBuffersbuffers ()
 Returns the buffers. More...
 
IlvStErrorexecute (const char *commandName, IlAny caller=0, IlvStCommand *command=0, IlAny data=0)
 Execute a command. More...
 
IlvDisplaygetDisplay () const
 Returns the display. More...
 
IlvStPanelHandlergetPanel (const char *name) const
 Returns a panel. More...
 
IlvGraphicCallback getRegisteredCallback (const char *name) const
 Returns a callback. More...
 
IlvGraphicgetSelection () const
 Returns the selected graphic object. More...
 
virtual void initialize ()
 Called to execute the initialization. More...
 
IlvStInspectorinspector ()
 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...
 
IlvStModesmodes ()
 Returns the edition modes. More...
 
IlvStOptionsoptions ()
 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 ( IlvDisplay display,
int  argc = 0,
char **  argv = 0 
)

Initializes an instance of IlvStudio.

Parameters
displayThe display.
argcThe parameter count.
argvThe values of the parameters.

Member Function Documentation

void IlvStudio::addContainerInfo ( IlvStContainerInfo info)

Adds informations about a subclass of container.

Parameters
infoThe 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
strThe file name.
ndxThe insertion position in the option files list.
IlvStBuffers& IlvStudio::buffers ( )

Returns the buffers.

Returns
The object which manages all Rogue Wave Views Studio buffers.
IlvStError* IlvStudio::execute ( const char *  commandName,
IlAny  caller = 0,
IlvStCommand command = 0,
IlAny  data = 0 
)

Execute a command.

Parameters
commandNameThe command name.
callerThe object which requested to execute this command.
commandThe command.
dataThe 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
nameThe panel name.
Returns
The panel if found, otherwise, returns null.
IlvGraphicCallback IlvStudio::getRegisteredCallback ( const char *  name) const

Returns a callback.

Parameters
nameThe callback name.
Returns
The callback function if it was found, or null if there is no such registered callback.
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

Tests if the initialization was successful.

Returns
IlFalse if the initialization was a success, or IlTrue if a problem occurred.
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 edition modes.

Returns
The object which manages all Rogue Wave Views Studio edition modes.
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  callback 
)

Registers a callback.

Parameters
nameThe callback name.
callbackThe callback function.
void IlvStudio::registerCommand ( const char *  name,
IlvStCommandConstructor  cmd 
)

Registers a command.

Parameters
nameThe command name.
cmdThe function which is called to create an instance of the command.
void IlvStudio::unregisterCallback ( const char *  name)

Unregisters a callback.

Parameters
nameThe callback name.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.