PEditor Class Reference

PEditor is the responsibel to render BMessages and to give the User the posibility to edit the value of the individual BMessage. More...

Inheritance diagram for PEditor:

[legend]

Collaboration diagram for PEditor:

[legend]

List of all members.

Public Member Functions

PEditor (void)

virtual void AttachedToManager (void)=0

AttachedToManager is called after The Editor was added to a EditorManager at this point you can acces the doc Value.

virtual void DetachedFromManager (void)=0

DetachedFromManager is called after The Editor was removed from the EditorManager at this point you can acces the doc Value.

virtual void PreprocessBeforSave (BMessage *container)=0

this Method can perform Steps wich are necessary befor saving e.g.

virtual void PreprocessAfterLoad (BMessage *container)=0

this Method can perform Steps wich are necessary befor loading e.g.

virtual BView * GetView (void)=0

if the Editor is an View (this mostly shoud be the case) it returns the pointer to his View (this shoud be the this pointer :-))

virtual BView * GetPrintView (void)

if the View wich should be printet is different than the View return by GetView you shoudl overwrite this Method and return the View wich should be printed.

virtual BHandler * GetHandler (void)=0

if the Editor is an View it returns the pointer to the view (this pointer) else it shoud be the pointer to the handler for the Editor (e.g.

virtual bool NeedLiveFeed (void)

Implement this Method and return true if you need a liveupdate if something changed even if the Editor is not active.

virtual void ValueChanged (void)

this Method isnt called direcly (at the moment) instead a P_C_VALUE_CHANGED Message is send to the by GetHandler returned Handler imlement this that it handle alle changed Nodes wich returned in the doc->GetChangedNodes() and also in doc->GetTrash() all deleted nodes ;-)

void SetManager (PEditorManager *newManager)

set the Manager to wich the PEditor shoud belong to calls also the AttachedToManager Method or DetachedFromManager if the passed Value is NULL

PEditorManager * Manager (void)

Returns the Manger to wich the PEditor aktually belongs.

virtual BMessage * GetConfiguration (void)=0

virtual void SetConfiguration (BMessage *message)=0

virtual void SetShortCutFilter (ShortCutFilter *_shortCutFilter)=0

PDocument * BelongTo (void)

Returns the Document to wich this editor was added.

Protected Member Functions

void Init (void)

Protected Attributes

PEditorManager * manager

gives you a refference to the PEditorManager to wich this editor was added

PluginManager * pluginManager

gives you a refference to the PluginManager so that you can load your onw plugins

PDocument * doc

gives you a refference to the PDocument to wich this editor is added

Detailed Description

PEditor is the responsibel to render BMessages and to give the User the posibility to edit the value of the individual BMessage.

Author:: Paradoxon powered by Jesus Christ

Version:: 0.01

Date:: 2005/10/04 : mail@projectconceptor.de

Created on: Wed Jun 05 2005

See also:: BMessage

Constructor & Destructor Documentation

PEditor::PEditor ( void )

Member Function Documentation

virtual void PEditor::AttachedToManager ( void ) [pure virtual]

AttachedToManager is called after The Editor was added to a EditorManager at this point you can acces the doc Value.

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

PDocument* PEditor::BelongTo ( void ) [inline]

Returns the Document to wich this editor was added.

See also:: PDocument

virtual void PEditor::DetachedFromManager ( void ) [pure virtual]

DetachedFromManager is called after The Editor was removed from the EditorManager at this point you can acces the doc Value.

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

virtual BMessage* PEditor::GetConfiguration ( void ) [pure virtual]

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

virtual BHandler* PEditor::GetHandler ( void ) [pure virtual]

if the Editor is an View it returns the pointer to the view (this pointer) else it shoud be the pointer to the handler for the Editor (e.g.

a Network Client)

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

virtual BView* PEditor::GetPrintView ( void ) [inline, virtual]

if the View wich should be printet is different than the View return by GetView you shoudl overwrite this Method and return the View wich should be printed.

virtual BView* PEditor::GetView ( void ) [pure virtual]

if the Editor is an View (this mostly shoud be the case) it returns the pointer to his View (this shoud be the this pointer :-))

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

void PEditor::Init ( void ) [protected]

Reimplemented in GraphEditor, NavigatorEditor, and GraphEditor.

PEditorManager* PEditor::Manager ( void ) [inline]

Returns the Manger to wich the PEditor aktually belongs.

See also:: PEditorManager

virtual bool PEditor::NeedLiveFeed ( void ) [inline, virtual]

Implement this Method and return true if you need a liveupdate if something changed even if the Editor is not active.

(at the moment this is ignored and the liveupdate ist sent to) every registered Editor.. but this will change in future

virtual void PEditor::PreprocessAfterLoad ( BMessage * container ) [pure virtual]

this Method can perform Steps wich are necessary befor loading e.g.

converting Messages back into valid Objects and add the Objects as Pointer and remove the ObjectMessage

the Container contains pointer to the all Lists wich are used to store the PDocumentData

Warning:

the BList wich you are pointet in the Message must or aren´t the same like the one you get over the related PDocument Funktion

