Tree view that allows drag & drop of document objects. More...

#include <Tree.h>

Classes
struct SelInfo

Public Member Functions
bool eventFilter (QObject , QEvent ev) override

void expandSelectedItems (TreeItemMode mode)

DocumentItem * getDocumentItem (const Gui::Document *) const

const char * getTreeName () const

void itemSearch (const QString &text, bool select)

void markItem (const App::DocumentObject *Obj, bool mark)

void resetItemSearch ()

virtual void selectAll () override

void selectAllInstances (const ViewProviderDocumentObject &vpd)

void selectAllLinks (App::DocumentObject *obj)

void selectLinkedObject (App::DocumentObject *linked)

void startDragging ()

void startItemSearch (QLineEdit *)

void syncView (ViewProviderDocumentObject *vp)

TreeWidget (const char name, QWidget parent=0)

~TreeWidget ()

Public Member Functions inherited from Gui::SelectionObserver
void attachSelection ()
	Attaches to the selection. More...

bool blockConnection (bool block)

void detachSelection ()
	Detaches from the selection. More...

bool isConnectionAttached () const

bool isConnectionBlocked () const

SelectionObserver (bool attach=true, int resolve=1)
	Constructor. More...

SelectionObserver (const Gui::ViewProviderDocumentObject *vp, bool attach=true, int resolve=1)
	Constructor. More...

virtual ~SelectionObserver ()

Static Public Member Functions
static void checkTopParent (App::DocumentObject *&obj, std::string &subname)

static std::vector< SelInfo > getSelection (App::Document *doc=0)

static TreeWidget * instance ()

static bool isObjectShowable (App::DocumentObject *obj)

static void scrollItemToTop ()

static Gui::Document * selectedDocument ()

static void updateStatus (bool delay=true)

Static Public Attributes
static const int DocumentType = 1000

static const int ObjectType = 1001

Protected Member Functions
void contextMenuEvent (QContextMenuEvent *e) override

void drawRow (QPainter *, const QStyleOptionViewItem &, const QModelIndex &) const override

void onSelectionChanged (const SelectionChanges &msg) override
	Observer message from the Selection. More...

Drag and drop
class DocumentItem

class DocumentObjectItem

void startDrag (Qt::DropActions supportedActions) override

bool dropMimeData (QTreeWidgetItem parent, int index, const QMimeData data, Qt::DropAction action) override

Qt::DropActions supportedDropActions () const override

QMimeData * mimeData (const QList< QTreeWidgetItem * > items) const override

void dragEnterEvent (QDragEnterEvent *event) override

void dragLeaveEvent (QDragLeaveEvent *event) override

void dragMoveEvent (QDragMoveEvent *event) override

void dropEvent (QDropEvent *event) override

bool event (QEvent *e) override

void keyPressEvent (QKeyEvent *event) override

void mouseDoubleClickEvent (QMouseEvent *event) override

void showEvent (QShowEvent *) override

void hideEvent (QHideEvent *) override

void leaveEvent (QEvent *) override

void onCreateGroup ()

void onRelabelObject ()

void onActivateDocument (QAction *)

void onStartEditing ()

void onFinishEditing ()

void onSkipRecompute (bool on)

void onAllowPartialRecompute (bool on)

void onReloadDoc ()

void onCloseDoc ()

void onMarkRecompute ()

void onRecomputeObject ()

void onPreSelectTimer ()

void onSelectTimer ()

void onShowHidden ()

void onHideInTree ()

void onSearchObjects ()

void emitSearchObjects ()

Detailed Description

Tree view that allows drag & drop of document objects.

Author: Werner Mayer

Constructor & Destructor Documentation

◆ TreeWidget()

TreeWidget::TreeWidget	(	const char *	name,
		QWidget *	parent = `0`
	)

