Gui::ViewProviderPythonFeatureT< ViewProviderT > Class Template Reference

#include <ViewProviderPythonFeature.h>

List of all members.

Public Member Functions

std::vector
< App::DocumentObject * > 
claimChildren () const
QIcon getIcon () const
PyObjectgetPyObject ()
virtual Base::Type getTypeId (void) const
 ViewProviderPythonFeatureT ()
 constructor.
virtual ~ViewProviderPythonFeatureT ()
 destructor.
Access properties



virtual void addDynamicProperties (const App::PropertyContainer *cont)
App::PropertyaddDynamicProperty (const char *type, const char *name=0, const char *group=0, const char *doc=0, short attr=0, bool ro=false, bool hidden=false)
App::PropertygetDynamicPropertyByName (const char *name) const
std::vector< std::string > getDynamicPropertyNames () const
virtual const char * getName (const App::Property *prop) const
 get the name of a property
virtual App::PropertygetPropertyByName (const char *name) const
 find a property by its name
virtual void getPropertyMap (std::map< std::string, App::Property * > &Map) const
 get all properties of the class (including parent)
Update data methods



virtual void attach (App::DocumentObject *obj)
virtual void getTaskViewContent (std::vector< Gui::TaskView::TaskContent * > &c) const
virtual void updateData (const App::Property *prop)
Restoring view provider from document load



virtual void finishRestoring ()
virtual void startRestoring ()
Nodes



virtual SoSeparator * getBackRoot () const
virtual SoSeparator * getFrontRoot () const
virtual SoSeparator * getRoot ()
Display methods



virtual const char * getDefaultDisplayMode () const
 get the default display mode
virtual std::vector< std::string > getDisplayModes (void) const
 returns a list of all possible modes
virtual void setDisplayMode (const char *ModeName)
 set the display mode
Selection handling



virtual std::string getElement (const SoPickedPoint *pp) const
virtual std::vector
< Base::Vector3d
getSelectionShape (const char *Element) const
virtual bool useNewSelectionModel () const
Property attributes



const char * getPropertyDocumentation (const char *name) const
 get the Group of a named Property
const char * getPropertyDocumentation (const App::Property *prop) const
 get the Group of a Property
const char * getPropertyGroup (const char *name) const
 get the Group of a named Property
const char * getPropertyGroup (const App::Property *prop) const
 get the Group of a Property
short getPropertyType (const char *name) const
 get the Type of a named Property
short getPropertyType (const App::Property *prop) const
 get the Type of a Property
bool isHidden (const char *name) const
 check if the named property is hidden
bool isHidden (const App::Property *prop) const
 check if the property is hidden
bool isReadOnly (const char *name) const
 check if the nameed property is read-only
bool isReadOnly (const App::Property *prop) const
 check if the property is read-only
Property serialization



void Restore (Base::XMLReader &reader)
void Save (Base::Writer &writer) const

Static Public Member Functions

static void * create (void)
static Base::Type getClassTypeId (void)
static void init (void)

Protected Member Functions

virtual const App::PropertyDatagetPropertyData (void) const
virtual void onChanged (const App::Property *prop)
virtual bool setEdit (int ModNum)
 is called by the document when the provider goes in edit mode
virtual void unsetEdit (int ModNum)
 is called when you loose the edit mode

Static Protected Member Functions

static const App::PropertyDatagetPropertyDataPtr (void)

Detailed Description

template<class ViewProviderT>
class Gui::ViewProviderPythonFeatureT< ViewProviderT >

Definition at line 80 of file ViewProviderPythonFeature.h.


Constructor & Destructor Documentation

template<class ViewProviderT >
Gui::ViewProviderPythonFeatureT< ViewProviderT >::ViewProviderPythonFeatureT (  )  [inline]

constructor.

Definition at line 86 of file ViewProviderPythonFeature.h.

References ADD_PROPERTY.

template<class ViewProviderT >
virtual Gui::ViewProviderPythonFeatureT< ViewProviderT >::~ViewProviderPythonFeatureT (  )  [inline, virtual]

destructor.

Definition at line 92 of file ViewProviderPythonFeature.h.


Member Function Documentation

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::addDynamicProperties ( const App::PropertyContainer cont  )  [inline, virtual]
template<class ViewProviderT >
App::Property* Gui::ViewProviderPythonFeatureT< ViewProviderT >::addDynamicProperty ( const char *  type,
const char *  name = 0,
const char *  group = 0,
const char *  doc = 0,
short  attr = 0,
bool  ro = false,
bool  hidden = false 
) [inline]
template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::attach ( App::DocumentObject obj  )  [inline, virtual]
template<class ViewProviderT >
std::vector<App::DocumentObject*> Gui::ViewProviderPythonFeatureT< ViewProviderT >::claimChildren ( void   )  const [inline]
void * Gui::ViewProviderPythonGeometry::create ( void   )  [inline, static]

Definition at line 581 of file ViewProviderPythonFeature.cpp.

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::finishRestoring (  )  [inline, virtual]
template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getBackRoot ( void   )  const [inline, virtual]

Definition at line 118 of file ViewProviderPythonFeature.h.

Base::Type Gui::ViewProviderPythonGeometry::getClassTypeId ( void   )  [inline, static]

Definition at line 581 of file ViewProviderPythonFeature.cpp.

template<class ViewProviderT >
virtual const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDefaultDisplayMode (  )  const [inline, virtual]

get the default display mode

Definition at line 165 of file ViewProviderPythonFeature.h.

References Gui::ViewProviderPythonFeatureImp::getDefaultDisplayMode().

template<class ViewProviderT >
virtual std::vector<std::string> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDisplayModes ( void   )  const [inline, virtual]

