Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

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

Editing mode class. More...

#include <ivstudio/mode.h>

Public Member Functions

void add (IlvStMode *mode)
 Adds a new editing mode. More...
 
IlvStModeget (const char *name) const
 Returns an editing mode from its name. More...
 
IlvStModegetCurrent () const
 Returns the current editing mode. More...
 
void setCurrent (IlvStMode *mode)
 Sets the current editing mode. More...
 
void setCurrent (const char *name)
 Sets the current editing mode. More...
 

Detailed Description

Editing mode class.

Library: ivstudio

Rogue Wave Views Studio has an instance of the IlvStModes class to manage the editing modes.

See also
IlvStudio,IlvStMode.

Member Function Documentation

§ add()

void IlvStModes::add ( IlvStMode mode)

Adds a new editing mode.

Adds the new editing mode to the list of modes.

Parameters
modeThe new editing mode.

§ get()

IlvStMode* IlvStModes::get ( const char *  name) const

Returns an editing mode from its name.

Parameters
nameThe name of the editing mode.
Returns
The editing mode from its name.

§ getCurrent()

IlvStMode* IlvStModes::getCurrent ( ) const

Returns the current editing mode.

Returns
The current editing mode.

§ setCurrent() [1/2]

void IlvStModes::setCurrent ( IlvStMode mode)

Sets the current editing mode.

Parameters
modeThe new current editing mode.

§ setCurrent() [2/2]

void IlvStModes::setCurrent ( const char *  name)

Sets the current editing mode.

Parameters
nameThe name of the new current editing mode.

© Copyright 2017, 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.