References Gui::BitmapFactory(), Gui::Application::Instance, onAllowPartialRecompute(), onCloseDoc(), onCreateGroup(), onFinishEditing(), onHideInTree(), onMarkRecompute(), onPreSelectTimer(), onRecomputeObject(), onRelabelObject(), onReloadDoc(), onSearchObjects(), onSelectTimer(), onShowHidden(), onSkipRecompute(), Gui::Application::signalActiveDocument, Gui::Application::signalChangedObject, Gui::Application::signalDeleteDocument, Gui::Application::signalNewDocument, Gui::Application::signalRelabelDocument, Gui::Application::signalRenameDocument, and Gui::Application::signalShowHidden.

◆ ~TreeWidget()

TreeWidget::~TreeWidget ( )

Member Function Documentation

◆ checkTopParent()

void TreeWidget::checkTopParent	(	App::DocumentObject *&	obj,
		std::string &	subname
	)

static

References Gui::Application::Instance.

Referenced by Gui::SelectionSingleton::checkSelection().

◆ contextMenuEvent()

void TreeWidget::contextMenuEvent ( QContextMenuEvent * e )

overrideprotected

References App::Document::AllowPartialRecompute, Gui::Workbench::createLinkMenu(), Gui::DocumentItem::document(), DocumentType, App::Application::getActiveDocument(), App::GetApplication(), Base::Persistence::getClassTypeId(), App::DocumentObject::getDocument(), Gui::Document::getDocument(), App::Application::getDocuments(), Gui::MenuManager::getInstance(), Gui::ViewProviderDocumentObject::getObject(), Gui::Application::Instance, Base::BaseClass::isDerivedFrom(), Gui::ViewProvider::isEditing(), Gui::DocumentObjectItem::object(), ObjectType, onActivateDocument(), onStartEditing(), App::Document::PartialDoc, App::Application::setActiveDocument(), Gui::MenuManager::setupContextMenu(), Gui::Application::setupContextMenu(), Gui::ViewProvider::setupContextMenu(), Gui::DocumentItem::showHidden(), Gui::ViewProviderDocumentObject::showInTree(), and App::Document::SkipRecompute.

◆ dragEnterEvent()

void TreeWidget::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

◆ dragLeaveEvent()

void TreeWidget::dragLeaveEvent ( QDragLeaveEvent * event )

overrideprotected

◆ dragMoveEvent()

void TreeWidget::dragMoveEvent ( QDragMoveEvent * event )

overrideprotected

References Gui::ViewProvider::canDragAndDropObject(), Gui::ViewProviderDocumentObject::canDropObjectEx(), Gui::ViewProvider::canDropObjects(), DocumentType, Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::getParentItem(), leaveEvent(), Gui::DocumentObjectItem::object(), and ObjectType.

◆ drawRow()

void TreeWidget::drawRow	(	QPainter *	painter,
		const QStyleOptionViewItem &	options,
		const QModelIndex &	index
	)		const

overrideprotected

◆ dropEvent()

void TreeWidget::dropEvent ( QDropEvent * event )

overrideprotected

References Gui::SelectionSingleton::addSelection(), Gui::MacroManager::App, Gui::Command::App, Gui::ViewProvider::canDragAndDropObject(), Gui::ViewProviderDocumentObject::canDropObjectEx(), Gui::ViewProvider::canDropObjects(), Gui::SelectionSingleton::clearCompleteSelection(), App::AutoTransaction::close(), App::Document::copyObject(), Gui::DocumentItem::document(), DocumentType, Gui::ViewProvider::dragObject(), Gui::ViewProvider::dropObjectEx(), App::GetApplication(), App::Application::getDocument(), App::DocumentObject::getDocument(), Gui::Application::getDocument(), Gui::Document::getDocument(), App::ExtensionContainer::getExtensionByType(), App::GeoFeatureGroupExtension::getGroupOfObject(), Gui::getMainWindow(), App::Document::getName(), App::DocumentObject::getNameInDocument(), Gui::ViewProviderDocumentObject::getObject(), App::Document::getObject(), Gui::Command::getObjectCmd(), Gui::DocumentObjectItem::getOwnerDocument(), Gui::DocumentObjectItem::getParentItem(), Gui::DocumentObjectItem::getSubName(), App::Document::getUniqueObjectName(), App::PropertyPlacement::getValue(), Gui::Application::getViewProvider(), Gui::MacroManager::Gui, Gui::Application::Instance, Gui::TreeParams::Instance(), Base::Placement::inverse(), Base::Matrix4D::inverseGauss(), Gui::DocumentObjectItem::isGroup(), Gui::Application::macroManager(), App::Document::moveObject(), Gui::DocumentObjectItem::object(), ObjectType, App::Document::recompute(), Gui::Selection(), Gui::SelectionSingleton::selStackPush(), Gui::Document::setActiveView(), Gui::SelectionSingleton::setSelection(), App::PropertyPlacement::setValueIfChanged(), and Base::Placement::toMatrix().