returns a list of all possible modes

Definition at line 169 of file ViewProviderPythonFeature.h.

References Gui::ViewProviderPythonFeatureImp::getDisplayModes().

template<class ViewProviderT >
App::Property* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDynamicPropertyByName ( const char *  name  )  const [inline]
template<class ViewProviderT >
std::vector<std::string> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDynamicPropertyNames (  )  const [inline]
template<class ViewProviderT >
virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::getElement ( const SoPickedPoint *  pp  )  const [inline, virtual]

Definition at line 128 of file ViewProviderPythonFeature.h.

template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getFrontRoot ( void   )  const [inline, virtual]

Definition at line 114 of file ViewProviderPythonFeature.h.

template<class ViewProviderT >
QIcon Gui::ViewProviderPythonFeatureT< ViewProviderT >::getIcon ( void   )  const [inline]
template<class ViewProviderT >
virtual const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getName ( const App::Property prop  )  const [inline, virtual]

get the name of a property

Definition at line 209 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getName().

template<class ViewProviderT >
virtual App::Property* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyByName ( const char *  name  )  const [inline, virtual]

find a property by its name

Definition at line 205 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyByName().

const App::PropertyData & Gui::ViewProviderPythonGeometry::getPropertyData ( void   )  const [inline, protected, virtual]

Definition at line 581 of file ViewProviderPythonFeature.cpp.

const App::PropertyData * Gui::ViewProviderPythonGeometry::getPropertyDataPtr ( void   )  [inline, static, protected]

Definition at line 581 of file ViewProviderPythonFeature.cpp.

template<class ViewProviderT >
const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyDocumentation ( const char *  name  )  const [inline]

get the Group of a named Property

Definition at line 237 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyDocumentation().

template<class ViewProviderT >
const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyDocumentation ( const App::Property prop  )  const [inline]

get the Group of a Property

Definition at line 233 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyDocumentation().

template<class ViewProviderT >
const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyGroup ( const char *  name  )  const [inline]

get the Group of a named Property

Definition at line 229 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyGroup().

template<class ViewProviderT >
const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyGroup ( const App::Property prop  )  const [inline]

get the Group of a Property

Definition at line 225 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyGroup().

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyMap ( std::map< std::string, App::Property * > &  Map  )  const [inline, virtual]

get all properties of the class (including parent)

Definition at line 201 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyMap().

template<class ViewProviderT >
short Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyType ( const char *  name  )  const [inline]

get the Type of a named Property

Definition at line 221 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyType().

template<class ViewProviderT >
short Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPropertyType ( const App::Property prop  )  const [inline]

get the Type of a Property

Definition at line 217 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::getPropertyType().

template<class ViewProviderT >
PyObject* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPyObject ( void   )  [inline]

Definition at line 268 of file ViewProviderPythonFeature.h.

template<class ViewProviderT >
virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getRoot ( void   )  [inline, virtual]

Definition at line 111 of file ViewProviderPythonFeature.h.

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

Definition at line 131 of file ViewProviderPythonFeature.h.

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

Definition at line 147 of file ViewProviderPythonFeature.h.

Base::Type Gui::ViewProviderPythonGeometry::getTypeId ( void   )  const [inline, virtual]

Definition at line 581 of file ViewProviderPythonFeature.cpp.

void Gui::ViewProviderPythonGeometry::init ( void   )  [inline, static]
template<class ViewProviderT >
bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isHidden ( const char *  name  )  const [inline]

check if the named property is hidden

Definition at line 253 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::isHidden().

template<class ViewProviderT >
bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isHidden ( const App::Property prop  )  const [inline]

check if the property is hidden

Definition at line 249 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::isHidden().

template<class ViewProviderT >
bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isReadOnly ( const char *  name  )  const [inline]

check if the nameed property is read-only

Definition at line 245 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::isReadOnly().

template<class ViewProviderT >
bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isReadOnly ( const App::Property prop  )  const [inline]

check if the property is read-only

Definition at line 241 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::isReadOnly().

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::onChanged ( const App::Property prop  )  [inline, protected, virtual]
template<class ViewProviderT >
void Gui::ViewProviderPythonFeatureT< ViewProviderT >::Restore ( Base::XMLReader reader  )  [inline]

Definition at line 263 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::Restore().

template<class ViewProviderT >
void Gui::ViewProviderPythonFeatureT< ViewProviderT >::Save ( Base::Writer writer  )  const [inline]

Definition at line 260 of file ViewProviderPythonFeature.h.

References App::DynamicProperty::Save().

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setDisplayMode ( const char *  ModeName  )  [inline, virtual]

set the display mode

Definition at line 176 of file ViewProviderPythonFeature.h.

References Gui::ViewProviderPythonFeatureImp::setDisplayMode().

template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::setEdit ( int  ModNum  )  [inline, protected, virtual]

is called by the document when the provider goes in edit mode

Definition at line 295 of file ViewProviderPythonFeature.h.

References Gui::ViewProviderPythonFeatureImp::setEdit().

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::startRestoring (  )  [inline, virtual]
template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::unsetEdit ( int  ModNum  )  [inline, protected, virtual]

is called when you loose the edit mode

Definition at line 302 of file ViewProviderPythonFeature.h.

References Gui::ViewProviderPythonFeatureImp::unsetEdit().

template<class ViewProviderT >
virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::updateData ( const App::Property prop  )  [inline, virtual]
template<class ViewProviderT >
virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::useNewSelectionModel ( void   )  const [inline, virtual]

Definition at line 125 of file ViewProviderPythonFeature.h.


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

Generated on Wed Nov 23 19:02:05 2011 for FreeCAD by  doxygen 1.6.1