winIDEA SDK
isys::CTerminalDocController Class Reference

Description

This class handles terminal window as a document.

#include <CDocumentController.h>

Inheritance diagram for isys::CTerminalDocController:
isys::CDocumentController

Public Member Functions

void close ()
 Closes the terminal window. More...
 
 CTerminalDocController (std::shared_ptr< ConnectionMgr > connectionMgr)
 Opens a terminal window. More...
 
void reset ()
 Clears history buffer. More...
 
void saveAs (const std::string &fileName)
 Saves contents of the terminal window to file. More...
 
void start ()
 Starts communication in the terminal window. More...
 
void stop ()
 Stops communication in the terminal window. More...
 

Private Member Functions

void reset (IConnectIDE::EDocumentResetParameter resetScope)
 Resets contents of the document. More...
 
void saveAs (const std::string &fileName, bool isForceOverwrite=false)
 Saves the document with a new name. More...
 

Constructor & Destructor Documentation

◆ CTerminalDocController()

isys::CTerminalDocController::CTerminalDocController ( std::shared_ptr< ConnectionMgr connectionMgr)

Opens a terminal window.

Parameters
connectionMgrclass which maintains connection to winIDEA. Connection must be established before this call.
Exceptions
IOExceptionin case of an error.

Member Function Documentation

◆ close()

void isys::CTerminalDocController::close ( )

Closes the terminal window.

Exceptions
IOExceptionin case of an error.

◆ reset()

void isys::CTerminalDocController::reset ( )

Clears history buffer.

Exceptions
IOExceptionin case of an error.

◆ saveAs()

void isys::CTerminalDocController::saveAs ( const std::string &  fileName)

Saves contents of the terminal window to file.

Parameters
fileNamename of the destination file
Exceptions
IOExceptionin case of an error.

◆ start()

void isys::CTerminalDocController::start ( )

Starts communication in the terminal window.

Exceptions
IOExceptionin case of an error.

◆ stop()

void isys::CTerminalDocController::stop ( )

Stops communication in the terminal window.

Exceptions
IOExceptionin case of an error.