This class manages scripted tasks and allows for drag/drop of task for folder manipulation. More...

Inheritance diagram for makVrf::DtScriptedTaskTreeWidget:

Public Types
typedef std::map < QTreeWidgetItem , QTreeWidgetItem >	ScriptedTaskItem
typedef std::map< std::string, ScriptedTaskItem >	ScriptedTaskItems

Public Member Functions
	DtScriptedTaskTreeWidget (makVrv::DtDe &de, QWidget *parent)
	CTOR.
virtual	~DtScriptedTaskTreeWidget ()
	DTOR.
virtual bool	selectedScriptIsSystemScript () const
	Returns true if the selected script is a system script.
virtual bool	selectedItemIsFolder () const
	Returns true if the selected item is a folder.
virtual bool	itemIsFolder (QTreeWidgetItem *) const
	Returns true if the item is a folder.
virtual bool	allSelectedItemsAreScripts () const
	Returns true if all the selected items are scripts.
virtual QString	getFolderName (QTreeWidgetItem *, const QString &current="")
	Returns a folder name that is unique for the given root, or an empty name if none given.
virtual QTreeWidgetItem *	addFolder (QTreeWidgetItem *root, const QString &, bool select=true)
	Adds a folder to the particular root.
virtual bool	systemScriptsInFolder (QTreeWidgetItem *) const
	Returns true if there are any system scripts in the given folder or sub-folders.
virtual bool	selectedItemCanEditScript () const
	Returns true if the selected item can edit a script.
virtual QTreeWidgetItem *	findScriptItem (const QString &scriptId)
	Returns the item that represents the script or NULL.
virtual QTreeWidgetItem *	findFolder (const QString &path, QTreeWidgetItem *root=0)
	Returns the folder that is the item at the end of the path.
virtual void	setFolderPaths (QTreeWidgetItem *)
	Sets the folder path for all items (except system scripts) in this folder and sub-folders.
virtual std::string	folderPathToItem (QTreeWidgetItem *) const
	Returns the folder path to the given item.
virtual std::string	folderPathToSelectedItem () const
	Returns the folder path to the currently selected item.
virtual std::vector< std::string >	scriptIdsInFolder (QTreeWidgetItem *) const
	Returns a vector of all the script ids in the folder recursively.
virtual std::set< std::string >	selectedScriptIds () const
	Returns the currently selected script ids. If the selected item is a folder returnsall script ids in that folder.
virtual QSize	sizeHint (QTreeWidgetItem *) const
	Returns the size hint of the item, inclusive of icon and leveling.
const ScriptedTaskItems &	scriptedTaskItems () const
virtual void	updateFrameRates (DtSimMessage *)
	Called to update with frame rates message.
virtual QTreeWidgetItem *	addScriptedTask (const std::string &, QTreeWidgetItem *root=0, bool addToFolder=true)
	Adds a new scripted task into the tree widget.
virtual bool	removeScriptedTask (const std::string &)
	Removes a scripted task. Returns true if removed.
virtual void	scriptModified (const std::string &, bool)
	Called when a script is modified.
virtual void	clear ()
	Clears out all items.
virtual void	setEditable (bool b)
	Sets whether or not items in the dialog are editable.
virtual bool	editable () const
virtual void	scriptModifiedCleared ()
	Called when all script modified status has been cleared.
virtual void	scriptErrorStatusChanged (const std::string &)
	Called to update the script error status.

virtual void	filterByScriptEngine (const std::set< std::string > &showEngines)
virtual bool	filterByScriptEngine (QTreeWidgetItem *, const std::set< std::string > &showEngines)
Public Member Functions inherited from makVrf::DtTreeWidget
	DtTreeWidget (QWidget *parent)
	Constructor.
virtual	~DtTreeWidget ()
	DTOR.
virtual QTreeWidgetItem *	lastItem () const
	Returns the last item in the list.
