Gui::ViewProviderPythonFeatureT< ViewProviderT > Class Template Reference

#include <ViewProviderPythonFeature.h>

Public Member Functions

std::vector< App::DocumentObject * > claimChildren () const override
 
QIcon getIcon () const override
 
 ViewProviderPythonFeatureT ()
 constructor. More...
 
virtual ~ViewProviderPythonFeatureT ()
 destructor. More...
 
Nodes
virtual SoSeparatorgetRoot () const override
 
virtual SoSeparatorgetFrontRoot () const override
 
virtual SoSeparatorgetBackRoot () const override
 
Selection handling
virtual bool useNewSelectionModel () const override
 
virtual bool getElementPicked (const SoPickedPoint *pp, std::string &subname) const override
 
virtual std::string getElement (const SoDetail *det) const override
 
virtual SoDetail * getDetail (const char *name) const override
 
virtual bool getDetailPath (const char *name, SoFullPath *path, bool append, SoDetail *&det) const override
 
virtual std::vector< Base::Vector3dgetSelectionShape (const char *Element) const override
 
Update data methods
virtual void attach (App::DocumentObject *obj) override
 
virtual void updateData (const App::Property *prop) override
 
virtual void getTaskViewContent (std::vector< Gui::TaskView::TaskContent * > &c) const override
 
virtual bool onDelete (const std::vector< std::string > &sub) override
 
virtual bool canDelete (App::DocumentObject *obj) const override
 
Restoring view provider from document load
virtual void startRestoring () override
 
virtual void finishRestoring () override
 
Drag and drop
virtual bool canDragObjects () const override
 Returns true if the view provider generally supports dragging objects. More...
 
virtual bool canDragObject (App::DocumentObject *obj) const override
 Check whether the object can be removed from the view provider by drag and drop. More...
 
virtual void dragObject (App::DocumentObject *obj) override
 Starts to drag the object. More...
 
virtual bool canDropObjects () const override
 Returns true if the view provider generally accepts dropping of objects. More...
 
virtual bool canDropObject (App::DocumentObject *obj) const override
 Check whether the object can be dropped to the view provider by drag and drop. More...
 
virtual void dropObject (App::DocumentObject *obj) override
 If the dropped object type is accepted the object will be added as child. More...
 
virtual bool canDragAndDropObject (App::DocumentObject *obj) const override
 Return false to force drop only operation for a give object. More...
 
virtual bool canDropObjectEx (App::DocumentObject *obj, App::DocumentObject *owner, const char *subname, const std::vector< std::string > &elements) const override
 
virtual std::string dropObjectEx (App::DocumentObject *obj, App::DocumentObject *owner, const char *subname, const std::vector< std::string > &elements) override
 Add an object with full qualified name to the view provider by drag and drop. More...
 
- Public Member Functions inherited from Gui::ViewProviderT
std::string getAppDocumentPython () const
 
DocumentgetDocument () const
 
std::string getDocumentName () const
 
std::string getGuiDocumentPython () const
 
template<typename T >
T * getObjectAs () const
 
std::string getObjectName () const
 
std::string getObjectPython () const
 
ViewProviderDocumentObjectgetViewProvider () const
 
void operator= (const ViewProviderDocumentObject *)
 
void operator= (const ViewProviderT &)
 
 ViewProviderT ()
 
 ViewProviderT (const ViewProviderT &)
 
 ViewProviderT (ViewProviderDocumentObject *)
 
 ~ViewProviderT ()
 

Display methods

virtual bool isShow () const override
 Returns true if the icon must always appear enabled in the tree view. More...
 
virtual const char * getDefaultDisplayMode () const override
 get the default display mode More...
 
virtual std::vector< std::string > getDisplayModes (void) const override
 returns a list of all possible modes More...
 
virtual void setDisplayMode (const char *ModeName) override
 set the display mode More...
 
virtual bool canRemoveChildrenFromRoot () const override
 
PyObjectgetPyObject () override
 
virtual bool canAddToSceneGraph () const override
 
virtual void setupContextMenu (QMenu *menu, QObject *recipient, const char *member) override
 
virtual void onChanged (const App::Property *prop) override
 
virtual bool setEdit (int ModNum) override
 is called by the document when the provider goes in edit mode More...
 
virtual void unsetEdit (int ModNum) override
 is called when you lose the edit mode More...
 
virtual void setEditViewer (View3DInventorViewer *viewer, int ModNum) override
 
virtual void unsetEditViewer (View3DInventorViewer *viewer) override
 
virtual std::string getDropPrefix () const override
 
virtual int replaceObject (App::DocumentObject *oldObj, App::DocumentObject *newObj) override
 
virtual ViewProviderDocumentObjectgetLinkedViewProvider (std::string *subname=0, bool recursive=false) const override
 
virtual bool doubleClicked (void) override
 
virtual void setOverrideMode (const std::string &mode) override
 

Constructor & Destructor Documentation

◆ ViewProviderPythonFeatureT()

constructor.

◆ ~ViewProviderPythonFeatureT()

template<class ViewProviderT >
virtual Gui::ViewProviderPythonFeatureT< ViewProviderT >::~ViewProviderPythonFeatureT ( )
virtual

