DocumentObjectGroup.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   Copyright (c) 2006 Werner Mayer <wmayer[at]users.sourceforge.net>     *
00003  *                                                                         *
00004  *   This file is part of the FreeCAD CAx development system.              *
00005  *                                                                         *
00006  *   This library is free software; you can redistribute it and/or         *
00007  *   modify it under the terms of the GNU Library General Public           *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2 of the License, or (at your option) any later version.      *
00010  *                                                                         *
00011  *   This library  is distributed in the hope that it will be useful,      *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00014  *   GNU Library General Public License for more details.                  *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Library General Public     *
00017  *   License along with this library; see the file COPYING.LIB. If not,    *
00018  *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
00019  *   Suite 330, Boston, MA  02111-1307, USA                                *
00020  *                                                                         *
00021  ***************************************************************************/
00022 
00023 
00024 #ifndef APP_DOCUMENTOBJECTGROUP_H
00025 #define APP_DOCUMENTOBJECTGROUP_H
00026 
00027 #include "FeaturePython.h"
00028 #include "DocumentObject.h"
00029 #include "PropertyLinks.h"
00030 #include <vector>
00031 
00032 
00033 namespace App
00034 {
00035 class DocumentObjectGroupPy;
00036 
00037 class AppExport DocumentObjectGroup : public DocumentObject
00038 {
00039     PROPERTY_HEADER(App::DocumentObjectGroup);
00040 
00041 public:
00043     DocumentObjectGroup(void);
00044     virtual ~DocumentObjectGroup();
00045 
00051     DocumentObject *addObject(const char* sType, const char* pObjectName);
00052     /* Adds the object \a obj to this group. 
00053      */
00054     void addObject(DocumentObject* obj);
00057     void removeObject(DocumentObject* obj);
00060     void removeObjectsFromDocument();
00064     DocumentObject *getObject(const char* Name) const;
00068     bool hasObject(DocumentObject* obj) const;
00073     bool isChildOf(DocumentObjectGroup*) const;
00076     std::vector<DocumentObject*> getObjects() const;
00079     std::vector<DocumentObject*> getObjectsOfType(const Base::Type& typeId) const;
00082     int countObjectsOfType(const Base::Type& typeId) const;
00086     static DocumentObjectGroup* getGroupOfObject(DocumentObject* obj);
00088 
00090     virtual const char* getViewProviderName(void) const {
00091         return "Gui::ViewProviderDocumentObjectGroup";
00092     }
00093     virtual PyObject *getPyObject(void);
00094 
00096     PropertyLinkList Group;
00097 
00098 private:
00099     void removeObjectFromDocument(DocumentObject*);
00100 };
00101 
00102 typedef App::FeaturePythonT<DocumentObjectGroup> DocumentObjectGroupPython;
00103 
00104 
00105 } //namespace App
00106 
00107 
00108 #endif // APP_DOCUMENTOBJECTGROUP_H

Generated on Wed Nov 23 19:00:08 2011 for FreeCAD by  doxygen 1.6.1