QTreeWidgetItem *	itemFromIndex (const QModelIndex &idx)
QModelIndex	indexFromItem (QTreeWidgetItem *item, int column=0) const
virtual int	indexOfChild (QTreeWidgetItem *) const
	Returns the index of the child.
unsigned int	depth (QTreeWidgetItem *) const
	Returns the number of levels down this item is.
QTreeWidgetItem *	nextSibling (QTreeWidgetItem *) const
	Returns the next item after the supplied item.
void	setAllowEmptySelection (bool)
	Only valid in single selection mode.
bool	allowEmptySelection () const

Public Attributes
boost::signal< void()>	signal_deleteRequested

Protected Member Functions
virtual QMimeData *	mimeData (const QList< QTreeWidgetItem * > list) const
	Returns the mime data of the items that are selected for dragging.
virtual void	dragEnterEvent (QDragEnterEvent *event)
	Called when the mime data enters this area, return true if data can be decoded.
virtual void	dragMoveEvent (QDragMoveEvent *event)
	Accept event if the dragged items can be dropped on the tree widget item they are over.
virtual void	dropItems (const QStringList &, QTreeWidgetItem *)
	Drop the items on the supplied tree widget item.
virtual bool	dropMimeData (QTreeWidgetItem parent, int index, const QMimeData mimeData, Qt::DropAction action)
	Return true if data can be dropped.
virtual void	keyPressEvent (QKeyEvent *)
	Override for delete key press.
virtual void	statusUpdate (QTreeWidgetItem *item, const std::string &scriptId)
	Given an item and script id, update font, color, changed status on the scripted task item.
virtual QIcon	composeIcon (const DtScriptedTaskMetaData &) const
	Given a meta data, compose an icon that will represent it's script type and whether or not it is a system script.
Protected Member Functions inherited from makVrf::DtTreeWidget
virtual void	mousePressEvent (QMouseEvent *event)
virtual void	mouseReleaseEvent (QMouseEvent *event)
virtual void	scrollContentsBy (int, int)
virtual QSize	sizeHint () const
	Need to do this as default sizeHint() for an abstract scroll area (in Qt 4.2.2) is too large.
virtual QItemSelectionModel::SelectionFlags	selectionCommand (const QModelIndex &index, const QEvent *event=0) const
	Override to allow empty selection in single selection mode.
virtual QItemSelectionModel::SelectionFlags	selectionBehaviorFlags () const

Protected Attributes
makVrv::DtDe &	myDe
bool	myEditable
ScriptedTaskItems	myScriptedTaskItems
Protected Attributes inherited from makVrf::DtTreeWidget
bool	myMouseRightClick
bool	myAllowEmptySelection

Additional Inherited Members
Signals inherited from makVrf::DtTreeWidget
void	mouseLeftPressed (QTreeWidgetItem , QMouseEvent , int col)
	Emitted when the mouse button is pressed.
void	rightClickOnItem (QTreeWidgetItem , QMouseEvent , int col)
	Emitted when right button is released.
void	contentsMoving (int, int)

Detailed Description

This class manages scripted tasks and allows for drag/drop of task for folder manipulation.

Member Typedef Documentation

typedef std::map<QTreeWidgetItem*, QTreeWidgetItem*> makVrf::DtScriptedTaskTreeWidget::ScriptedTaskItem

typedef std::map<std::string, ScriptedTaskItem> makVrf::DtScriptedTaskTreeWidget::ScriptedTaskItems

Constructor & Destructor Documentation

makVrf::DtScriptedTaskTreeWidget::DtScriptedTaskTreeWidget	(	makVrv::DtDe &	de,
		QWidget *	parent
	)

CTOR.

virtual makVrf::DtScriptedTaskTreeWidget::~DtScriptedTaskTreeWidget ( )

virtual

DTOR.

Member Function Documentation

virtual bool makVrf::DtScriptedTaskTreeWidget::selectedScriptIsSystemScript ( ) const

