Gui::DockWindow Class Reference

Base class of all dockable windows belonging to a document there are two ways of belonging to a document. More...

#include <DockWindow.h>

Public Member Functions

 DockWindow (Gui::Document *pcDocument=nullptr, QWidget *parent=nullptr)
 View constructor Attach the view to the given document. More...
 
virtual ~DockWindow ()
 View destructor Detach the view from the document, if attached. 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 onRelabel (Gui::Document *)
 get called when the document is relabeled (change of its user name) More...
 
virtual void onRename (Gui::Document *)
 get called when the document is renamed (change of its internal name) More...
 
virtual void deleteSelf ()
 delete itself 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...
 

methods to override

virtual void onUpdate (void)
 get called when the document is updated More...
 
virtual const char * getName (void) const
 returns the name of the view (important for messages) More...
 
virtual bool onMsg (const char *, const char **)
 Message handler. More...
 
virtual bool onHasMsg (const char *) const
 Message handler test. More...
 
virtual bool canClose (void)
 overwrite when checking on close state More...
 
void sendCloseView (MDIView *theView)
 sends a message to the document More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
 
static Type getClassTypeId ()
 
static void init ()
 
- 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::BaseView
bool bIsDetached
 
bool bIsPassive
 

Detailed Description

Base class of all dockable windows belonging to a document there are two ways of belonging to a document.

The first way is to a fixed one. The second way is to always belong to the active document, that means switching every time the active document is changing. It also means that the view belongs sometimes to no document at all!

See also
TreeView
Gui::Document
Application
Author
J├╝rgen Riegel

Constructor & Destructor Documentation

◆ DockWindow()

DockWindow::DockWindow ( Gui::Document pcDocument = nullptr,
QWidget parent = nullptr 
)

View constructor Attach the view to the given document.

If the document is 0 the view will attach to the active document. Be aware there isn't always an active document available!

◆ ~DockWindow()

DockWindow::~DockWindow ( )
virtual

View destructor Detach the view from the document, if attached.

Reimplemented in Gui::DAG::DockWindow.

Member Function Documentation

◆ canClose()

virtual bool Gui::DockWindow::canClose ( void  )
virtual

overwrite when checking on close state

Reimplemented from Gui::BaseView.

◆ getName()

virtual const char * Gui::DockWindow::getName ( void  ) const
virtual

returns the name of the view (important for messages)

Reimplemented from Gui::BaseView.

Reimplemented in Gui::DockWnd::SelectionView.

◆ onHasMsg()

virtual bool Gui::DockWindow::onHasMsg ( const char *  ) const
virtual

Message handler test.

Implements Gui::BaseView.

◆ onMsg()

virtual bool Gui::DockWindow::onMsg ( const char *  ,
const char **   
)
virtual

Message handler.

Implements Gui::BaseView.

Reimplemented in Gui::DockWnd::SelectionView.

◆ onUpdate()

virtual void Gui::DockWindow::onUpdate ( void  )
virtual

get called when the document is updated

Reimplemented from Gui::BaseView.

Reimplemented in Gui::DockWnd::SelectionView.

◆ sendCloseView

void Gui::DockWindow::sendCloseView ( MDIView theView)
signal

sends a message to the document


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