Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Editor class. More...
#include <ivstudio/studio.h>
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 |
Editor class.
Library: ivstudio
It is the main class of the Rogue Wave Views Studio editor.
IlvStudio::IlvStudio | ( | IlvDisplay * | display, |
int | argc = 0 , |
||
char ** | argv = 0 |
||
) |
Initializes an instance of IlvStudio
.
display | The display. |
argc | The parameter count. |
argv | The values of the parameters. |
void IlvStudio::addContainerInfo | ( | IlvStContainerInfo * | info | ) |
Adds informations about a subclass of container.
info | The informations about the container subclass. |
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.
str | The file name. |
ndx | The insertion position in the option files list. |
IlvStBuffers& IlvStudio::buffers | ( | ) |
Returns the buffers.
IlvStError* IlvStudio::execute | ( | const char * | commandName, |
IlAny | caller = 0 , |
||
IlvStCommand * | command = 0 , |
||
IlAny | data = 0 |
||
) |
Execute a command.
commandName | The command name. |
caller | The object which requested to execute this command. |
command | The command. |
data | The user data. |
null
if successful, otherwise returns an instance of IlvStError
. IlvDisplay* IlvStudio::getDisplay | ( | ) | const |
Returns the display.
IlvStPanelHandler* IlvStudio::getPanel | ( | const char * | name | ) | const |
Returns a panel.
name | The panel name. |
null
. IlvGraphicCallback IlvStudio::getRegisteredCallback | ( | const char * | name | ) | const |
Returns a callback.
name | The callback name. |
null
if there is no such registered callback. IlvGraphic* IlvStudio::getSelection | ( | ) | const |
Returns the selected graphic object.
|
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.
IlBoolean IlvStudio::isBad | ( | ) | const |
Tests if the initialization was successful.
IlFalse
if the initialization was a success, or IlTrue
if a problem occurred.
|
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.
IlvStOptions& IlvStudio::options | ( | ) |
Returns the options.
|
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.
name | The callback name. |
callback | The callback function. |
void IlvStudio::registerCommand | ( | const char * | name, |
IlvStCommandConstructor | cmd | ||
) |
Registers a command.
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.
name | The 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.