Itasca C++ Interface
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
ikernelinput.h
1 #pragma once
2 
3 namespace itasca {
4  class IGUIInput;
5  class ITextInput;
6 
15  class IKernelInput {
16  public:
18  virtual ITextInput *getITextInput()=0;
19 
20  // Kernel specific more detailed input
22  virtual Qt::Key getKey()=0;
29  virtual uint prompt(const QString &message,const QString &options,const QString &keys,uint ok,uint cancel)=0;
31  virtual QString getUIName() const=0;
33  virtual bool autoTestMode() const=0;
35  virtual QString getHelpFileFrontPage() const=0;
37  virtual QString getDocDirectory() const=0;
39  virtual QString getLatestRevisionAddress() const=0;
40 
41  // Interrupt functions
43  virtual void poll(bool suppressException=false,bool skipTimingTest=false)=0;
46  virtual bool hasBeenInterrupted()=0;
49  virtual bool hasBeenSafeInterrupted()=0;
50 
53  virtual IGUIInput *getIGUIInput()=0;
54 
55  // Undo support
58  virtual void getUndoConnect(QObject **obj,const char **undoAvailSignal,const char **playbackStartSignal)=0;
60  //virtual bool getUndoStartMark()=0;
61 
63  virtual QString getProjectPath() const = 0;
64 
65  virtual bool acceptRedirect() const=0;
66  virtual void setRedirectInput(IKernelInput * ki)=0;
67  };
68 } // /namespace itasca
69 // EOF
virtual bool hasBeenSafeInterrupted()=0
virtual QString getProjectPath() const =0
Returns TRUE if the last string input from ITextInput::getInput() was marked as the start of an undo ...
namespace Itasca
Definition: basememory.cpp:9
virtual QString getLatestRevisionAddress() const =0
Returns the name of the revision history page in the help file.
virtual void poll(bool suppressException=false, bool skipTimingTest=false)=0
Allows GUI to interrupt if necessary. Quit exception if suppressExeption is false.
virtual uint prompt(const QString &message, const QString &options, const QString &keys, uint ok, uint cancel)=0
Interface describing ALL input support the kernel needs to receive from whatever interface is driving...
Definition: ikernelinput.h:15
virtual Qt::Key getKey()=0
Returns a key. This function blocks, and it may throw a 'quit' exception.
virtual QString getHelpFileFrontPage() const =0
Returns the name of the front page of the help file.
virtual IGUIInput * getIGUIInput()=0
virtual ITextInput * getITextInput()=0
Returns a pointer to ITextInput, the standard default text input.
The interface to graphics user interface input functionality.
Definition: iguiinput.h:8
Definition: itextinput.h:40
virtual bool autoTestMode() const =0
Returns true if system is in test mode. This functions does not throw exceptions.
virtual bool hasBeenInterrupted()=0
virtual void getUndoConnect(QObject **obj, const char **undoAvailSignal, const char **playbackStartSignal)=0
virtual QString getUIName() const =0
Returns the name of the UI input device, e.g. "FLAC3D Console". This functions does not throw excepti...
virtual QString getDocDirectory() const =0
Returns the name of the directory of the doc files which could be code dependent.