virtual

Returns true if the selected script is a system script.

virtual bool makVrf::DtScriptedTaskTreeWidget::selectedItemIsFolder ( ) const

virtual

Returns true if the selected item is a folder.

virtual bool makVrf::DtScriptedTaskTreeWidget::itemIsFolder ( QTreeWidgetItem * ) const

virtual

Returns true if the item is a folder.

virtual bool makVrf::DtScriptedTaskTreeWidget::allSelectedItemsAreScripts ( ) const

virtual

Returns true if all the selected items are scripts.

virtual QString makVrf::DtScriptedTaskTreeWidget::getFolderName	(	QTreeWidgetItem *	,
		const QString &	current = `""`
	)

virtual

Returns a folder name that is unique for the given root, or an empty name if none given.

virtual QTreeWidgetItem* makVrf::DtScriptedTaskTreeWidget::addFolder	(	QTreeWidgetItem *	root,
		const QString &	,
		bool	select = `true`
	)

virtual

Adds a folder to the particular root.

virtual bool makVrf::DtScriptedTaskTreeWidget::systemScriptsInFolder ( QTreeWidgetItem * ) const

virtual

Returns true if there are any system scripts in the given folder or sub-folders.

virtual bool makVrf::DtScriptedTaskTreeWidget::selectedItemCanEditScript ( ) const

virtual

Returns true if the selected item can edit a script.

virtual QTreeWidgetItem* makVrf::DtScriptedTaskTreeWidget::findScriptItem ( const QString & scriptId )

virtual

Returns the item that represents the script or NULL.

virtual QTreeWidgetItem* makVrf::DtScriptedTaskTreeWidget::findFolder	(	const QString &	path,
		QTreeWidgetItem *	root = `0`
	)

virtual

Returns the folder that is the item at the end of the path.

If root is 0, invisibleRootItem is used

virtual void makVrf::DtScriptedTaskTreeWidget::setFolderPaths ( QTreeWidgetItem * )

virtual

Sets the folder path for all items (except system scripts) in this folder and sub-folders.

virtual std::string makVrf::DtScriptedTaskTreeWidget::folderPathToItem ( QTreeWidgetItem * ) const

virtual

Returns the folder path to the given item.

If the item is a folder will include that item in the path

virtual std::string makVrf::DtScriptedTaskTreeWidget::folderPathToSelectedItem ( ) const

virtual

Returns the folder path to the currently selected item.

virtual std::vector<std::string> makVrf::DtScriptedTaskTreeWidget::scriptIdsInFolder ( QTreeWidgetItem * ) const

virtual

Returns a vector of all the script ids in the folder recursively.

virtual std::set<std::string> makVrf::DtScriptedTaskTreeWidget::selectedScriptIds ( ) const

virtual

Returns the currently selected script ids. If the selected item is a folder returnsall script ids in that folder.

virtual QSize makVrf::DtScriptedTaskTreeWidget::sizeHint ( QTreeWidgetItem * ) const

virtual

Returns the size hint of the item, inclusive of icon and leveling.

const ScriptedTaskItems& makVrf::DtScriptedTaskTreeWidget::scriptedTaskItems ( ) const

inline

virtual void makVrf::DtScriptedTaskTreeWidget::updateFrameRates ( DtSimMessage * )

virtual

Called to update with frame rates message.

virtual QTreeWidgetItem* makVrf::DtScriptedTaskTreeWidget::addScriptedTask	(	const std::string &	,
		QTreeWidgetItem *	root = `0`,
		bool	addToFolder = `true`
	)

virtual

Adds a new scripted task into the tree widget.

virtual bool makVrf::DtScriptedTaskTreeWidget::removeScriptedTask ( const std::string & )

virtual

Removes a scripted task. Returns true if removed.

virtual void makVrf::DtScriptedTaskTreeWidget::scriptModified	(	const std::string &	,
		bool
	)

virtual

