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>

Inheritance diagram for Gui::DockWindow:
Gui::BaseView Base::BaseClass Gui::DockWnd::CombiView Gui::DockWnd::PropertyDockView Gui::DockWnd::SelectionView Gui::DockWnd::TaskPanelView Gui::TreeDockWidget

List of all members.

Signals

void sendCloseView (MDIView *theView)
 sends a message to the document

Public Member Functions

 DockWindow (Gui::Document *pcDocument=0, QWidget *parent=0)
 View constructor Attach the view to the given document.
virtual ~DockWindow ()
 View destructor Detach the view from the document, if attached.
methods to overrride



virtual bool canClose (void)
 overwrite when checking on close state
virtual const char * getName (void) const
 returns the name of the view (important for messages)
virtual bool onHasMsg (const char *pMsg) const
 Message handler test.
virtual bool onMsg (const char *pMsg, const char **ppReturn)
 Message handler.
virtual void onUpdate (void)
 get called when the document is updated

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

Definition at line 47 of file DockWindow.h.


Constructor & Destructor Documentation

DockWindow::DockWindow ( Gui::Document pcDocument = 0,
QWidget *  parent = 0 
)

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!

Definition at line 30 of file DockWindow.cpp.

DockWindow::~DockWindow (  )  [virtual]

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

Definition at line 35 of file DockWindow.cpp.


Member Function Documentation

virtual bool Gui::DockWindow::canClose ( void   )  [inline, virtual]

overwrite when checking on close state

Reimplemented from Gui::BaseView.

Definition at line 75 of file DockWindow.h.

virtual const char* Gui::DockWindow::getName ( void   )  const [inline, virtual]

returns the name of the view (important for messages)

Reimplemented from Gui::BaseView.

Reimplemented in Gui::DockWnd::SelectionView, and Gui::DockWnd::TaskPanelView.

Definition at line 69 of file DockWindow.h.

virtual bool Gui::DockWindow::onHasMsg ( const char *  pMsg  )  const [inline, virtual]

Message handler test.

Implements Gui::BaseView.

Definition at line 73 of file DockWindow.h.

virtual bool Gui::DockWindow::onMsg ( const char *  pMsg,
const char **  ppReturn 
) [inline, virtual]

Message handler.

Implements Gui::BaseView.

Definition at line 71 of file DockWindow.h.

virtual void Gui::DockWindow::onUpdate ( void   )  [inline, virtual]

get called when the document is updated

Reimplemented from Gui::BaseView.

Reimplemented in Gui::DockWnd::SelectionView, and Gui::DockWnd::TaskPanelView.

Definition at line 67 of file DockWindow.h.

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

sends a message to the document


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

Generated on Wed Nov 23 19:01:59 2011 for FreeCAD by  doxygen 1.6.1