◆ dropMimeData()

bool TreeWidget::dropMimeData	(	QTreeWidgetItem *	parent,
		int	index,
		const QMimeData *	data,
		Qt::DropAction	action
	)

overrideprotected

◆ emitSearchObjects

void Gui::TreeWidget::emitSearchObjects ( )

signal

Referenced by onSearchObjects().

◆ event()

bool TreeWidget::event ( QEvent * e )

overrideprotected

◆ eventFilter()

bool TreeWidget::eventFilter	(	QObject *	,
		QEvent *	ev
	)

override

◆ expandSelectedItems()

void TreeWidget::expandSelectedItems ( TreeItemMode mode )

References Gui::CollapseItem, Gui::ExpandItem, Gui::ExpandPath, Gui::SelectionObserver::isConnectionAttached(), and Gui::ToggleItem.

Referenced by StdCmdTreeCollapse::activated(), and StdCmdTreeExpand::activated().

◆ getDocumentItem()

DocumentItem * TreeWidget::getDocumentItem ( const Gui::Document * doc ) const

Referenced by Gui::DocumentObjectItem::getParentDocument(), itemSearch(), and selectLinkedObject().

◆ getSelection()

std::vector< TreeWidget::SelInfo > TreeWidget::getSelection ( App::Document * doc = 0 )

static

References App::DocumentObject::getNameInDocument(), Gui::ViewProviderDocumentObject::getObject(), instance(), Gui::SelectionObserver::isConnectionAttached(), Gui::DocumentObjectItem::object(), ObjectType, and onSelectTimer().

Referenced by femguiutils.selection_widgets._Selector::setHelpText().

◆ getTreeName()

const char * TreeWidget::getTreeName ( ) const

Referenced by Gui::DocumentItem::DocumentItem().

◆ hideEvent()

void TreeWidget::hideEvent ( QHideEvent * ev )

overrideprotected

References Gui::SelectionObserver::detachSelection().

◆ instance()

TreeWidget * TreeWidget::instance ( )

static

Referenced by getSelection(), Gui::Document::RestoreDocFile(), and Gui::Document::SaveDocFile().

◆ isObjectShowable()

bool TreeWidget::isObjectShowable ( App::DocumentObject * obj )

static

References Gui::Application::getDocument(), and Gui::Application::Instance.

Referenced by Gui::ViewProviderDocumentObject::show().

◆ itemSearch()

void TreeWidget::itemSearch	(	const QString &	text,
		bool	select
	)

References Gui::SelectionSingleton::addSelection(), Gui::SelectionSingleton::clearSelection(), getDocumentItem(), Gui::Application::Instance, App::ObjectIdentifier::parse(), resetItemSearch(), Gui::Selection(), Gui::SelectionSingleton::selStackPush(), and Gui::SelectionSingleton::setPreselect().

◆ keyPressEvent()

void TreeWidget::keyPressEvent ( QKeyEvent * event )

overrideprotected

References onSearchObjects().

◆ leaveEvent()

void TreeWidget::leaveEvent ( QEvent * )

overrideprotected