Called when a script is modified.

Reimplemented in makVrf::DtDoctrinesTreeWidget.

virtual void makVrf::DtScriptedTaskTreeWidget::clear ( )

virtual

Clears out all items.

virtual void makVrf::DtScriptedTaskTreeWidget::setEditable ( bool b )

virtual

Sets whether or not items in the dialog are editable.

virtual bool makVrf::DtScriptedTaskTreeWidget::editable ( ) const

virtual

virtual void makVrf::DtScriptedTaskTreeWidget::scriptModifiedCleared ( )

virtual

Called when all script modified status has been cleared.

virtual void makVrf::DtScriptedTaskTreeWidget::scriptErrorStatusChanged ( const std::string & )

virtual

Called to update the script error status.

virtual void makVrf::DtScriptedTaskTreeWidget::filterByScriptEngine ( const std::set< std::string > & showEngines )

virtual

Filters by script engine. At this point showing Lua or Lua and C++

virtual bool makVrf::DtScriptedTaskTreeWidget::filterByScriptEngine	(	QTreeWidgetItem *	,
		const std::set< std::string > &	showEngines
	)

virtual

Filters by script engine. At this point showing Lua or Lua and C++

virtual QMimeData* makVrf::DtScriptedTaskTreeWidget::mimeData ( const QList< QTreeWidgetItem * > list ) const

protectedvirtual

Returns the mime data of the items that are selected for dragging.

Reimplemented in makVrf::DtDoctrinesTreeWidget.

virtual void makVrf::DtScriptedTaskTreeWidget::dragEnterEvent ( QDragEnterEvent * event )

protectedvirtual

Called when the mime data enters this area, return true if data can be decoded.

Reimplemented in makVrf::DtDoctrinesTreeWidget, and makVrf::DtDoctrinesScriptedTaskTreeWidget.

virtual void makVrf::DtScriptedTaskTreeWidget::dragMoveEvent ( QDragMoveEvent * event )

protectedvirtual

Accept event if the dragged items can be dropped on the tree widget item they are over.

Reimplemented in makVrf::DtDoctrinesTreeWidget, and makVrf::DtDoctrinesScriptedTaskTreeWidget.

virtual void makVrf::DtScriptedTaskTreeWidget::dropItems	(	const QStringList &	,
		QTreeWidgetItem *
	)

protectedvirtual

Drop the items on the supplied tree widget item.

virtual bool makVrf::DtScriptedTaskTreeWidget::dropMimeData	(	QTreeWidgetItem *	parent,
		int	index,
		const QMimeData *	mimeData,
		Qt::DropAction	action
	)

protectedvirtual

Return true if data can be dropped.

Reimplemented in makVrf::DtDoctrinesTreeWidget, and makVrf::DtDoctrinesScriptedTaskTreeWidget.

virtual void makVrf::DtScriptedTaskTreeWidget::keyPressEvent ( QKeyEvent * )

protectedvirtual

Override for delete key press.

virtual void makVrf::DtScriptedTaskTreeWidget::statusUpdate	(	QTreeWidgetItem *	item,
		const std::string &	scriptId
	)

protectedvirtual

Given an item and script id, update font, color, changed status on the scripted task item.

virtual QIcon makVrf::DtScriptedTaskTreeWidget::composeIcon ( const DtScriptedTaskMetaData & ) const

protectedvirtual

Given a meta data, compose an icon that will represent it's script type and whether or not it is a system script.

Member Data Documentation

boost::signal<void ()> makVrf::DtScriptedTaskTreeWidget::signal_deleteRequested

makVrv::DtDe& makVrf::DtScriptedTaskTreeWidget::myDe

protected

bool makVrf::DtScriptedTaskTreeWidget::myEditable

protected

ScriptedTaskItems makVrf::DtScriptedTaskTreeWidget::myScriptedTaskItems

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfGuiCoreQt/scriptedTasksMetaDataDialog.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation