makVrf::DtDesignerEditor Class Reference

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.

Inheritance diagram for makVrf::DtDesignerEditor:

Public Member Functions
	DtDesignerEditor (makVrv::DtDe &)
virtual	~DtDesignerEditor ()
virtual bool	editUi (const std::string &scriptId, const std::string &uiLayout, const std::string &defaultUi="", bool adding=false)
Public Member Functions inherited from makVrf::DtScriptEditor
	DtScriptEditor (makVrv::DtDe &, const std::string &tmpDir="scripts")
virtual	~DtScriptEditor ()
virtual void	edit (const std::string &, int scriptType, const std::string &commentBlock="")
virtual void	editNew (const std::string &id, int sType, const std::string &script, const std::string &scriptEngine, const std::string &commentBlock="")
virtual void	view (const std::string &)
virtual void	closeEditorFor (const std::string &)
virtual bool	alreadyEditing (const std::string &id) const
virtual void	editExternalScript (const std::string &filename)
virtual bool	hasScriptFor (const std::string &) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtDesignerEditor &	instance (makVrv::DtDe &)
static void	registerInstance (makVrv::DtDe &, DtDesignerEditor *)
Static Public Member Functions inherited from makVrf::DtScriptEditor
static DtScriptEditor &	instance (makVrv::DtDe &de)
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
boost::signals2::signal< void(const std::string &)>	signal_editingComplete

Protected Member Functions
virtual void	receivedScript (DtSimMessage *msg)
virtual void	scriptBeingRemoved ()
virtual void	editLayout (const std::string &scriptId, const std::string &uiLayout, bool readOnly=false, bool adding=false)
virtual void	checkNeedsUpdate (const std::string &file)
Protected Member Functions inherited from makVrf::DtScriptEditor
virtual void	slot_scriptSaveError (std::string scriptId)
virtual void	slot_aboutToClearScriptedTasks ()
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="")
virtual void	tick ()
virtual void	slot_scriptedTaskAdded (std::string)
virtual void	editingComplete (QProcess *)
virtual bool	checkForScriptErrors (const DtScriptedTaskMetaData &) const
virtual std::string	cleanUpError (const std::string &) const
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::DtDe &	myDe
std::map< DtU32, PendingRequest >	myPendingRequests
FileInfoMap	myFileInfoMap
makVrv::DtSignalConnectionManager	myConnections
DtFilename	myTempDirectory
std::set< std::string >	myHasScriptFor

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfGuiCoreQt/designerEditor.h