References Gui::TreeParams::Instance(), Gui::SelectionSingleton::rmvPreselect(), and Gui::Selection().

Referenced by dragMoveEvent().

◆ markItem()

void Gui::TreeWidget::markItem	(	const App::DocumentObject *	Obj,
		bool	mark
	)

◆ mimeData()

QMimeData * TreeWidget::mimeData ( const QList< QTreeWidgetItem * > items ) const

overrideprotected

References Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::object(), and ObjectType.

◆ mouseDoubleClickEvent()

void TreeWidget::mouseDoubleClickEvent ( QMouseEvent * event )

overrideprotected

References Gui::DocumentItem::document(), DocumentType, Gui::ViewProvider::doubleClicked(), Gui::Application::editDocument(), Base::BaseClass::getClassTypeId(), Gui::ViewProviderDocumentObject::getObject(), Gui::Command::getObjectCmd(), Gui::DocumentObjectItem::getOwnerDocument(), Gui::MacroManager::Gui, Gui::Application::Instance, Gui::Application::macroManager(), Gui::DocumentObjectItem::object(), ObjectType, onReloadDoc(), App::Document::PartialDoc, Gui::Document::setActiveView(), and App::AutoTransaction::setEnable().

◆ onActivateDocument

void TreeWidget::onActivateDocument ( QAction * active )

protectedslot

References Base::BaseClass::getClassTypeId(), Gui::Application::getDocument(), and Gui::Application::Instance.

Referenced by contextMenuEvent().

◆ onAllowPartialRecompute

void TreeWidget::onAllowPartialRecompute ( bool on )

protectedslot

References App::Document::AllowPartialRecompute, Gui::DocumentItem::document(), DocumentType, and Gui::Document::getDocument().

Referenced by TreeWidget().

◆ onCloseDoc

void TreeWidget::onCloseDoc ( )

protectedslot

References Gui::Command::Doc, Gui::DocumentItem::document(), DocumentType, and Gui::Document::getDocument().

Referenced by TreeWidget().

◆ onCreateGroup

void TreeWidget::onCreateGroup ( )

protectedslot

References Gui::Command::App, Gui::DocumentItem::document(), DocumentType, Gui::Document::getDocument(), Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::object(), and ObjectType.

Referenced by TreeWidget().

◆ onFinishEditing

void TreeWidget::onFinishEditing ( )

protectedslot

References Gui::Application::getDocument(), Gui::ViewProviderDocumentObject::getObject(), Gui::Application::Instance, Gui::DocumentObjectItem::object(), and ObjectType.

Referenced by TreeWidget().

◆ onHideInTree

void TreeWidget::onHideInTree ( )

protectedslot

References ObjectType.

Referenced by TreeWidget().

◆ onMarkRecompute

void TreeWidget::onMarkRecompute ( )

protectedslot

References Gui::DocumentItem::document(), DocumentType, App::DocumentObject::enforceRecompute(), Gui::Document::getDocument(), Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::object(), and ObjectType.

Referenced by TreeWidget().

◆ onPreSelectTimer

void TreeWidget::onPreSelectTimer ( )

protectedslot

References App::DocumentObject::getDocument(), App::Document::getName(), App::DocumentObject::getNameInDocument(), Gui::DocumentObjectItem::getSubName(), Gui::TreeParams::Instance(), Gui::DocumentObjectItem::object(), ObjectType, Gui::Selection(), and Gui::SelectionSingleton::setPreselect().

Referenced by TreeWidget().

◆ onRecomputeObject

void TreeWidget::onRecomputeObject ( )

protectedslot

References Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::object(), and ObjectType.

Referenced by TreeWidget().

◆ onRelabelObject

void TreeWidget::onRelabelObject ( )

protectedslot

Referenced by TreeWidget().

◆ onReloadDoc

void TreeWidget::onReloadDoc ( )

protectedslot