Comparable PDcoument List	BMessage NameField	Description
PDocument::GetSelected()	"Selected"
PDocument::GetAllNodes()	"AllNodes"
PDocument::GetAllConnections()	"AllConnections"
PDocument::GetChangedNodes	"ChangedNodes" </tabale>

See also:: PreprocessBeforSave()

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

virtual void PEditor::PreprocessBeforSave ( BMessage * container ) [pure virtual]

this Method can perform Steps wich are necessary befor saving e.g.

converting Pointer into Messages wich are added to the NodeMessage so that you can deal with pointer during the work with Nodes but if it saved the Data woundt get lost the Container contains pointer to the all Lists wich are used to store the PDocumentData

Warning:

the BList wich you are pointet in the Message must or aren´t the same like the one you get over the related PDocument Funktion

Comparable PDcoument List	BMessage NameField	Description
PDocument::GetSelected()	"Selected"
PDocument::GetAllNodes()	"AllNodes"
PDocument::GetAllConnections()	"AllConnections"
PDocument::GetChangedNodes	"ChangedNodes" </tabale>

See also:: PreprocessBeforLoad()

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

virtual void PEditor::SetConfiguration ( BMessage * message ) [pure virtual]

Implemented in GraphEditor, NavigatorEditor, and GraphEditor.

void PEditor::SetManager ( PEditorManager * newManager )

set the Manager to wich the PEditor shoud belong to calls also the AttachedToManager Method or DetachedFromManager if the passed Value is NULL

Set the EditorManager this Method ist called if the Editor is added or removed from the EditorManager.

See also:: PEditorManager

virtual void PEditor::SetShortCutFilter ( ShortCutFilter * _shortCutFilter ) [pure virtual]

Implemented in GraphEditor, and NavigatorEditor.

void PEditor::ValueChanged ( void ) [virtual]

this Method isnt called direcly (at the moment) instead a P_C_VALUE_CHANGED Message is send to the by GetHandler returned Handler imlement this that it handle alle changed Nodes wich returned in the doc->GetChangedNodes() and also in doc->GetTrash() all deleted nodes ;-)

Called if a value, wich this editor is, waching was changed.

See also:: GetHandler()

Reimplemented in GraphEditor, NavigatorEditor, and GraphEditor.

Member Data Documentation

PDocument* PEditor::doc [protected]

gives you a refference to the PDocument to wich this editor is added

PEditorManager* PEditor::manager [protected]

gives you a refference to the PEditorManager to wich this editor was added

PluginManager* PEditor::pluginManager [protected]

gives you a refference to the PluginManager so that you can load your onw plugins

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


Public Member Functions
	PEditor (void)
virtual void	AttachedToManager (void)=0
	AttachedToManager is called after The Editor was added to a EditorManager at this point you can acces the doc Value.
virtual void	DetachedFromManager (void)=0
	DetachedFromManager is called after The Editor was removed from the EditorManager at this point you can acces the doc Value.
virtual void	PreprocessBeforSave (BMessage *container)=0
	this Method can perform Steps wich are necessary befor saving e.g.
virtual void	PreprocessAfterLoad (BMessage *container)=0
	this Method can perform Steps wich are necessary befor loading e.g.
virtual BView *	GetView (void)=0
	if the Editor is an View (this mostly shoud be the case) it returns the pointer to his View (this shoud be the this pointer :-))
virtual BView *	GetPrintView (void)
	if the View wich should be printet is different than the View return by GetView you shoudl overwrite this Method and return the View wich should be printed.
virtual BHandler *	GetHandler (void)=0
	if the Editor is an View it returns the pointer to the view (this pointer) else it shoud be the pointer to the handler for the Editor (e.g.
virtual bool	NeedLiveFeed (void)
	Implement this Method and return true if you need a liveupdate if something changed even if the Editor is not active.
virtual void	ValueChanged (void)
	this Method isnt called direcly (at the moment) instead a P_C_VALUE_CHANGED Message is send to the by GetHandler returned Handler imlement this that it handle alle changed Nodes wich returned in the doc->GetChangedNodes() and also in doc->GetTrash() all deleted nodes ;-)
void	SetManager (PEditorManager *newManager)
	set the Manager to wich the PEditor shoud belong to calls also the AttachedToManager Method or DetachedFromManager if the passed Value is NULL
PEditorManager *	Manager (void)
	Returns the Manger to wich the PEditor aktually belongs.
virtual BMessage *	GetConfiguration (void)=0
virtual void	SetConfiguration (BMessage *message)=0
virtual void	SetShortCutFilter (ShortCutFilter *_shortCutFilter)=0
PDocument *	BelongTo (void)
	Returns the Document to wich this editor was added.
Protected Member Functions
void	Init (void)
Protected Attributes
PEditorManager *	manager
	gives you a refference to the PEditorManager to wich this editor was added
PluginManager *	pluginManager
	gives you a refference to the PluginManager so that you can load your onw plugins
PDocument *	doc
	gives you a refference to the PDocument to wich this editor is added