VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions
makVrf::DtDesignerEditor Class Reference

This class will edit a temporary .ui file associated with the given script. More...

Inheritance diagram for makVrf::DtDesignerEditor:
Inheritance graph
[legend]

Public Member Functions

 DtDesignerEditor (makVrv::DtDe &)
 CTOR. More...
 
virtual ~DtDesignerEditor ()
 DTOR. More...
 
virtual bool editUi (const std::string &scriptId, const std::string &uiLayout, const std::string &defaultUi="", bool adding=false)
 Saves the ui layout string to a temporary file in the temp directory and edits it via designer. More...
 
- Public Member Functions inherited from makVrf::DtScriptEditor
 DtScriptEditor (makVrv::DtDe &, const std::string &tmpDir="scripts")
 CTOR. More...
 
virtual ~DtScriptEditor ()
 DTOR. More...
 
virtual void edit (const std::string &, int scriptType, const std::string &commentBlock="")
 Request the script for the given task and start editing. More...
 
virtual void editNew (const std::string &id, int sType, const std::string &script, const std::string &scriptEngine, const std::string &commentBlock="")
 Edits a new script file without requesting information from the back-end for the current script. More...
 
virtual void view (const std::string &)
 Request the script for view only access. More...
 
virtual void closeEditorFor (const std::string &)
 If editing, closes the editor for the specified script. More...
 
virtual bool alreadyEditing (const std::string &id) const
 Returns true if already editing script. More...
 
virtual void editExternalScript (const std::string &filename)
 Edits an external script as local only. More...
 
virtual bool hasScriptFor (const std::string &) const
 Returns true if there was at least one time there was a script for this script id. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Static Public Member Functions

static DtDesignerEditorinstance (makVrv::DtDe &)
 Instance of this class if not registered. More...
 
static void registerInstance (makVrv::DtDe &, DtDesignerEditor *)
 Registers a new instance of the creator. More...
 
- Static Public Member Functions inherited from makVrf::DtScriptEditor
static DtScriptEditorinstance (makVrv::DtDe &de)
 Returns instance of the manager. More...
 
static void registerInstance (makVrv::DtDe &, DtScriptEditor *)
 

Public Attributes

boost::signals2::signal< void(const
std::string &, const
std::string &, const
std::vector
< DtScriptedTaskVariable > &)> 
signal_layoutModified
 
- Public Attributes inherited from makVrf::DtScriptEditor
boost::signals2::signal< void(const
std::string &, const
std::string &)> 
signal_scriptModified
 Signals sent when scripts are changed or an editor closed. More...
 
boost::signals2::signal< void(const
std::string &)> 
signal_editingComplete
 

Protected Member Functions

virtual void receivedScript (DtSimMessage *msg)
 Received when script is received. More...
 
virtual void scriptBeingRemoved ()
 Called when a script is removed, put up a dialog announcing why editor is being closed. More...
 
virtual void editLayout (const std::string &scriptId, const std::string &uiLayout, bool readOnly=false, bool adding=false)
 
virtual void checkNeedsUpdate (const std::string &file)
 Checks to see if this file has been updated since last time. More...
 
- Protected Member Functions inherited from makVrf::DtScriptEditor
virtual void slot_scriptSaveError (std::string scriptId)
 
virtual void slot_aboutToClearScriptedTasks ()
 Called when a script is removed, stop editing the script in question. More...
 
virtual void slot_scriptedTaskAboutToBeRemoved (std::string scriptId)
 
virtual void editScript (const std::string &id, int sType, const std::string &script, const std::string &scriptEngine="lua", bool readOnly=false, bool localOnly=false, bool scriptIsFilename=false, const std::string &commentBlock="")
 Starts the editing of the specified script. More...
 
virtual void tick ()
 Check last modified dates of files to see if they have changed. If they have update the server. More...
 
virtual void slot_scriptedTaskAdded (std::string)
 Called when a script is added, see if the script has changed from scenario to system script. More...
 
virtual void editingComplete (QProcess *)
 Call to complete editing on the given process. More...
 
virtual bool checkForScriptErrors (const DtScriptedTaskMetaData &) const
 Checks for syntax errors in script. More...
 
virtual std::string cleanUpError (const std::string &) const
 Cleans up error to remove some information that might not be meaningful to users. More...
 
virtual void exitingApplication ()
 

Additional Inherited Members

- Protected Types inherited from makVrf::DtScriptEditor
typedef std::map< std::string,
FileInfo
FileInfoMap
 
- Protected Slots inherited from makVrf::DtScriptEditor
virtual void editingComplete (int, QProcess::ExitStatus)
 
virtual void startupError (QProcess::ProcessError)
 
- Protected Attributes inherited from makVrf::DtScriptEditor
makVrv::DtDemyDe
 
std::map< DtU32, PendingRequestmyPendingRequests
 
FileInfoMap myFileInfoMap
 
makVrv::DtSignalConnectionManager myConnections
 
DtFilename myTempDirectory
 
std::set< std::string > myHasScriptFor
 

Detailed Description

This class will edit a temporary .ui file associated with the given script.

When the ui file is saved a signal will be sent notifying the user of this class

Constructor & Destructor Documentation

makVrf::DtDesignerEditor::DtDesignerEditor ( makVrv::DtDe )

CTOR.

virtual makVrf::DtDesignerEditor::~DtDesignerEditor ( )
virtual

DTOR.

Member Function Documentation

virtual bool makVrf::DtDesignerEditor::editUi ( const std::string &  scriptId,
const std::string &  uiLayout,
const std::string &  defaultUi = "",
bool  adding = false 
)
virtual

Saves the ui layout string to a temporary file in the temp directory and edits it via designer.

Each time the modification date on this file is changed it will be read from disk and the signal_uiLayoutSaved signal sent. If there is no ui, and, after the request, there is still no ui, use the default

static DtDesignerEditor& makVrf::DtDesignerEditor::instance ( makVrv::DtDe )
static

Instance of this class if not registered.

static void makVrf::DtDesignerEditor::registerInstance ( makVrv::DtDe ,
DtDesignerEditor  
)
static

Registers a new instance of the creator.

virtual void makVrf::DtDesignerEditor::receivedScript ( DtSimMessage )
protectedvirtual

Received when script is received.

Reimplemented from makVrf::DtScriptEditor.

virtual void makVrf::DtDesignerEditor::scriptBeingRemoved ( )
protectedvirtual

Called when a script is removed, put up a dialog announcing why editor is being closed.

Reimplemented from makVrf::DtScriptEditor.

virtual void makVrf::DtDesignerEditor::editLayout ( const std::string &  scriptId,
const std::string &  uiLayout,
bool  readOnly = false,
bool  adding = false 
)
protectedvirtual
virtual void makVrf::DtDesignerEditor::checkNeedsUpdate ( const std::string &  filename)
protectedvirtual

Checks to see if this file has been updated since last time.

If so sends the script update message to the server

Reimplemented from makVrf::DtScriptEditor.

Member Data Documentation

boost::signals2::signal<void (const std::string&, const std::string&, const std::vector<DtScriptedTaskVariable>&)> makVrf::DtDesignerEditor::signal_layoutModified

The documentation for this class was generated from the following file:

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)