References Gui::DocumentItem::document(), DocumentType, App::GetApplication(), Gui::Document::getDocument(), Gui::Application::Instance, Gui::Application::reopen(), and App::Application::setActiveDocument().

Referenced by mouseDoubleClickEvent(), and TreeWidget().

◆ onSearchObjects

void TreeWidget::onSearchObjects ( )

protectedslot

References emitSearchObjects().

Referenced by keyPressEvent(), and TreeWidget().

◆ onSelectionChanged()

void TreeWidget::onSelectionChanged ( const SelectionChanges & msg )

overrideprotectedvirtual

Observer message from the Selection.

Implements Gui::SelectionObserver.

References Gui::SelectionChanges::AddSelection, Gui::SelectionChanges::ClrSelection, Gui::TreeParams::Instance(), Gui::SelectionChanges::RmvSelection, and Gui::SelectionChanges::SetSelection.

◆ onSelectTimer

void TreeWidget::onSelectTimer ( )

protectedslot

References Gui::SelectionObserver::blockConnection(), Gui::DocumentItem::clearSelection(), Gui::TreeParams::Instance(), Gui::Selection(), Gui::DocumentItem::selectItems(), Gui::DocumentItem::SR_EXPAND, and Gui::DocumentItem::SR_SELECT.

Referenced by getSelection(), selectAllInstances(), selectAllLinks(), selectLinkedObject(), and TreeWidget().

◆ onShowHidden

void TreeWidget::onShowHidden ( )

protectedslot

References DocumentType, Gui::DocumentObjectItem::getOwnerDocument(), ObjectType, and Gui::DocumentItem::setShowHidden().

Referenced by TreeWidget().

◆ onSkipRecompute

void TreeWidget::onSkipRecompute ( bool on )

protectedslot

References Gui::DocumentItem::document(), DocumentType, Gui::Document::getDocument(), and App::Document::SkipRecompute.

Referenced by TreeWidget().

◆ onStartEditing

void TreeWidget::onStartEditing ( )

protectedslot

References Gui::DocumentItem::document(), Gui::getMainWindow(), Gui::ViewProviderDocumentObject::getObject(), Gui::DocumentObjectItem::getOwnerDocument(), Gui::DocumentObjectItem::object(), ObjectType, and Gui::MainWindow::setActiveWindow().

Referenced by contextMenuEvent().

◆ resetItemSearch()

void TreeWidget::resetItemSearch ( )

Referenced by itemSearch(), and startItemSearch().

◆ scrollItemToTop()

void TreeWidget::scrollItemToTop ( )

static

References Gui::Application::activeDocument(), Gui::SelectionSingleton::hasSelection(), Gui::Application::Instance, Gui::Selection(), and Gui::DocumentItem::SR_FORCE_EXPAND.

◆ selectAll()

void TreeWidget::selectAll ( )

overridevirtual

References Gui::SelectionSingleton::clearSelection(), App::GetApplication(), Gui::Application::getDocument(), Gui::Application::Instance, Gui::TreeParams::Instance(), Gui::Selection(), Gui::SelectionSingleton::selStackPush(), and Gui::SelectionSingleton::setSelection().

◆ selectAllInstances()

void TreeWidget::selectAllInstances ( const ViewProviderDocumentObject & vpd )

References Gui::SelectionObserver::isConnectionAttached(), and onSelectTimer().

◆ selectAllLinks()

void TreeWidget::selectAllLinks ( App::DocumentObject * obj )

References App::GetApplication(), App::GetLinkRecursive, Gui::Application::getViewProvider(), Gui::Application::Instance, Gui::SelectionObserver::isConnectionAttached(), and onSelectTimer().

◆ selectedDocument()

Gui::Document * TreeWidget::selectedDocument ( )

static

References DocumentType.

Referenced by Gui::PropertyView::onTimer().

◆ selectLinkedObject()

void TreeWidget::selectLinkedObject ( App::DocumentObject * linked )

