DrawingGui::DrawingView Class Reference

#include <DrawingView.h>

Public Slots

void load (const QString &path=QString())
 
void setRenderer (QAction *action)
 
void viewAll ()
 
- Public Slots inherited from Gui::MDIView
virtual void setOverrideCursor (const QCursor &)
 
virtual void restoreOverrideCursor ()
 

Public Member Functions

 DrawingView (Gui::Document *doc, QWidget *parent=nullptr)
 
PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
bool onHasMsg (const char *pMsg) const
 Message handler test. More...
 
bool onMsg (const char *pMsg, const char **ppReturn)
 Message handler. More...
 
void onRelabel (Gui::Document *pDoc)
 get called when the document is updated More...
 
void print ()
 Print content of view. More...
 
void print (QPrinter *printer)
 
void printPdf ()
 Print to PDF file. More...
 
void printPreview ()
 Show a preview dialog. More...
 
void setDocumentObject (const std::string &)
 
virtual ~DrawingView ()
 
- Public Member Functions inherited from Gui::MDIView
virtual bool canClose (void)
 overwrite when checking on close state More...
 
virtual void deleteSelf ()
 delete itself More...
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
 MDIView (Gui::Document *pcDocument, QWidget *parent, Qt::WindowFlags wflags=Qt::WindowFlags())
 View constructor Attach the view to the given document. More...
 
virtual bool onHasMsg (const char *pMsg) const
 Message handler test. More...
 
virtual bool onMsg (const char *pMsg, const char **ppReturn)
 Message handler. More...
 
virtual void onRelabel (Gui::Document *pDoc)
 get called when the document is updated More...
 
virtual void viewAll ()
 
 ~MDIView ()
 View destructor Detach the view from the document, if attached. More...
 
virtual QStringList undoActions () const
 
virtual QStringList redoActions () const
 
QSize minimumSizeHint () const
 
virtual void setCurrentViewMode (ViewMode mode)
 If b is set to FullScreen the MDI view is displayed in full screen mode, if b is set to TopLevel then it is displayed as an own top-level window, otherwise (Normal) as tabbed window. More...
 
ViewMode currentViewMode () const
 
template<typename _T >
_T getActiveObject (const char *name, App::DocumentObject **parent=nullptr, std::string *subname=nullptr) const
 access getter for the active object list More...
 
void setActiveObject (App::DocumentObject *o, const char *n, const char *subname=nullptr)
 
bool hasActiveObject (const char *n) const
 
bool isActiveObject (App::DocumentObject *o, const char *n, const char *subname=nullptr) const
 
virtual bool containsViewProvider (const ViewProvider *) const
 containsViewProvider Checks if the given view provider is part of this view. The default implementation returns false. More...
 
void savePrinterSettings (QPrinter *printer)
 Save the printer configuration. More...
 
void restorePrinterSettings (QPrinter *printer)
 Restore the printer configuration. More...
 
- Public Member Functions inherited from Gui::BaseView
 BaseView (Gui::Document *pcDocument=nullptr)
 View constructor Attach the view to the given document. More...
 
virtual ~BaseView ()
 View destructor Detach the view from the document, if attached! More...
 
void setDocument (Gui::Document *pcDocument)
 sets the view to another document (called by Application) More...
 
void onClose (void)
 is sent from the document in order to close the document More...
 
Gui::DocumentgetGuiDocument () const
 returns the document the view is attached to More...
 
App::DocumentgetAppDocument () const
 returns the document the view is attached to More...
 
bool isPassive (void) const
 indicates if the view is in passive mode More...
 
virtual void onUpdate (void)
 get called when the document is updated More...
 
virtual void onRename (Gui::Document *)
 get called when the document is renamed (change of its internal name) More...
 
virtual const char * getName (void) const
 returns the name of the view (important for messages) More...
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
 BaseClass (const BaseClass &)=default
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (const BaseClass &)=default
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Protected Member Functions

void closeEvent (QCloseEvent *)
 
void contextMenuEvent (QContextMenuEvent *event)
 
void findPrinterSettings (const QString &)
 
QPageSize::PageSizeId getPageSize (int w, int h) const
 
- Protected Member Functions inherited from Gui::MDIView
void closeEvent (QCloseEvent *e)
 
void changeEvent (QEvent *e)
 

Additional Inherited Members

- Public Types inherited from Gui::MDIView
enum  ViewMode { Child , TopLevel , FullScreen }
 MDI view mode enum. More...
 
- Signals inherited from Gui::MDIView
void message (const QString &, int)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
 
static Type getClassTypeId ()
 
static void init ()
 
- Protected Slots inherited from Gui::MDIView
virtual void windowStateChanged (MDIView *)
 This method gets called from the main window this view is attached to whenever the window state of the active view changes. More...
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 
- Protected Attributes inherited from Gui::MDIView
PyObjectpythonObject
 
- Protected Attributes inherited from Gui::BaseView
bool bIsDetached
 
bool bIsPassive
 

Constructor & Destructor Documentation

◆ DrawingView()

◆ ~DrawingView()

DrawingView::~DrawingView ( )
virtual

Member Function Documentation

◆ closeEvent()

void DrawingView::closeEvent ( QCloseEvent *  ev)
protected

◆ contextMenuEvent()

void DrawingView::contextMenuEvent ( QContextMenuEvent *  event)
protected

◆ findPrinterSettings()

void DrawingView::findPrinterSettings ( const QString &  fileName)
protected

Referenced by load().

◆ getPageSize()

QPageSize::PageSizeId DrawingView::getPageSize ( int  w,
int  h 
) const
protected

Referenced by print().

◆ getPyObject()

PyObject * DrawingView::getPyObject ( void  )
virtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Gui::MDIView.

References Gui::MDIView::getPyObject().

◆ load

◆ onHasMsg()

bool DrawingView::onHasMsg ( const char *  pMsg) const
virtual

Message handler test.

Reimplemented from Gui::MDIView.

References Gui::BaseView::getAppDocument(), and Gui::BaseView::getGuiDocument().

◆ onMsg()

bool DrawingView::onMsg ( const char *  pMsg,
const char **  ppReturn 
)
virtual

Message handler.

receive a message

Reimplemented from Gui::MDIView.

References Gui::BaseView::getGuiDocument(), and viewAll().

◆ onRelabel()

void DrawingView::onRelabel ( Gui::Document pDoc)
virtual

get called when the document is updated

Reimplemented from Gui::MDIView.

References Gui::BaseView::bIsPassive, Gui::Document::getDocument(), App::PropertyString::getValue(), and App::Document::Label.

◆ print() [1/2]

void DrawingView::print ( )
virtual

Print content of view.

Reimplemented from Gui::MDIView.

References print().

Referenced by print(), printPdf(), and printPreview().

◆ print() [2/2]

void DrawingView::print ( QPrinter *  printer)
virtual

Reimplemented from Gui::MDIView.

References getPageSize().

◆ printPdf()

void DrawingView::printPdf ( )
virtual

◆ printPreview()

void DrawingView::printPreview ( )
virtual

Show a preview dialog.

Reimplemented from Gui::MDIView.

References draftgeoutils.intersections::connect(), and print().

◆ setDocumentObject()

void DrawingView::setDocumentObject ( const std::string &  name)

◆ setRenderer

void DrawingView::setRenderer ( QAction *  action)
slot

◆ viewAll

void DrawingView::viewAll ( )
slot

Referenced by onMsg().


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