destructor.

Member Function Documentation

◆ attach()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::attach ( App::DocumentObject obj)
overridevirtual

◆ canAddToSceneGraph()

◆ canDelete()

◆ canDragAndDropObject()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragAndDropObject ( App::DocumentObject obj) const
overridevirtual

◆ canDragObject()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragObject ( App::DocumentObject obj) const
overridevirtual

Check whether the object can be removed from the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDragObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDragObjects()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragObjects ( ) const
overridevirtual

Returns true if the view provider generally supports dragging objects.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDragObjects(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDropObject()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObject ( App::DocumentObject obj) const
overridevirtual

Check whether the object can be dropped to the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDropObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDropObjectEx()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObjectEx ( App::DocumentObject obj,
App::DocumentObject owner,
const char *  subname,
const std::vector< std::string > &  elements 
) const
overridevirtual

◆ canDropObjects()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObjects ( ) const
overridevirtual

Returns true if the view provider generally accepts dropping of objects.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDropObjects(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canRemoveChildrenFromRoot()

◆ claimChildren()

◆ doubleClicked()

◆ dragObject()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::dragObject ( App::DocumentObject obj)
overridevirtual

◆ dropObject()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::dropObject ( App::DocumentObject obj)
overridevirtual

If the dropped object type is accepted the object will be added as child.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::dropObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ dropObjectEx()

template<class ViewProviderT >
virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::dropObjectEx ( App::DocumentObject obj,
App::DocumentObject owner,
const char *  subname,
const std::vector< std::string > &  elements 
)
overridevirtual

Add an object with full qualified name to the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::dropObjectEx().

◆ finishRestoring()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::finishRestoring ( )
overridevirtual

◆ getBackRoot()

template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getBackRoot ( void  ) const
overridevirtual

◆ getDefaultDisplayMode()

template<class ViewProviderT >
virtual const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDefaultDisplayMode ( ) const
overridevirtual

get the default display mode

References Gui::ViewProviderPythonFeatureImp::getDefaultDisplayMode().

◆ getDetail()

template<class ViewProviderT >
virtual SoDetail* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDetail ( const char *  name) const
overridevirtual

◆ getDetailPath()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDetailPath ( const char *  name,
SoFullPath *  path,
bool  append,
SoDetail *&  det 
) const
overridevirtual

◆ getDisplayModes()

template<class ViewProviderT >
virtual std::vector<std::string> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDisplayModes ( void  ) const
overridevirtual

returns a list of all possible modes

References Gui::ViewProviderPythonFeatureImp::getDisplayModes().

◆ getDropPrefix()

template<class ViewProviderT >
virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDropPrefix ( ) const
overrideprotectedvirtual

◆ getElement()

template<class ViewProviderT >
virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::getElement ( const SoDetail *  det) const
overridevirtual

◆ getElementPicked()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::getElementPicked ( const SoPickedPoint *  pp,
std::string &  subname 
) const
overridevirtual

◆ getFrontRoot()

template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getFrontRoot ( void  ) const
overridevirtual

◆ getIcon()

◆ getLinkedViewProvider()

template<class ViewProviderT >
virtual ViewProviderDocumentObject* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getLinkedViewProvider ( std::string *  subname = 0,
bool  recursive = false 
) const
overrideprotectedvirtual

◆ getPyObject()

template<class ViewProviderT >
PyObject* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPyObject ( void  )
override

◆ getRoot()

template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getRoot ( void  ) const
overridevirtual

◆ getSelectionShape()

template<class ViewProviderT >
virtual std::vector<Base::Vector3d> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getSelectionShape ( const char *  Element) const
overridevirtual

◆ getTaskViewContent()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::getTaskViewContent ( std::vector< Gui::TaskView::TaskContent * > &  c) const
overridevirtual

◆ isShow()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isShow ( void  ) const
overridevirtual

Returns true if the icon must always appear enabled in the tree view.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::isShow(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ onChanged()

◆ onDelete()

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::onDelete ( const std::vector< std::string > &  sub)
overridevirtual

◆ replaceObject()

◆ setDisplayMode()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setDisplayMode ( const char *  ModeName)
overridevirtual

set the display mode

References Gui::ViewProviderPythonFeatureImp::setDisplayMode().

◆ setEdit()

◆ setEditViewer()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setEditViewer ( View3DInventorViewer viewer,
int  ModNum 
)
overrideprotectedvirtual

◆ setOverrideMode()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setOverrideMode ( const std::string &  mode)
overrideprotectedvirtual

◆ setupContextMenu()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setupContextMenu ( QMenu menu,
QObject recipient,
const char *  member 
)
overridevirtual

◆ startRestoring()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::startRestoring ( )
overridevirtual

◆ unsetEdit()

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::unsetEdit ( int  ModNum)
overrideprotectedvirtual

◆ unsetEditViewer()

◆ updateData()

◆ useNewSelectionModel()


The documentation for this class was generated from the following file:
  • Sources/FreeCAD/src/Gui/ViewProviderPythonFeature.h