CircuitDocument Class Reference

Circuit view. More...

#include <circuitdocument.h>

Inheritance diagram for CircuitDocument:

[legend]Collaboration diagram for CircuitDocument:

[legend]List of all members.

Public Slots
void	createSubcircuit ()
void	displayEquations ()
void	setOrientation0 ()
void	setOrientation90 ()
void	setOrientation180 ()
void	setOrientation270 ()
void	rotateCounterClockwise ()
void	rotateClockwise ()
void	itemFlip ()
virtual void	slotInitItemActions (Item *item=0)
void	requestAssignCircuits ()
void	componentAdded (Item *item)
void	componentRemoved (Item *item)
void	connectorAdded (Connector *connector)
virtual void	slotUpdateConfiguration ()
Public Member Functions
	CircuitDocument (const QString &caption, KTechlab *ktechlab, const char *name=0)
	~CircuitDocument ()
virtual View *	createView (ViewContainer *viewContainer, uint viewAreaId, const char *name=0)
void	calculateConnectorCurrents ()
int	countExtCon (const ItemList &cnItemList) const
virtual void	update ()
Protected Member Functions
virtual void	itemAdded (Item *item)
virtual void	fillContextMenu (const QPoint &pos)
virtual bool	isValidItem (Item *item)
virtual bool	isValidItem (const QString &itemId)
Protected Attributes
KActionMenu *	m_pOrientationAction

---

Detailed Description

Circuit view.

CircuitDocument handles allocation of the components displayed in the ICNDocument to various Circuits, where the simulation can be performed, and displays the information from those simulations back on the ICNDocument

Author:

David Saxton

Definition at line 64 of file circuitdocument.h.

---

Member Function Documentation

View * CircuitDocument::createView	(	ViewContainer *	viewContainer,
		uint	viewAreaId,
		const char *	name = 0
	)			[virtual]

Create a view that will display the document data. In all reimplemented functions, you must call handleNewView after creating the view, so that the appropriate slots, pointers, etc can all be initialised.

Reimplemented from ICNDocument.

Definition at line 153 of file circuitdocument.cpp.

References ItemDocument::handleNewView().

int CircuitDocument::countExtCon

(

const ItemList &

cnItemList

)

const

Count the number of ExternalConnection components in the CNItemList

Definition at line 696 of file circuitdocument.cpp.

Referenced by createSubcircuit(), and fillContextMenu().

void CircuitDocument::update

(

)

[virtual]

Called from Canvas (when QCanvas::advance is called).

Reimplemented from ItemDocument.

Definition at line 174 of file circuitdocument.cpp.

References ICNDocument::m_nodeList, and ItemDocument::update().

void CircuitDocument::createSubcircuit

(

)

[slot]

Creates a subcircuit from the currently selected components

Definition at line 661 of file circuitdocument.cpp.

References Document::activeView(), ItemDocumentData::addConnectors(), ItemDocumentData::addItems(), ItemDocumentData::addNodes(), Subcircuits::addSubcircuit(), countExtCon(), ICNDocument::getCommonConnectors(), ICNDocument::getCommonNodes(), ItemDocument::itemList(), ItemGroup::items(), ICNDocument::m_selectList, and ItemDocumentData::toXML().

void CircuitDocument::slotInitItemActions

(

Item *

item = 0

)

[virtual, slot]

Enables / disables / selects various actions depending on what is selected or not.

Parameters:

plugContextMenu

If true, then will insert actions into contextmenu

Reimplemented from ItemDocument.

Definition at line 70 of file circuitdocument.cpp.

References View::action(), Document::activeView(), Component::angleDegrees(), Component::canRotate(), CNItemGroup::count(), ItemGroup::itemsAreSameType(), m_pOrientationAction, ICNDocument::m_selectList, ItemDocument::p_ktechlab, and ItemDocument::slotInitItemActions().

void CircuitDocument::connectorAdded

(

Connector *

connector

)

[slot]

Emitted when a Connector is added

Reimplemented from ICNDocument.

Definition at line 246 of file circuitdocument.cpp.

References requestAssignCircuits().

Referenced by CircuitDocument().

void CircuitDocument::slotUpdateConfiguration

(

)

[virtual, slot]

Called when the user changes the configuration. This, for example, will tell the CNItems on the canvas to update their configuration.

Reimplemented from ItemDocument.

Definition at line 160 of file circuitdocument.cpp.

References ICNDocument::m_nodeList, and ItemDocument::slotUpdateConfiguration().

void CircuitDocument::itemAdded

(

Item *

item

)

[protected, virtual]

Called from registerItem when a new item is added.

Reimplemented from ItemDocument.

Definition at line 254 of file circuitdocument.cpp.

References componentAdded(), and ItemDocument::itemAdded().

void CircuitDocument::fillContextMenu

(

const QPoint &

pos

)

[protected, virtual]

Reinherit this if you want to add any options to the right-click context

Reimplemented from ICNDocument.

Definition at line 186 of file circuitdocument.cpp.

References View::action(), ItemGroup::activeItem(), Document::activeView(), Component::canRotate(), CNItemGroup::count(), countExtCon(), ICNDocument::fillContextMenu(), ItemGroup::items(), ItemGroup::itemsAreSameType(), m_pOrientationAction, ICNDocument::m_selectList, ItemDocument::p_ktechlab, and ICNDocument::selectList().

bool CircuitDocument::isValidItem

(

Item *

item

)

[protected, virtual]

Returns true if the CNItem is valid - e.g. will return true for a component in a circuit, but not in a pic program

Implements ICNDocument.

Definition at line 713 of file circuitdocument.cpp.

bool CircuitDocument::isValidItem

(

const QString &

itemId

)

[protected, virtual]

Returns:

Whether or not the item is valid; i.e. is appropriate to the document being edited, and does not have other special restrictions on it (such as only allowing one instance of the Start part in FlowCode).

Implements ICNDocument.

Definition at line 708 of file circuitdocument.cpp.

---

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

• circuitdocument.h
• circuitdocument.cpp

---