Gui::SelectionObject Class Reference
The Selection object class. More...
#include <SelectionObject.h>
Public Member Functions | |
| std::string | getAsPropertyLinkSubString (void) const |
| returns python expreasion sutably for assigning to a LinkSub property | |
| const char * | getDocName (void) |
| get the name of the Document of this SelctionObject | |
| const char * | getFeatName (void) |
| get the name of the Document Object of this SelectionObject | |
| App::DocumentObject * | getObject (void) |
| returns the selected DocumentObject or NULL if the object is already deleted | |
| const App::DocumentObject * | getObject (void) const |
| returns the selected DocumentObject or NULL if the object is already deleted | |
| PyObject * | getPyObject () |
| The default implementation returns an instance of SelectionObjectPy. | |
| const std::vector< std::string > & | getSubNames (void) const |
| get the SubElement name of this SelectionObject | |
| virtual Base::Type | getTypeId (void) const |
| const char * | getTypeName (void) |
| get the Type of the selcted Object | |
| bool | hasSubNames (void) const |
| are there any SubNames selected | |
| bool | isObjectTypeOf (const Base::Type &typeId) const |
| check the selected object is a special type or derived of | |
| SelectionObject () | |
| Constructs a SelectionObject object. | |
| virtual | ~SelectionObject () |
Static Public Member Functions | |
| static void * | create (void) |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
Protected Attributes | |
| std::string | DocName |
| std::string | FeatName |
| std::vector< Base::Vector3d > | SelPoses |
| std::vector< std::string > | SubNames |
| std::string | TypeName |
Friends | |
| class | SelectionSingleton |
Detailed Description
The Selection object class.
Definition at line 40 of file SelectionObject.h.
Constructor & Destructor Documentation
| SelectionObject::SelectionObject | ( | ) |
Constructs a SelectionObject object.
Definition at line 42 of file SelectionObject.cpp.
Referenced by getPyObject().
| SelectionObject::~SelectionObject | ( | ) | [virtual] |
Definition at line 61 of file SelectionObject.cpp.
Member Function Documentation
| void * Gui::SelectionObject::create | ( | void | ) | [static] |
Reimplemented from Base::BaseClass.
Definition at line 40 of file SelectionObject.cpp.
| std::string SelectionObject::getAsPropertyLinkSubString | ( | void | ) | const |
returns python expreasion sutably for assigning to a LinkSub property
Definition at line 91 of file SelectionObject.cpp.
References App::DocumentObject::getNameInDocument(), getObject(), and SubNames.
| Base::Type Gui::SelectionObject::getClassTypeId | ( | void | ) | [static] |
Reimplemented from Base::BaseClass.
Definition at line 40 of file SelectionObject.cpp.
| const char* Gui::SelectionObject::getDocName | ( | void | ) | [inline] |
get the name of the Document of this SelctionObject
Definition at line 58 of file SelectionObject.h.
| const char* Gui::SelectionObject::getFeatName | ( | void | ) | [inline] |
get the name of the Document Object of this SelectionObject
Definition at line 60 of file SelectionObject.h.
| App::DocumentObject * SelectionObject::getObject | ( | void | ) |
returns the selected DocumentObject or NULL if the object is already deleted
Definition at line 75 of file SelectionObject.cpp.
References DocName, FeatName, App::GetApplication(), App::Application::getDocument(), and App::Document::getObject().
| const App::DocumentObject * SelectionObject::getObject | ( | void | ) | const |
returns the selected DocumentObject or NULL if the object is already deleted
Definition at line 65 of file SelectionObject.cpp.
References DocName, FeatName, App::GetApplication(), App::Application::getDocument(), and App::Document::getObject().
Referenced by getAsPropertyLinkSubString(), Gui::SelectionObjectPy::getSubObjects(), and isObjectTypeOf().
| PyObject * SelectionObject::getPyObject | ( | void | ) | [virtual] |
The default implementation returns an instance of SelectionObjectPy.
Reimplemented from Base::BaseClass.
Definition at line 112 of file SelectionObject.cpp.
References SelectionObject().
| const std::vector<std::string>& Gui::SelectionObject::getSubNames | ( | void | ) | const [inline] |
get the SubElement name of this SelectionObject
Definition at line 54 of file SelectionObject.h.
Referenced by Gui::SelectionObjectPy::getSubElementNames().
| Base::Type Gui::SelectionObject::getTypeId | ( | void | ) | const [virtual] |
Reimplemented from Base::BaseClass.
Definition at line 40 of file SelectionObject.cpp.
| const char* Gui::SelectionObject::getTypeName | ( | void | ) | [inline] |
get the Type of the selcted Object
Definition at line 62 of file SelectionObject.h.
| bool Gui::SelectionObject::hasSubNames | ( | void | ) | const [inline] |
are there any SubNames selected
Definition at line 56 of file SelectionObject.h.
| void Gui::SelectionObject::init | ( | void | ) | [static] |
Reimplemented from Base::BaseClass.
Definition at line 40 of file SelectionObject.cpp.
| bool SelectionObject::isObjectTypeOf | ( | const Base::Type & | typeId | ) | const |
check the selected object is a special type or derived of
Definition at line 85 of file SelectionObject.cpp.
References getObject(), App::PropertyContainer::getTypeId(), and Base::Type::isDerivedFrom().
Friends And Related Function Documentation
friend class SelectionSingleton [friend] |
Definition at line 75 of file SelectionObject.h.
Member Data Documentation
std::string Gui::SelectionObject::DocName [protected] |
Definition at line 79 of file SelectionObject.h.
Referenced by getObject(), and Gui::SelectionSingleton::getSelectionEx().
std::string Gui::SelectionObject::FeatName [protected] |
Definition at line 80 of file SelectionObject.h.
Referenced by getObject(), and Gui::SelectionSingleton::getSelectionEx().
std::vector<Base::Vector3d> Gui::SelectionObject::SelPoses [protected] |
Definition at line 82 of file SelectionObject.h.
Referenced by Gui::SelectionSingleton::getSelectionEx().
std::vector<std::string> Gui::SelectionObject::SubNames [protected] |
Definition at line 78 of file SelectionObject.h.
Referenced by getAsPropertyLinkSubString(), and Gui::SelectionSingleton::getSelectionEx().
std::string Gui::SelectionObject::TypeName [protected] |
Definition at line 81 of file SelectionObject.h.
Referenced by Gui::SelectionSingleton::getSelectionEx().
The documentation for this class was generated from the following files:
