SessionInfo Struct Reference
Public Member Functions | |
| bool | isPopup () const |
| Determine if this page is a popup window. | |
| SessionInfo () | |
Public Attributes | |
| std::string | commandLine_ |
| Text sent to the script in this invocation as its command line. The script will be re-invoked with this same command line when user presses q to get out of sub-pages. | |
| std::map< std::string, std::string > | options_ |
| the script sends us options and we send them back | |
| std::vector< std::pair< size_t, size_t > > | returnedCells_ |
| returnedCells_ is a vector of table cell indices (row,col). | |
| CursorInfo | startCursorPosition_ |
Detailed Description
Definition at line 80 of file scripttableviewer.h.
Constructor & Destructor Documentation
| SessionInfo | ( | ) |
Definition at line 130 of file scripttableviewer.h.
Member Function Documentation
| bool isPopup | ( | ) | const |
Determine if this page is a popup window.
- Returns:
- true if it is.
Definition at line 135 of file scripttableviewer.h.
Member Data Documentation
| std::string commandLine_ |
Text sent to the script in this invocation as its command line. The script will be re-invoked with this same command line when user presses q to get out of sub-pages.
Definition at line 87 of file scripttableviewer.h.
| std::map<std::string,std::string> options_ |
the script sends us options and we send them back
Definition at line 83 of file scripttableviewer.h.
| std::vector< std::pair<size_t, size_t> > returnedCells_ |
returnedCells_ is a vector of table cell indices (row,col).
If this vector is not empty, it means that the script page we are displaying is a "pop up style" page, not a normal "edit" style page. Popup style pages have the property that when they exit, the returnedCells are converted into command line parameters and are send back to the page from which this popup was derived as options whose names are of the following form:
--CELL_VALUE_<row>_<col>="\<cell contents\>"
There are no leading zeros.
Also, if a session is a popup, there are only two kinds of commands that can be executed:
- Escape
- Enter
Escape can be done using any of the following key sequences:
- Esc
- ^X^K
- ^XK
The ScriptTableViewer::populateTable() function detects popups when it sees a header variable declaration like this:
--POPUPRETURN= (<row1>,<col1>) (<row2>,<col2>), ...
Definition at line 94 of file scripttableviewer.h.
| CursorInfo startCursorPosition_ |
Definition at line 85 of file scripttableviewer.h.
The documentation for this struct was generated from the following file:
- include/cxxtls/scripttableviewer.h