References App::Application::getActiveDocument(), App::GetApplication(), getDocumentItem(), Gui::Application::Instance, Gui::SelectionObserver::isConnectionAttached(), Gui::SelectionObserver::isConnectionBlocked(), and onSelectTimer().

◆ showEvent()

void TreeWidget::showEvent ( QShowEvent * ev )

overrideprotected

References Gui::SelectionObserver::attachSelection(), and Gui::TreeParams::Instance().

◆ startDrag()

void TreeWidget::startDrag ( Qt::DropActions supportedActions )

overrideprotected

Referenced by startDragging().

◆ startDragging()

void TreeWidget::startDragging ( )

References startDrag().

◆ startItemSearch()

void TreeWidget::startItemSearch ( QLineEdit * edit )

References Gui::Application::activeDocument(), DocumentType, Gui::Document::getDocument(), App::Document::getObjects(), Gui::Application::Instance, ObjectType, and resetItemSearch().

◆ supportedDropActions()

Qt::DropActions TreeWidget::supportedDropActions ( ) const

overrideprotected

◆ syncView()

void TreeWidget::syncView ( ViewProviderDocumentObject * vp )

References Gui::DocumentItem::document(), Gui::TreeParams::Instance(), and Gui::Document::setActiveView().

Referenced by Gui::DocumentItem::selectItems(), and Gui::DocumentItem::updateItemSelection().

◆ updateStatus()

void TreeWidget::updateStatus ( bool delay = true )

static

Referenced by Gui::Document::slotRecomputed().

Friends And Related Function Documentation

◆ DocumentItem

friend class DocumentItem

friend

◆ DocumentObjectItem

friend class DocumentObjectItem

friend

Member Data Documentation

◆ DocumentType

const int TreeWidget::DocumentType = 1000

static

Referenced by contextMenuEvent(), dragMoveEvent(), dropEvent(), mouseDoubleClickEvent(), onAllowPartialRecompute(), onCloseDoc(), onCreateGroup(), onMarkRecompute(), onReloadDoc(), onShowHidden(), onSkipRecompute(), selectedDocument(), and startItemSearch().

◆ ObjectType

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

src/Gui/Tree.h
src/Gui/Tree.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Drag and drop

Detailed Description

Constructor & Destructor Documentation

◆ TreeWidget()

◆ ~TreeWidget()

Member Function Documentation

◆ checkTopParent()

◆ contextMenuEvent()

◆ dragEnterEvent()

◆ dragLeaveEvent()

◆ dragMoveEvent()

◆ drawRow()

◆ dropEvent()

◆ dropMimeData()

◆ emitSearchObjects

◆ event()

◆ eventFilter()

◆ expandSelectedItems()

◆ getDocumentItem()

◆ getSelection()

◆ getTreeName()

◆ hideEvent()

◆ instance()

◆ isObjectShowable()

◆ itemSearch()

◆ keyPressEvent()

◆ leaveEvent()

◆ markItem()

◆ mimeData()

◆ mouseDoubleClickEvent()

◆ onActivateDocument

◆ onAllowPartialRecompute

◆ onCloseDoc

◆ onCreateGroup

◆ onFinishEditing

◆ onHideInTree

◆ onMarkRecompute

◆ onPreSelectTimer

◆ onRecomputeObject

◆ onRelabelObject

◆ onReloadDoc

◆ onSearchObjects

◆ onSelectionChanged()

◆ onSelectTimer

◆ onShowHidden

◆ onSkipRecompute

◆ onStartEditing

◆ resetItemSearch()

◆ scrollItemToTop()

◆ selectAll()

◆ selectAllInstances()

◆ selectAllLinks()

◆ selectedDocument()

◆ selectLinkedObject()

◆ showEvent()

◆ startDrag()

◆ startDragging()

◆ startItemSearch()

◆ supportedDropActions()

◆ syncView()

◆ updateStatus()

Friends And Related Function Documentation

◆ DocumentItem

◆ DocumentObjectItem

Member Data Documentation

◆ DocumentType

◆ ObjectType